Interface GetGatewayResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BedrockAgentCoreControlResponse.Builder, Buildable, CopyableBuilder<GetGatewayResponse.Builder,GetGatewayResponse>, SdkBuilder<GetGatewayResponse.Builder,GetGatewayResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetGatewayResponse

@Mutable
@NotThreadSafe
public static interface GetGatewayResponse.Builder
extends BedrockAgentCoreControlResponse.Builder, SdkPojo, CopyableBuilder<GetGatewayResponse.Builder,GetGatewayResponse>

Method Summary

Modifier and Type	Method	Description
default GetGatewayResponse.Builder	authorizerConfiguration(Consumer<AuthorizerConfiguration.Builder> authorizerConfiguration)	The authorizer configuration for the Gateway.
GetGatewayResponse.Builder	authorizerConfiguration(AuthorizerConfiguration authorizerConfiguration)	The authorizer configuration for the Gateway.
GetGatewayResponse.Builder	authorizerType(String authorizerType)	Authorizer type for the gateway.
GetGatewayResponse.Builder	authorizerType(AuthorizerType authorizerType)	Authorizer type for the gateway.
GetGatewayResponse.Builder	createdAt(Instant createdAt)	The timestamp when the Gateway was created.
GetGatewayResponse.Builder	description(String description)	The description of the Gateway.
GetGatewayResponse.Builder	exceptionLevel(String exceptionLevel)	The verbosity of exception messages.
GetGatewayResponse.Builder	exceptionLevel(ExceptionLevel exceptionLevel)	The verbosity of exception messages.
GetGatewayResponse.Builder	gatewayArn(String gatewayArn)	The Amazon Resource Name (ARN) of the Gateway.
GetGatewayResponse.Builder	gatewayId(String gatewayId)	The unique identifier of the Gateway.
GetGatewayResponse.Builder	gatewayUrl(String gatewayUrl)	An endpoint for invoking Gateway.
GetGatewayResponse.Builder	kmsKeyArn(String kmsKeyArn)	The ARN of the KMS key used to encrypt the Gateway.
GetGatewayResponse.Builder	name(String name)	The name of the Gateway.
default GetGatewayResponse.Builder	protocolConfiguration(Consumer<GatewayProtocolConfiguration.Builder> protocolConfiguration)	Sets the value of the ProtocolConfiguration property for this object.
GetGatewayResponse.Builder	protocolConfiguration(GatewayProtocolConfiguration protocolConfiguration)	Sets the value of the ProtocolConfiguration property for this object.
GetGatewayResponse.Builder	protocolType(String protocolType)	Protocol applied to a Gateway.
GetGatewayResponse.Builder	protocolType(GatewayProtocolType protocolType)	Protocol applied to a Gateway.
GetGatewayResponse.Builder	roleArn(String roleArn)	The IAM role ARN that provides permissions for the Gateway.
GetGatewayResponse.Builder	status(String status)	The current status of the Gateway.
GetGatewayResponse.Builder	status(GatewayStatus status)	The current status of the Gateway.
GetGatewayResponse.Builder	statusReasons(String... statusReasons)	The reasons for the current status of the Gateway.
GetGatewayResponse.Builder	statusReasons(Collection<String> statusReasons)	The reasons for the current status of the Gateway.
GetGatewayResponse.Builder	updatedAt(Instant updatedAt)	The timestamp when the Gateway was last updated.
default GetGatewayResponse.Builder	workloadIdentityDetails(Consumer<WorkloadIdentityDetails.Builder> workloadIdentityDetails)	The workload identity details for the Gateway.
GetGatewayResponse.Builder	workloadIdentityDetails(WorkloadIdentityDetails workloadIdentityDetails)	The workload identity details for the Gateway.

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

build, responseMetadata, responseMetadata

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

gatewayArn

GetGatewayResponse.Builder gatewayArn(String gatewayArn)

The Amazon Resource Name (ARN) of the Gateway.

Parameters:

gatewayArn - The Amazon Resource Name (ARN) of the Gateway.

Returns:

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

gatewayId

GetGatewayResponse.Builder gatewayId(String gatewayId)

The unique identifier of the Gateway.

Parameters:

gatewayId - The unique identifier of the Gateway.

Returns:

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

gatewayUrl

GetGatewayResponse.Builder gatewayUrl(String gatewayUrl)

An endpoint for invoking Gateway.

Parameters:

gatewayUrl - An endpoint for invoking Gateway.

Returns:

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

createdAt

GetGatewayResponse.Builder createdAt(Instant createdAt)

The timestamp when the Gateway was created.

Parameters:

createdAt - The timestamp when the Gateway was created.

Returns:

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

updatedAt

GetGatewayResponse.Builder updatedAt(Instant updatedAt)

The timestamp when the Gateway was last updated.

Parameters:

updatedAt - The timestamp when the Gateway was last updated.

Returns:

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

status

GetGatewayResponse.Builder status(String status)

The current status of the Gateway.

Parameters:

status - The current status of the Gateway.

Returns:

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

See Also:

• GatewayStatus
• GatewayStatus

status

GetGatewayResponse.Builder status(GatewayStatus status)

The current status of the Gateway.

Parameters:

status - The current status of the Gateway.

Returns:

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

