Class CreateGatewayRequest

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

  • Method Details

    • name

      public final String name()

      The name of the gateway. The name must be unique within your account.

      Returns:
      The name of the gateway. The name must be unique within your account.

    • description

      public final String description()

      The description of the gateway.

      Returns:
      The description of the gateway.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

      Returns:
      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.

    • protocolType

      public final GatewayProtocolType protocolType()

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

    • protocolTypeAsString

      public final String protocolTypeAsString()

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

    • protocolConfiguration

      public final GatewayProtocolConfiguration protocolConfiguration()

      The configuration settings for the protocol specified in the protocolType parameter.

      Returns:
      The configuration settings for the protocol specified in the protocolType parameter.

    • authorizerType

      public final AuthorizerType authorizerType()

      The type of authorizer to use for the gateway.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

      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 to use for the gateway.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

      See Also:

    • authorizerTypeAsString

      public final String authorizerTypeAsString()

      The type of authorizer to use for the gateway.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

      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 to use for the gateway.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

      See Also:

    • authorizerConfiguration

      public final AuthorizerConfiguration authorizerConfiguration()

      The authorizer configuration for the gateway. Required if authorizerType is CUSTOM_JWT.

      Returns:
      The authorizer configuration for the gateway. Required if authorizerType is CUSTOM_JWT.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.

    • exceptionLevel

      public final ExceptionLevel exceptionLevel()

      The level of detail in error messages returned when invoking the gateway.

      • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

      • If the value is omitted, a generic error message is returned to the end user.

      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 level of detail in error messages returned when invoking the gateway.

      • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

      • If the value is omitted, a generic error message is returned to the end user.

      See Also:

    • exceptionLevelAsString

      public final String exceptionLevelAsString()

      The level of detail in error messages returned when invoking the gateway.

      • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

      • If the value is omitted, a generic error message is returned to the end user.

      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 level of detail in error messages returned when invoking the gateway.

      • If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

      • If the value is omitted, a generic error message is returned to the end user.

      See Also:

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      A map of key-value pairs to associate with the gateway as metadata tags.

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

      Returns:
      A map of key-value pairs to associate with the gateway as metadata tags.

    • toBuilder

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

    • builder

      public static CreateGatewayRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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