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>

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<DescribeInstanceSqlHaHistoryStatesRequest.Builder,DescribeInstanceSqlHaHistoryStatesRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.