Class GuardrailSummary

java.lang.Object
software.amazon.awssdk.services.bedrock.model.GuardrailSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GuardrailSummary.Builder,GuardrailSummary>
@Generated("software.amazon.awssdk:codegen") public final class GuardrailSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GuardrailSummary.Builder,GuardrailSummary>

Contains details about a guardrail.

This data type is used in the following API operations:

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the guardrail.

      Returns:
      The unique identifier of the guardrail.

    • arn

      public final String arn()

      The ARN of the guardrail.

      Returns:
      The ARN of the guardrail.

    • status

      public final GuardrailStatus status()

      The status of the guardrail.

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

      Returns:
      The status of the guardrail.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the guardrail.

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

      Returns:
      The status of the guardrail.
      See Also:

    • name

      public final String name()

      The name of the guardrail.

      Returns:
      The name of the guardrail.

    • description

      public final String description()

      A description of the guardrail.

      Returns:
      A description of the guardrail.

    • version

      public final String version()

      The version of the guardrail.

      Returns:
      The version of the guardrail.

    • createdAt

      public final Instant createdAt()

      The date and time at which the guardrail was created.

      Returns:
      The date and time at which the guardrail was created.

    • updatedAt

      public final Instant updatedAt()

      The date and time at which the guardrail was last updated.

      Returns:
      The date and time at which the guardrail was last updated.

    • crossRegionDetails

      public final GuardrailCrossRegionDetails crossRegionDetails()

      Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

      Returns:
      Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

    • toBuilder

      public GuardrailSummary.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<GuardrailSummary.Builder,GuardrailSummary>
      Returns:
      a builder for type T

    • builder

      public static GuardrailSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.