Class CreateInstanceEventWindowRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateInstanceEventWindowRequest.Builder,
CreateInstanceEventWindowRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The cron expression for the event window, for example,* 0-4,20-23 * * 1,5
.final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final boolean
final boolean
equalsBySdkFields
(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 int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TagSpecifications property.final boolean
For responses, this returns true if the service returned a value for the TimeRanges property.final String
name()
The name of the event window.static Class
<? extends CreateInstanceEventWindowRequest.Builder> final List
<TagSpecification> The tags to apply to the event window.The time range for the event window.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods 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
.
-
name
The name of the event window.
- Returns:
- The name of the event window.
-
hasTimeRanges
public final boolean hasTimeRanges()For responses, this returns true if the service returned a value for the TimeRanges 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. -
timeRanges
The time range for the event window. If you specify a time range, you can't specify a cron expression.
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
hasTimeRanges()
method.- Returns:
- The time range for the event window. If you specify a time range, you can't specify a cron expression.
-
cronExpression
The cron expression for the event window, for example,
* 0-4,20-23 * * 1,5
. If you specify a cron expression, you can't specify a time range.Constraints:
-
Only hour and day of the week values are supported.
-
For day of the week values, you can specify either integers
0
through6
, or alternative single valuesSUN
throughSAT
. -
The minute, month, and year must be specified by
*
. -
The hour value must be one or a multiple range, for example,
0-4
or0-4,20-23
. -
Each hour range must be >= 2 hours, for example,
0-2
or20-23
. -
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
- Returns:
- The cron expression for the event window, for example,
* 0-4,20-23 * * 1,5
. If you specify a cron expression, you can't specify a time range.Constraints:
-
Only hour and day of the week values are supported.
-
For day of the week values, you can specify either integers
0
through6
, or alternative single valuesSUN
throughSAT
. -
The minute, month, and year must be specified by
*
. -
The hour value must be one or a multiple range, for example,
0-4
or0-4,20-23
. -
Each hour range must be >= 2 hours, for example,
0-2
or20-23
. -
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
-
-
-
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 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. -
tagSpecifications
The tags to apply to the event window.
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 event window.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateInstanceEventWindowRequest.Builder,
CreateInstanceEventWindowRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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
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
Description copied from class:SdkRequest
Used 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:
getValueForField
in 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
-