Class GetGatewayResponse

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

  • Method Details

    • gatewayArn

      public final String gatewayArn()

      The Amazon Resource Name (ARN) of the Gateway.

      Returns:
      The Amazon Resource Name (ARN) of the Gateway.

    • gatewayId

      public final String gatewayId()

      The unique identifier of the Gateway.

      Returns:
      The unique identifier of the Gateway.

    • gatewayUrl

      public final String gatewayUrl()

      An endpoint for invoking Gateway.

      Returns:
      An endpoint for invoking 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.

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

    • hasStatusReasons

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

    • statusReasons

      public final List<String> statusReasons()

      The reasons for the current status of the Gateway.

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

      Returns:
      The reasons for the current status of the Gateway.

    • name

      public final String name()

      The name of the Gateway.

      Returns:
      The name of the Gateway.

    • description

      public final String description()

      The description of the Gateway.

      Returns:
      The description of the Gateway.

    • roleArn

      public final String roleArn()

      The IAM role ARN that provides permissions for the Gateway.

      Returns:
      The IAM role ARN that provides permissions for the Gateway.

    • protocolType

      public final GatewayProtocolType protocolType()

      Protocol applied to a 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:
      Protocol applied to a Gateway.
      See Also:

    • protocolTypeAsString

      public final String protocolTypeAsString()

      Protocol applied to a 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:
      Protocol applied to a Gateway.
      See Also:

    • protocolConfiguration

      public final GatewayProtocolConfiguration protocolConfiguration()
      Returns the value of the ProtocolConfiguration property for this object.
      Returns:
      The value of the ProtocolConfiguration property for this object.

    • authorizerType

      public final AuthorizerType authorizerType()

      Authorizer type for 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:
      Authorizer type for the gateway.
      See Also:

    • authorizerTypeAsString

      public final String authorizerTypeAsString()

      Authorizer type for 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:
      Authorizer type for the gateway.
      See Also:

    • authorizerConfiguration

      public final AuthorizerConfiguration authorizerConfiguration()

      The authorizer configuration for the Gateway.

      Returns:
      The authorizer configuration for the Gateway.

    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN of the KMS key used to encrypt the Gateway.

      Returns:
      The ARN of the KMS key used to encrypt the Gateway.

    • workloadIdentityDetails

      public final WorkloadIdentityDetails workloadIdentityDetails()

      The workload identity details for the Gateway.

      Returns:
      The workload identity details for the Gateway.

    • exceptionLevel

      public final ExceptionLevel exceptionLevel()

      The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

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

      Returns:
      The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.
      See Also:

    • exceptionLevelAsString

      public final String exceptionLevelAsString()

      The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

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

      Returns:
      The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.
      See Also:

    • toBuilder

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

    • builder

      public static GetGatewayResponse.Builder builder()

    • serializableBuilderClass

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