Class GetGatewayRuleResponse

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.GetGatewayRuleResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetGatewayRuleResponse.Builder,GetGatewayRuleResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetGatewayRuleResponse extends BedrockAgentCoreControlResponse implements ToCopyableBuilder<GetGatewayRuleResponse.Builder,GetGatewayRuleResponse>

Create response excludes updatedAt (redundant on create). Get/Update responses include it via their own output structures.

  • Method Details

    • ruleId

      public final String ruleId()

      The unique identifier of the gateway rule.

      Returns:
      The unique identifier of the gateway rule.

    • gatewayArn

      public final String gatewayArn()

      The Amazon Resource Name (ARN) of the gateway that the rule belongs to.

      Returns:
      The Amazon Resource Name (ARN) of the gateway that the rule belongs to.

    • priority

      public final Integer priority()

      The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.

      Returns:
      The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first.

    • hasConditions

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

    • conditions

      public final List<Condition> conditions()

      The conditions that must be met for the rule to apply.

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

      Returns:
      The conditions that must be met for the rule to apply.

    • hasActions

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

    • actions

      public final List<Action> actions()

      The actions to take when the rule conditions are met.

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

      Returns:
      The actions to take when the rule conditions are met.

    • description

      public final String description()

      The description of the gateway rule.

      Returns:
      The description of the gateway rule.

    • createdAt

      public final Instant createdAt()

      The timestamp when the rule was created.

      Returns:
      The timestamp when the rule was created.

    • status

      public final GatewayRuleStatus status()

      The current status of the rule.

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

      Returns:
      The current status of the rule.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the rule.

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

      Returns:
      The current status of the rule.
      See Also:

    • system

      public final SystemManagedBlock system()

      System-managed metadata for rules created by automated processes.

      Returns:
      System-managed metadata for rules created by automated processes.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the rule was last updated.

      Returns:
      The timestamp when the rule was last updated.

    • toBuilder

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

    • builder

      public static GetGatewayRuleResponse.Builder builder()

    • serializableBuilderClass

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