Class CreateGatewayRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateGatewayRequest.Builder,CreateGatewayRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AuthorizerConfigurationThe authorizer configuration for the gateway.final AuthorizerTypeThe type of authorizer to use for the gateway.final StringThe type of authorizer to use for the gateway.static CreateGatewayRequest.Builderbuilder()final StringA unique, case-sensitive identifier to ensure that the API request completes no more than one time.final StringThe description of 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 <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 booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final StringThe Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.final Stringname()The name of the gateway.The configuration settings for the protocol specified in theprotocolTypeparameter.final GatewayProtocolTypeThe protocol type for the gateway.final StringThe protocol type for the gateway.final StringroleArn()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 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
-
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 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
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,
protocolTypewill 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,
protocolTypewill 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
protocolTypeparameter.- Returns:
- The configuration settings for the protocol specified in the
protocolTypeparameter.
-
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,
authorizerTypewill 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.
-
CUSTOM_JWT- Authorize with a bearer token. -
AWS_IAM- Authorize with your Amazon Web Services IAM credentials.
-
- See Also:
-
-
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,
authorizerTypewill 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.
-
CUSTOM_JWT- Authorize with a bearer token. -
AWS_IAM- Authorize with your Amazon Web Services IAM credentials.
-
- See Also:
-
-
authorizerConfiguration
The authorizer configuration for the gateway. Required if
authorizerTypeisCUSTOM_JWT.- Returns:
- The authorizer configuration for the gateway. Required if
authorizerTypeisCUSTOM_JWT.
-
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,
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:
-
-
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:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateGatewayRequest.Builder,CreateGatewayRequest> - 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.
-