Class GatewaySummary

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

Contains summary information about a gateway.

See Also:

  • Method Details

    • gatewayId

      public final String gatewayId()

      The unique identifier of the gateway.

      Returns:
      The unique identifier of the gateway.

    • name

      public final String name()

      The name of the gateway.

      Returns:
      The name of the gateway.

    • status

      public final GatewayStatus status()

      The current status of the gateway.

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

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

    • statusAsString

      public final String statusAsString()

      The current status of the gateway.

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

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

    • description

      public final String description()

      The description of the gateway.

      Returns:
      The description of the gateway.

    • createdAt

      public final Instant createdAt()

      The timestamp when the gateway was created.

      Returns:
      The timestamp when the gateway was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the gateway was last updated.

      Returns:
      The timestamp when the gateway was last updated.

    • authorizerType

      public final AuthorizerType authorizerType()

      The type of authorizer used by the gateway.

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

      Returns:
      The type of authorizer used by the gateway.
      See Also:

    • authorizerTypeAsString

      public final String authorizerTypeAsString()

      The type of authorizer used by the gateway.

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

      Returns:
      The type of authorizer used by the gateway.
      See Also:

    • protocolType

      public final GatewayProtocolType protocolType()

      The protocol type used by the gateway.

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

      Returns:
      The protocol type used by the gateway.
      See Also:

    • protocolTypeAsString

      public final String protocolTypeAsString()

      The protocol type used by the gateway.

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

      Returns:
      The protocol type used by the gateway.
      See Also:

    • toBuilder

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

    • builder

      public static GatewaySummary.Builder builder()

    • serializableBuilderClass

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