Package software.amazon.awssdk.services.ec2.model

Class DescribeInstanceEventWindowsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeInstanceEventWindowsRequest.Builder,DescribeInstanceEventWindowsRequest>

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

Describe instance event windows by InstanceEventWindow.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeInstanceEventWindowsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeInstanceEventWindowsRequest.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()	One or more filters.
<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()
boolean	hasInstanceEventWindowIds()	For responses, this returns true if the service returned a value for the InstanceEventWindowIds property.
List<String>	instanceEventWindowIds()	The IDs of the event windows.
Integer	maxResults()	The maximum number of results to return in a single call.
String	nextToken()	The token to request the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeInstanceEventWindowsRequest.Builder>	serializableBuilderClass()
DescribeInstanceEventWindowsRequest.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.

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

instanceEventWindowIds

public final List<String> 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 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.

filters

public final List<Filter> 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 key Owner and the value CMX, specify tag:Owner for the filter name and CMX 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 key Owner and the value CMX, specify tag:Owner for the filter name and CMX 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

public final Integer 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

public final String nextToken()

The token to request the next page of results.

Returns:

The token to request the next page of results.

toBuilder

public DescribeInstanceEventWindowsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeInstanceEventWindowsRequest.Builder,DescribeInstanceEventWindowsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeInstanceEventWindowsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeInstanceEventWindowsRequest.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