Class GetGatewayRateLimitResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.bedrockagentcorecontrol.model.BedrockAgentCoreControlResponse
software.amazon.awssdk.services.bedrockagentcorecontrol.model.GetGatewayRateLimitResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetGatewayRateLimitResponse.Builder,GetGatewayRateLimitResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetGatewayRateLimitResponse extends BedrockAgentCoreControlResponse implements ToCopyableBuilder<GetGatewayRateLimitResponse.Builder,GetGatewayRateLimitResponse>

Shared fields for GatewayRateLimit responses

  • Method Details

    • rateLimitId

      public final String rateLimitId()
      Returns the value of the RateLimitId property for this object.
      Returns:
      The value of the RateLimitId property for this object.

    • gatewayIdentifier

      public final String gatewayIdentifier()

      The unique identifier of the gateway.

      Returns:
      The unique identifier of the gateway.

    • description

      public final String description()

      Optional human-readable description for this limit.

      Returns:
      Optional human-readable description for this limit.

    • hasDimensionKeys

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

    • dimensionKeys

      public final List<String> dimensionKeys()
      Returns the value of the DimensionKeys property for this object.

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

      Returns:
      The value of the DimensionKeys property for this object.

    • hasEntries

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

    • entries

      public final List<LimitEntry> entries()
      Returns the value of the Entries property for this object.

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

      Returns:
      The value of the Entries property for this object.

    • status

      public final GatewayRateLimitStatus status()
      Returns the value of the Status property for this object.

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

      Returns:
      The value of the Status property for this object.
      See Also:

    • statusAsString

      public final String statusAsString()
      Returns the value of the Status property for this object.

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

      Returns:
      The value of the Status property for this object.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the rate limit was created.

      Returns:
      The timestamp when the rate limit was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the rate limit was last updated.

      Returns:
      The timestamp when the rate limit was last updated.

    • toBuilder

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

    • builder

      public static GetGatewayRateLimitResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetGatewayRateLimitResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

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