Interface TestConnectionInput.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TestConnectionInput.Builder,TestConnectionInput>, SdkBuilder<TestConnectionInput.Builder,TestConnectionInput>, SdkPojo
Enclosing class:
TestConnectionInput
public static interface TestConnectionInput.Builder extends SdkPojo, CopyableBuilder<TestConnectionInput.Builder,TestConnectionInput>

  • Method Details

    • connectionType

      TestConnectionInput.Builder connectionType(String connectionType)

      The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.

      Parameters:
      connectionType - The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectionType

      TestConnectionInput.Builder connectionType(ConnectionType connectionType)

      The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.

      Parameters:
      connectionType - The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectionPropertiesWithStrings

      TestConnectionInput.Builder connectionPropertiesWithStrings(Map<String,String> connectionProperties)

      The key-value pairs that define parameters for the connection.

      JDBC connections use the following connection properties:

      • Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.

      • Required: All of (USERNAME, PASSWORD) or SECRET_ID.

      • Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.

      SALESFORCE connections require the AuthenticationConfiguration member to be configured.

      Parameters:
      connectionProperties - The key-value pairs that define parameters for the connection.

      JDBC connections use the following connection properties:

      • Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.

      • Required: All of (USERNAME, PASSWORD) or SECRET_ID.

      • Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.

      SALESFORCE connections require the AuthenticationConfiguration member to be configured.

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

    • connectionProperties

      TestConnectionInput.Builder connectionProperties(Map<ConnectionPropertyKey,String> connectionProperties)

      The key-value pairs that define parameters for the connection.

      JDBC connections use the following connection properties:

      • Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.

      • Required: All of (USERNAME, PASSWORD) or SECRET_ID.

      • Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.

      SALESFORCE connections require the AuthenticationConfiguration member to be configured.

      Parameters:
      connectionProperties - The key-value pairs that define parameters for the connection.

      JDBC connections use the following connection properties:

      • Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.

      • Required: All of (USERNAME, PASSWORD) or SECRET_ID.

      • Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.

      SALESFORCE connections require the AuthenticationConfiguration member to be configured.

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

    • authenticationConfiguration

      TestConnectionInput.Builder authenticationConfiguration(AuthenticationConfigurationInput authenticationConfiguration)

      A structure containing the authentication configuration in the TestConnection request. Required for a connection to Salesforce using OAuth authentication.

      Parameters:
      authenticationConfiguration - A structure containing the authentication configuration in the TestConnection request. Required for a connection to Salesforce using OAuth authentication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationConfiguration

      default TestConnectionInput.Builder authenticationConfiguration(Consumer<AuthenticationConfigurationInput.Builder> authenticationConfiguration)

      A structure containing the authentication configuration in the TestConnection request. Required for a connection to Salesforce using OAuth authentication.

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

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

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