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

Class DescribeInstanceSqlHaHistoryStatesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeInstanceSqlHaHistoryStatesRequest.Builder,DescribeInstanceSqlHaHistoryStatesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeInstanceSqlHaHistoryStatesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeInstanceSqlHaHistoryStatesRequest.Builder	builder()
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
Instant	endTime()	The end data and time of the period for which to get historical SQL Server High Availability states.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	One or more filters to apply to the results.
<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	hasInstanceIds()	For responses, this returns true if the service returned a value for the InstanceIds property.
List<String>	instanceIds()	The IDs of the SQL Server High Availability instances to describe.
Integer	maxResults()	The maximum number of results to return for the request in a single page.
String	nextToken()	The token to use to retrieve the next page of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeInstanceSqlHaHistoryStatesRequest.Builder>	serializableBuilderClass()
Instant	startTime()	The start data and time of the period for which to get the historical SQL Server High Availability states.
DescribeInstanceSqlHaHistoryStatesRequest.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

hasInstanceIds

public final boolean hasInstanceIds()

For responses, this returns true if the service returned a value for the InstanceIds 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.

instanceIds

public final List<String> instanceIds()

The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns historical states for all SQL Server High Availability instances.

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 hasInstanceIds() method.

Returns:

The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns historical states for all SQL Server High Availability instances.

startTime

public final Instant startTime()

The start data and time of the period for which to get the historical SQL Server High Availability states. If omitted, the API returns all available historical states.

Timezone: UTC

Format: YYYY-MM-DDThh:mm:ss.sssZ

Returns:

The start data and time of the period for which to get the historical SQL Server High Availability states. If omitted, the API returns all available historical states.

Timezone: UTC

Format: YYYY-MM-DDThh:mm:ss.sssZ

endTime

public final Instant endTime()

The end data and time of the period for which to get historical SQL Server High Availability states. If omitted, the API returns historical states up to the current date and time.

Timezone: UTC

Format: YYYY-MM-DDThh:mm:ss.sssZ

Returns:

The end data and time of the period for which to get historical SQL Server High Availability states. If omitted, the API returns historical states up to the current date and time.

Timezone: UTC

Format: YYYY-MM-DDThh:mm:ss.sssZ

nextToken

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

public final Integer maxResults()

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

Returns:

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

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 to apply to the results. Supported filters include:

• tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The tag key assigned to the instance.

• haStatus - The SQL Server High Availability status of the SQL Server High Availability instance ( processing | active | standby | invalid).

• sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

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 to apply to the results. Supported filters include:

• tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The tag key assigned to the instance.

• haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid).

• sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

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.

toBuilder

public DescribeInstanceSqlHaHistoryStatesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeInstanceSqlHaHistoryStatesRequest.Builder,DescribeInstanceSqlHaHistoryStatesRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeInstanceSqlHaHistoryStatesRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo