Interface GetPaymentConnectorResponse.Builder

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

  • Method Details

    • paymentConnectorId

      GetPaymentConnectorResponse.Builder paymentConnectorId(String paymentConnectorId)

      The unique identifier of the payment connector.

      Parameters:
      paymentConnectorId - The unique identifier of the payment connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetPaymentConnectorResponse.Builder name(String name)

      The name of the payment connector.

      Parameters:
      name - The name of the payment connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      GetPaymentConnectorResponse.Builder description(String description)

      The description of the payment connector.

      Parameters:
      description - The description of the payment connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      GetPaymentConnectorResponse.Builder type(String type)

      The type of the payment connector, which determines the payment provider integration.

      Parameters:
      type - The type of the payment connector, which determines the payment provider integration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      GetPaymentConnectorResponse.Builder type(PaymentConnectorType type)

      The type of the payment connector, which determines the payment provider integration.

      Parameters:
      type - The type of the payment connector, which determines the payment provider integration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • provisionMode

      GetPaymentConnectorResponse.Builder provisionMode(String provisionMode)

      Specifies how the payment connector was provisioned. Payment connectors that were created before this field was available return MANUAL.

      • MANUAL - You provided the credential provider configurations, so you own the credentials. Rotate them with the payment provider, then call UpdatePaymentCredentialProvider.

      • QUICK_CREATE - AgentCore provisioned the credential provider for you, so the credentials are service-managed. You can rotate them with RotatePaymentConnectorCredentials.

      Parameters:
      provisionMode - Specifies how the payment connector was provisioned. Payment connectors that were created before this field was available return MANUAL.

      • MANUAL - You provided the credential provider configurations, so you own the credentials. Rotate them with the payment provider, then call UpdatePaymentCredentialProvider.

      • QUICK_CREATE - AgentCore provisioned the credential provider for you, so the credentials are service-managed. You can rotate them with RotatePaymentConnectorCredentials.

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

    • provisionMode

      GetPaymentConnectorResponse.Builder provisionMode(PaymentConnectorProvisionMode provisionMode)

      Specifies how the payment connector was provisioned. Payment connectors that were created before this field was available return MANUAL.

      • MANUAL - You provided the credential provider configurations, so you own the credentials. Rotate them with the payment provider, then call UpdatePaymentCredentialProvider.

      • QUICK_CREATE - AgentCore provisioned the credential provider for you, so the credentials are service-managed. You can rotate them with RotatePaymentConnectorCredentials.

      Parameters:
      provisionMode - Specifies how the payment connector was provisioned. Payment connectors that were created before this field was available return MANUAL.

      • MANUAL - You provided the credential provider configurations, so you own the credentials. Rotate them with the payment provider, then call UpdatePaymentCredentialProvider.

      • QUICK_CREATE - AgentCore provisioned the credential provider for you, so the credentials are service-managed. You can rotate them with RotatePaymentConnectorCredentials.

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

    • credentialProviderConfigurations

      GetPaymentConnectorResponse.Builder credentialProviderConfigurations(Collection<CredentialsProviderConfiguration> credentialProviderConfigurations)

      The credential provider configurations for the payment connector.

      Parameters:
      credentialProviderConfigurations - The credential provider configurations for the payment connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • credentialProviderConfigurations

      GetPaymentConnectorResponse.Builder credentialProviderConfigurations(CredentialsProviderConfiguration... credentialProviderConfigurations)

      The credential provider configurations for the payment connector.

      Parameters:
      credentialProviderConfigurations - The credential provider configurations for the payment connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • credentialProviderConfigurations

      GetPaymentConnectorResponse.Builder credentialProviderConfigurations(Consumer<CredentialsProviderConfiguration.Builder>... credentialProviderConfigurations)

      The credential provider configurations for the payment connector.

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

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

      Parameters:
      credentialProviderConfigurations - a consumer that will call methods on CredentialsProviderConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      GetPaymentConnectorResponse.Builder createdAt(Instant createdAt)

      The timestamp when the payment connector was created.

      Parameters:
      createdAt - The timestamp when the payment connector was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedAt

      GetPaymentConnectorResponse.Builder lastUpdatedAt(Instant lastUpdatedAt)

      The timestamp when the payment connector was last updated.

      Parameters:
      lastUpdatedAt - The timestamp when the payment connector was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetPaymentConnectorResponse.Builder status(String status)

      The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

      Parameters:
      status - The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetPaymentConnectorResponse.Builder status(PaymentConnectorStatus status)

      The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

      Parameters:
      status - The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authorizationUrl

      GetPaymentConnectorResponse.Builder authorizationUrl(String authorizationUrl)

      The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is PENDING_AUTHENTICATION.

      Parameters:
      authorizationUrl - The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is PENDING_AUTHENTICATION.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • credentialsUpdatedAt

      GetPaymentConnectorResponse.Builder credentialsUpdatedAt(Instant credentialsUpdatedAt)

      The timestamp when the payment connector's current service-managed credentials took effect. It is first set when the credentials are provisioned and is updated by each rotation. This field is present only for payment connectors with a provisionMode of QUICK_CREATE.

      Parameters:
      credentialsUpdatedAt - The timestamp when the payment connector's current service-managed credentials took effect. It is first set when the credentials are provisioned and is updated by each rotation. This field is present only for payment connectors with a provisionMode of QUICK_CREATE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.