See Also:

• GatewayStatus
• GatewayStatus

statusReasons

GetGatewayResponse.Builder statusReasons(Collection<String> statusReasons)

The reasons for the current status of the Gateway.

Parameters:

statusReasons - The reasons for the current status of the Gateway.

Returns:

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

statusReasons

GetGatewayResponse.Builder statusReasons(String... statusReasons)

The reasons for the current status of the Gateway.

Parameters:

statusReasons - The reasons for the current status of the Gateway.

Returns:

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

name

GetGatewayResponse.Builder name(String name)

The name of the Gateway.

Parameters:

name - The name of the Gateway.

Returns:

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

description

GetGatewayResponse.Builder description(String description)

The description of the Gateway.

Parameters:

description - The description of the Gateway.

Returns:

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

roleArn

GetGatewayResponse.Builder roleArn(String roleArn)

The IAM role ARN that provides permissions for the Gateway.

Parameters:

roleArn - The IAM role ARN that provides permissions for the Gateway.

Returns:

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

protocolType

GetGatewayResponse.Builder protocolType(String protocolType)

Protocol applied to a Gateway.

Parameters:

protocolType - Protocol applied to a Gateway.

Returns:

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

See Also:

• GatewayProtocolType
• GatewayProtocolType

protocolType

GetGatewayResponse.Builder protocolType(GatewayProtocolType protocolType)

Protocol applied to a Gateway.

Parameters:

protocolType - Protocol applied to a Gateway.

Returns:

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

See Also:

• GatewayProtocolType
• GatewayProtocolType

protocolConfiguration

GetGatewayResponse.Builder protocolConfiguration(GatewayProtocolConfiguration protocolConfiguration)

Sets the value of the ProtocolConfiguration property for this object.

Parameters:

protocolConfiguration - The new value for the ProtocolConfiguration property for this object.

Returns:

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

protocolConfiguration

default GetGatewayResponse.Builder protocolConfiguration(Consumer<GatewayProtocolConfiguration.Builder> protocolConfiguration)

Sets the value of the ProtocolConfiguration property for this object. This is a convenience method that creates an instance of the GatewayProtocolConfiguration.Builder avoiding the need to create one manually via GatewayProtocolConfiguration.builder().

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

Parameters:

protocolConfiguration - a consumer that will call methods on GatewayProtocolConfiguration.Builder

Returns:

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

See Also:

• protocolConfiguration(GatewayProtocolConfiguration)

authorizerType

GetGatewayResponse.Builder authorizerType(String authorizerType)

Authorizer type for the gateway.

Parameters:

authorizerType - Authorizer type for the gateway.

Returns:

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

See Also:

• AuthorizerType
• AuthorizerType

authorizerType

GetGatewayResponse.Builder authorizerType(AuthorizerType authorizerType)

Authorizer type for the gateway.

Parameters:

authorizerType - Authorizer type for the gateway.

Returns:

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

See Also:

• AuthorizerType
• AuthorizerType

authorizerConfiguration

GetGatewayResponse.Builder authorizerConfiguration(AuthorizerConfiguration authorizerConfiguration)

The authorizer configuration for the Gateway.

Parameters:

authorizerConfiguration - The authorizer configuration for the Gateway.

Returns:

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

authorizerConfiguration

default GetGatewayResponse.Builder authorizerConfiguration(Consumer<AuthorizerConfiguration.Builder> authorizerConfiguration)

The authorizer configuration for the Gateway.

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

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

Parameters:

authorizerConfiguration - a consumer that will call methods on AuthorizerConfiguration.Builder

Returns:

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

See Also:

• authorizerConfiguration(AuthorizerConfiguration)

kmsKeyArn

GetGatewayResponse.Builder kmsKeyArn(String kmsKeyArn)

The ARN of the KMS key used to encrypt the Gateway.

Parameters:

kmsKeyArn - The ARN of the KMS key used to encrypt the Gateway.

Returns:

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

workloadIdentityDetails

GetGatewayResponse.Builder workloadIdentityDetails(WorkloadIdentityDetails workloadIdentityDetails)

The workload identity details for the Gateway.

Parameters:

workloadIdentityDetails - The workload identity details for the Gateway.

Returns:

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

workloadIdentityDetails

default GetGatewayResponse.Builder workloadIdentityDetails(Consumer<WorkloadIdentityDetails.Builder> workloadIdentityDetails)

The workload identity details for the Gateway.

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

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

Parameters:

workloadIdentityDetails - a consumer that will call methods on WorkloadIdentityDetails.Builder

Returns:

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

See Also:

• workloadIdentityDetails(WorkloadIdentityDetails)

exceptionLevel

GetGatewayResponse.Builder exceptionLevel(String exceptionLevel)

The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

Parameters:

exceptionLevel - The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

Returns:

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

See Also:

• ExceptionLevel
• ExceptionLevel

exceptionLevel

GetGatewayResponse.Builder exceptionLevel(ExceptionLevel exceptionLevel)

The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

Parameters:

exceptionLevel - The verbosity of exception messages. Use DEBUG mode to see granular exception messages from a Gateway. If this parameter is not set, exception messages are by default sanitized for presentation to end users.

Returns:

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

See Also:

• ExceptionLevel
• ExceptionLevel