Class UpdateGatewayRequest

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

  • Method Details

    • gatewayIdentifier

      public final String gatewayIdentifier()

      The identifier of the gateway to update.

      Returns:
      The identifier of the gateway to update.

    • name

      public final String name()

      The name of the gateway. This name must be the same as the one when the gateway was created.

      Returns:
      The name of the gateway. This name must be the same as the one when the gateway was created.

    • description

      public final String description()

      The updated description for the gateway.

      Returns:
      The updated description for the gateway.

    • roleArn

      public final String roleArn()

      The updated IAM role ARN that provides permissions for the gateway.

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

    • protocolType

      public final GatewayProtocolType protocolType()

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

    • protocolTypeAsString

      public final String protocolTypeAsString()

      The updated 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 updated protocol type for the 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()

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

    • authorizerTypeAsString

      public final String authorizerTypeAsString()

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

    • authorizerConfiguration

      public final AuthorizerConfiguration authorizerConfiguration()

      The updated authorizer configuration for the gateway.

      Returns:
      The updated authorizer configuration for the gateway.

    • kmsKeyArn

      public final String kmsKeyArn()

      The updated ARN of the KMS key used to encrypt the gateway.

      Returns:
      The updated ARN of the KMS key used to encrypt 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:

    • toBuilder

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

    • builder

      public static UpdateGatewayRequest.Builder builder()

    • serializableBuilderClass

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