Class ListServiceStatesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.applicationsignals.model.ApplicationSignalsRequest
software.amazon.awssdk.services.applicationsignals.model.ListServiceStatesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListServiceStatesRequest.Builder,ListServiceStatesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListServiceStatesRequest extends ApplicationSignalsRequest implements ToCopyableBuilder<ListServiceStatesRequest.Builder,ListServiceStatesRequest>

  • Method Details

    • startTime

      public final Instant startTime()

      The start of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.

      Returns:
      The start of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.

    • endTime

      public final Instant endTime()

      The end of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.

      Returns:
      The end of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, 1698778057.

    • maxResults

      public final Integer maxResults()

      The maximum number of service states to return in one operation. If you omit this parameter, the default of 20 is used.

      Returns:
      The maximum number of service states to return in one operation. If you omit this parameter, the default of 20 is used.

    • nextToken

      public final String nextToken()

      Include this value, if it was returned by the previous operation, to get the next set of service states.

      Returns:
      Include this value, if it was returned by the previous operation, to get the next set of service states.

    • includeLinkedAccounts

      public final Boolean includeLinkedAccounts()

      If you are using this operation in a monitoring account, specify true to include service states from source accounts in the returned data.

      Returns:
      If you are using this operation in a monitoring account, specify true to include service states from source accounts in the returned data.

    • awsAccountId

      public final String awsAccountId()

      The Amazon Web Services account ID to filter service states by. Use this to limit results to services from a specific account.

      Returns:
      The Amazon Web Services account ID to filter service states by. Use this to limit results to services from a specific account.

    • hasAttributeFilters

      public final boolean hasAttributeFilters()
      For responses, this returns true if the service returned a value for the AttributeFilters 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.

    • attributeFilters

      public final List<AttributeFilter> attributeFilters()

      A list of attribute filters to narrow down the services. You can filter by platform, environment, or other service attributes.

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

      Returns:
      A list of attribute filters to narrow down the services. You can filter by platform, environment, or other service attributes.

    • toBuilder

      public ListServiceStatesRequest.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<ListServiceStatesRequest.Builder,ListServiceStatesRequest>
      Specified by:
      toBuilder in class ApplicationSignalsRequest
      Returns:
      a builder for type T

    • builder

      public static ListServiceStatesRequest.Builder builder()

    • serializableBuilderClass

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