Interface CreateGatewayResponse.Builder

All Superinterfaces:
AwsResponse.Builder, BedrockAgentCoreControlResponse.Builder, Buildable, CopyableBuilder<CreateGatewayResponse.Builder,CreateGatewayResponse>, SdkBuilder<CreateGatewayResponse.Builder,CreateGatewayResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
CreateGatewayResponse
@Mutable @NotThreadSafe public static interface CreateGatewayResponse.Builder extends BedrockAgentCoreControlResponse.Builder, SdkPojo, CopyableBuilder<CreateGatewayResponse.Builder,CreateGatewayResponse>

  • Method Details

    • gatewayArn

      CreateGatewayResponse.Builder gatewayArn(String gatewayArn)

      The Amazon Resource Name (ARN) of the created gateway.

      Parameters:
      gatewayArn - The Amazon Resource Name (ARN) of the created gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gatewayId

      CreateGatewayResponse.Builder gatewayId(String gatewayId)

      The unique identifier of the created gateway.

      Parameters:
      gatewayId - The unique identifier of the created gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gatewayUrl

      CreateGatewayResponse.Builder gatewayUrl(String gatewayUrl)

      The URL endpoint for the created gateway.

      Parameters:
      gatewayUrl - The URL endpoint for the created gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      CreateGatewayResponse.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

      CreateGatewayResponse.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

      CreateGatewayResponse.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:

    • status

      CreateGatewayResponse.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:

    • statusReasons

      CreateGatewayResponse.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

      CreateGatewayResponse.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

      CreateGatewayResponse.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

      CreateGatewayResponse.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

      CreateGatewayResponse.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role associated with the gateway.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocolType

      CreateGatewayResponse.Builder protocolType(String protocolType)

      The protocol type of the gateway.

      Parameters:
      protocolType - The protocol type of the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocolType

      CreateGatewayResponse.Builder protocolType(GatewayProtocolType protocolType)

      The protocol type of the gateway.

      Parameters:
      protocolType - The protocol type of the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocolConfiguration

      CreateGatewayResponse.Builder protocolConfiguration(GatewayProtocolConfiguration protocolConfiguration)

      The configuration settings for the protocol used by the gateway.

      Parameters:
      protocolConfiguration - The configuration settings for the protocol used by the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocolConfiguration

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

      The configuration settings for the protocol used by the gateway.

      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:

    • authorizerType

      CreateGatewayResponse.Builder authorizerType(String authorizerType)

      The type of authorizer used by the gateway.

      Parameters:
      authorizerType - The type of authorizer used by the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authorizerType

      CreateGatewayResponse.Builder authorizerType(AuthorizerType authorizerType)

      The type of authorizer used by the gateway.

      Parameters:
      authorizerType - The type of authorizer used by the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authorizerConfiguration

      CreateGatewayResponse.Builder authorizerConfiguration(AuthorizerConfiguration authorizerConfiguration)

      The authorizer configuration for the created gateway.

      Parameters:
      authorizerConfiguration - The authorizer configuration for the created gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorizerConfiguration

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

      The authorizer configuration for the created 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:

    • kmsKeyArn

      CreateGatewayResponse.Builder kmsKeyArn(String kmsKeyArn)

      The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.

      Parameters:
      kmsKeyArn - The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workloadIdentityDetails

      CreateGatewayResponse.Builder workloadIdentityDetails(WorkloadIdentityDetails workloadIdentityDetails)

      The workload identity details for the created gateway.

      Parameters:
      workloadIdentityDetails - The workload identity details for the created gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workloadIdentityDetails

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

      The workload identity details for the created 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:

    • exceptionLevel

      CreateGatewayResponse.Builder exceptionLevel(String 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.

      Parameters:
      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.

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

    • exceptionLevel

      CreateGatewayResponse.Builder exceptionLevel(ExceptionLevel 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.

      Parameters:
      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.

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