Class ListUpdatesRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListUpdatesRequest.Builder,ListUpdatesRequest>

@Generated("software.amazon.awssdk:codegen") public final class ListUpdatesRequest extends RtbFabricRequest implements ToCopyableBuilder<ListUpdatesRequest.Builder,ListUpdatesRequest>
  • Method Details

    • gatewayId

      public final String gatewayId()

      The unique identifier of the gateway.

      Returns:
      The unique identifier of the gateway.
    • linkId

      public final String linkId()

      The ID of a link on this gateway, to list only that link's updates. Omit both linkId and ruleId to list the gateway's own updates.

      Returns:
      The ID of a link on this gateway, to list only that link's updates. Omit both linkId and ruleId to list the gateway's own updates.
    • ruleId

      public final String ruleId()

      The ID of a routing rule, to list only that rule's updates. Requires linkId, because you address a rule through its link. A ruleId without linkId fails with ValidationException.

      Returns:
      The ID of a routing rule, to list only that rule's updates. Requires linkId, because you address a rule through its link. A ruleId without linkId fails with ValidationException.
    • type

      public final UpdateType type()

      Lists only updates of this type.

      If the service returns an enum value that is not available in the current SDK version, type will return UpdateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Lists only updates of this type.
      See Also:
    • typeAsString

      public final String typeAsString()

      Lists only updates of this type.

      If the service returns an enum value that is not available in the current SDK version, type will return UpdateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Lists only updates of this type.
      See Also:
    • status

      public final UpdateStatus status()

      Lists only updates in this status.

      If the service returns an enum value that is not available in the current SDK version, status will return UpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Lists only updates in this status.
      See Also:
    • statusAsString

      public final String statusAsString()

      Lists only updates in this status.

      If the service returns an enum value that is not available in the current SDK version, status will return UpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Lists only updates in this status.
      See Also:
    • nextToken

      public final String nextToken()

      If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

      Returns:
      If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
    • maxResults

      public final Integer maxResults()

      The maximum number of results to return for each call.

      Returns:
      The maximum number of results to return for each call.
    • toBuilder

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

      public static ListUpdatesRequest.Builder builder()
    • serializableBuilderClass

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