Class DescribeInstanceEventWindowsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeInstanceEventWindowsRequest.Builder,
DescribeInstanceEventWindowsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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.filters()
One or more filters.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceEventWindowIds property.The IDs of the event windows.final Integer
The maximum number of results to return in a single call.final String
The token to request the next page of results.static Class
<? extends DescribeInstanceEventWindowsRequest.Builder> 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
.
-
hasInstanceEventWindowIds
public final boolean hasInstanceEventWindowIds()For responses, this returns true if the service returned a value for the InstanceEventWindowIds 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. -
instanceEventWindowIds
The IDs of the event windows.
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
hasInstanceEventWindowIds()
method.- Returns:
- The IDs of the event windows.
-
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
One or more filters.
-
dedicated-host-id
- The event windows associated with the specified Dedicated Host ID. -
event-window-name
- The event windows associated with the specified names. -
instance-id
- The event windows associated with the specified instance ID. -
instance-tag
- The event windows associated with the specified tag and value. -
instance-tag-key
- The event windows associated with the specified tag key, regardless of the value. -
instance-tag-value
- The event windows associated with the specified tag value, regardless of the key. -
tag:<key>
- The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueCMX
, specifytag:Owner
for the filter name andCMX
for the filter value. -
tag-key
- The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value. -
tag-value
- The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.
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:
- One or more filters.
-
dedicated-host-id
- The event windows associated with the specified Dedicated Host ID. -
event-window-name
- The event windows associated with the specified names. -
instance-id
- The event windows associated with the specified instance ID. -
instance-tag
- The event windows associated with the specified tag and value. -
instance-tag-key
- The event windows associated with the specified tag key, regardless of the value. -
instance-tag-value
- The event windows associated with the specified tag value, regardless of the key. -
tag:<key>
- The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueCMX
, specifytag:Owner
for the filter name andCMX
for the filter value. -
tag-key
- The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value. -
tag-value
- The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.
-
-
-
maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextToken
value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.- Returns:
- The maximum number of results to return in a single call. To retrieve the remaining results, make another
call with the returned
NextToken
value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.
-
nextToken
The token to request the next page of results.
- Returns:
- The token to request the next page of results.
-
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<DescribeInstanceEventWindowsRequest.Builder,
DescribeInstanceEventWindowsRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DescribeInstanceEventWindowsRequest.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
-