Class TestConnectionInput

java.lang.Object
software.amazon.awssdk.services.glue.model.TestConnectionInput
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TestConnectionInput.Builder,TestConnectionInput>
@Generated("software.amazon.awssdk:codegen") public final class TestConnectionInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TestConnectionInput.Builder,TestConnectionInput>

A structure that is used to specify testing a connection to a service.

See Also:

  • Method Details

    • connectionType

      public final ConnectionType connectionType()

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

      If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().

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

    • connectionTypeAsString

      public final String connectionTypeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().

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

    • connectionProperties

      public final 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConnectionProperties() method.

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

    • hasConnectionProperties

      public final boolean hasConnectionProperties()
      For responses, this returns true if the service returned a value for the ConnectionProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • connectionPropertiesAsStrings

      public final Map<String,String> connectionPropertiesAsStrings()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConnectionProperties() method.

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

    • authenticationConfiguration

      public final AuthenticationConfigurationInput authenticationConfiguration()

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

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

    • toBuilder

      public TestConnectionInput.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TestConnectionInput.Builder,TestConnectionInput>
      Returns:
      a builder for type T

    • builder

      public static TestConnectionInput.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TestConnectionInput.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.