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

    • 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:

    • 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:

    • 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:

    • 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:

    • 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

      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:

    • 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:

    • kmsKeyArn

      GetGatewayResponse.Builder kmsKeyArn(String kmsKeyArn)

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

      Parameters:
      kmsKeyArn - The Amazon Resource Name (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:

    • exceptionLevel

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

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