Class UpdateGatewayRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateGatewayRequest.Builder,UpdateGatewayRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AuthorizerConfigurationThe updated authorizer configuration for the gateway.final AuthorizerTypeThe updated authorizer type for the gateway.final StringThe updated authorizer type for the gateway.static UpdateGatewayRequest.Builderbuilder()final StringThe updated description for the gateway.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExceptionLevelThe level of detail in error messages returned when invoking the gateway.final StringThe level of detail in error messages returned when invoking the gateway.final StringThe identifier of the gateway to update.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final StringThe updated ARN of the KMS key used to encrypt the gateway.final Stringname()The name of the gateway.Returns the value of the ProtocolConfiguration property for this object.final GatewayProtocolTypeThe updated protocol type for the gateway.final StringThe updated protocol type for the gateway.final StringroleArn()The updated IAM role ARN that provides permissions for the gateway.static Class<? extends UpdateGatewayRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
gatewayIdentifier
The identifier of the gateway to update.
- Returns:
- The identifier of the gateway to update.
-
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
The updated description for the gateway.
- Returns:
- The updated description for the gateway.
-
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
The updated protocol type for the gateway.
If the service returns an enum value that is not available in the current SDK version,
protocolTypewill returnGatewayProtocolType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprotocolTypeAsString().- Returns:
- The updated protocol type for the gateway.
- See Also:
-
protocolTypeAsString
The updated protocol type for the gateway.
If the service returns an enum value that is not available in the current SDK version,
protocolTypewill returnGatewayProtocolType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprotocolTypeAsString().- Returns:
- The updated protocol type for the gateway.
- See Also:
-
protocolConfiguration
Returns the value of the ProtocolConfiguration property for this object.- Returns:
- The value of the ProtocolConfiguration property for this object.
-
authorizerType
The updated authorizer type for the gateway.
If the service returns an enum value that is not available in the current SDK version,
authorizerTypewill returnAuthorizerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthorizerTypeAsString().- Returns:
- The updated authorizer type for the gateway.
- See Also:
-
authorizerTypeAsString
The updated authorizer type for the gateway.
If the service returns an enum value that is not available in the current SDK version,
authorizerTypewill returnAuthorizerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthorizerTypeAsString().- Returns:
- The updated authorizer type for the gateway.
- See Also:
-
authorizerConfiguration
The updated authorizer configuration for the gateway.
- Returns:
- The updated authorizer configuration for the gateway.
-
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
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,
exceptionLevelwill returnExceptionLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromexceptionLevelAsString().- 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
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,
exceptionLevelwill returnExceptionLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromexceptionLevelAsString().- 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
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateGatewayRequest.Builder,UpdateGatewayRequest> - Specified by:
toBuilderin classBedrockAgentCoreControlRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-