Class CreateGatewayRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateGatewayRequest.Builder,
CreateGatewayRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AuthorizerConfiguration
The authorizer configuration for the gateway.final AuthorizerType
The type of authorizer to use for the gateway.final String
The type of authorizer to use for the gateway.static CreateGatewayRequest.Builder
builder()
final String
A unique, case-sensitive identifier to ensure that the API request completes no more than one time.final String
The description of the gateway.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExceptionLevel
The level of detail in error messages returned when invoking the gateway.final String
The level of detail in error messages returned when invoking the gateway.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.final String
name()
The name of the gateway.The configuration settings for the protocol specified in theprotocolType
parameter.final GatewayProtocolType
The protocol type for the gateway.final String
The protocol type for the gateway.final String
roleArn()
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.static Class
<? extends CreateGatewayRequest.Builder> tags()
A map of key-value pairs to associate with the gateway as metadata tags.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The description of the gateway.
- Returns:
- The description of the gateway.
-
clientToken
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not 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 this token matches a previous request, the service ignores the request, but does not return an error. For more information, see Ensuring idempotency.
-
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
The protocol type for the gateway.
If the service returns an enum value that is not available in the current SDK version,
protocolType
will returnGatewayProtocolType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolTypeAsString()
.- Returns:
- The protocol type for the gateway.
- See Also:
-
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 returnGatewayProtocolType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolTypeAsString()
.- Returns:
- The protocol type for the gateway.
- See Also:
-
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
The type of authorizer to use for the gateway.
If the service returns an enum value that is not available in the current SDK version,
authorizerType
will returnAuthorizerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthorizerTypeAsString()
.- Returns:
- The type of authorizer to use for the gateway.
- See Also:
-
authorizerTypeAsString
The type of authorizer to use for the gateway.
If the service returns an enum value that is not available in the current SDK version,
authorizerType
will returnAuthorizerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthorizerTypeAsString()
.- Returns:
- The type of authorizer to use for the gateway.
- See Also:
-
authorizerConfiguration
The authorizer configuration for the gateway.
- Returns:
- The authorizer configuration for the gateway.
-
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
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 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,
exceptionLevel
will 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:
-
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<CreateGatewayRequest.Builder,
CreateGatewayRequest> - Specified by:
toBuilder
in classBedrockAgentCoreControlRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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:SdkRequest
Used 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:
getValueForField
in 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:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-