Interface CreateGatewayTargetRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentCoreControlRequest.Builder, Buildable, CopyableBuilder<CreateGatewayTargetRequest.Builder,CreateGatewayTargetRequest>, SdkBuilder<CreateGatewayTargetRequest.Builder,CreateGatewayTargetRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateGatewayTargetRequest

@Mutable
@NotThreadSafe
public static interface CreateGatewayTargetRequest.Builder
extends BedrockAgentCoreControlRequest.Builder, SdkPojo, CopyableBuilder<CreateGatewayTargetRequest.Builder,CreateGatewayTargetRequest>

Method Summary

Modifier and Type	Method	Description
CreateGatewayTargetRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
CreateGatewayTargetRequest.Builder	credentialProviderConfigurations(Collection<CredentialProviderConfiguration> credentialProviderConfigurations)	The credential provider configurations for the target.
CreateGatewayTargetRequest.Builder	credentialProviderConfigurations(Consumer<CredentialProviderConfiguration.Builder>... credentialProviderConfigurations)	The credential provider configurations for the target.
CreateGatewayTargetRequest.Builder	credentialProviderConfigurations(CredentialProviderConfiguration... credentialProviderConfigurations)	The credential provider configurations for the target.
CreateGatewayTargetRequest.Builder	description(String description)	The description of the gateway target.
CreateGatewayTargetRequest.Builder	gatewayIdentifier(String gatewayIdentifier)	The identifier of the gateway to create a target for.
default CreateGatewayTargetRequest.Builder	metadataConfiguration(Consumer<MetadataConfiguration.Builder> metadataConfiguration)	Optional configuration for HTTP header and query parameter propagation to and from the gateway target.
CreateGatewayTargetRequest.Builder	metadataConfiguration(MetadataConfiguration metadataConfiguration)	Optional configuration for HTTP header and query parameter propagation to and from the gateway target.
CreateGatewayTargetRequest.Builder	name(String name)	The name of the gateway target.
CreateGatewayTargetRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateGatewayTargetRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateGatewayTargetRequest.Builder	targetConfiguration(Consumer<TargetConfiguration.Builder> targetConfiguration)	The configuration settings for the target, including endpoint information and schema definitions.
CreateGatewayTargetRequest.Builder	targetConfiguration(TargetConfiguration targetConfiguration)	The configuration settings for the target, including endpoint information and schema definitions.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentcorecontrol.model.BedrockAgentCoreControlRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

gatewayIdentifier

CreateGatewayTargetRequest.Builder gatewayIdentifier(String gatewayIdentifier)

The identifier of the gateway to create a target for.

Parameters:

gatewayIdentifier - The identifier of the gateway to create a target for.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CreateGatewayTargetRequest.Builder name(String name)

The name of the gateway target. The name must be unique within the gateway.

Parameters:

name - The name of the gateway target. The name must be unique within the gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateGatewayTargetRequest.Builder description(String description)

The description of the gateway target.

Parameters:

description - The description of the gateway target.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

CreateGatewayTargetRequest.Builder clientToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

targetConfiguration

CreateGatewayTargetRequest.Builder targetConfiguration(TargetConfiguration targetConfiguration)

The configuration settings for the target, including endpoint information and schema definitions.

Parameters:

targetConfiguration - The configuration settings for the target, including endpoint information and schema definitions.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetConfiguration

default CreateGatewayTargetRequest.Builder targetConfiguration(Consumer<TargetConfiguration.Builder> targetConfiguration)

The configuration settings for the target, including endpoint information and schema definitions.

This is a convenience method that creates an instance of the TargetConfiguration.Builder avoiding the need to create one manually via TargetConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetConfiguration(TargetConfiguration).

Parameters:

targetConfiguration - a consumer that will call methods on TargetConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• targetConfiguration(TargetConfiguration)

credentialProviderConfigurations

CreateGatewayTargetRequest.Builder credentialProviderConfigurations(Collection<CredentialProviderConfiguration> credentialProviderConfigurations)

The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.

Parameters:

credentialProviderConfigurations - The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

credentialProviderConfigurations

CreateGatewayTargetRequest.Builder credentialProviderConfigurations(CredentialProviderConfiguration... credentialProviderConfigurations)

The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.

Parameters:

credentialProviderConfigurations - The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

credentialProviderConfigurations

CreateGatewayTargetRequest.Builder credentialProviderConfigurations(Consumer<CredentialProviderConfiguration.Builder>... credentialProviderConfigurations)

The credential provider configurations for the target. These configurations specify how the gateway authenticates with the target endpoint.

This is a convenience method that creates an instance of the CredentialProviderConfiguration.Builder avoiding the need to create one manually via CredentialProviderConfiguration.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to credentialProviderConfigurations(List<CredentialProviderConfiguration>).

Parameters:

credentialProviderConfigurations - a consumer that will call methods on CredentialProviderConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• credentialProviderConfigurations(java.util.Collection<CredentialProviderConfiguration>)

metadataConfiguration

CreateGatewayTargetRequest.Builder metadataConfiguration(MetadataConfiguration metadataConfiguration)

Optional configuration for HTTP header and query parameter propagation to and from the gateway target.

Parameters:

metadataConfiguration - Optional configuration for HTTP header and query parameter propagation to and from the gateway target.

Returns:

Returns a reference to this object so that method calls can be chained together.

metadataConfiguration

default CreateGatewayTargetRequest.Builder metadataConfiguration(Consumer<MetadataConfiguration.Builder> metadataConfiguration)

Optional configuration for HTTP header and query parameter propagation to and from the gateway target.

This is a convenience method that creates an instance of the MetadataConfiguration.Builder avoiding the need to create one manually via MetadataConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metadataConfiguration(MetadataConfiguration).

Parameters:

metadataConfiguration - a consumer that will call methods on MetadataConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• metadataConfiguration(MetadataConfiguration)

overrideConfiguration

CreateGatewayTargetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateGatewayTargetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.