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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceTestConnectionInput.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AuthenticationConfigurationInputauthenticationConfiguration()A structure containing the authentication configuration in the TestConnection request.static TestConnectionInput.Builderbuilder()Map<ConnectionPropertyKey,String>connectionProperties()The key-value pairs that define parameters for the connection.Map<String,String>connectionPropertiesAsStrings()The key-value pairs that define parameters for the connection.ConnectionTypeconnectionType()The type of connection to test.StringconnectionTypeAsString()The type of connection to test.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasConnectionProperties()For responses, this returns true if the service returned a value for the ConnectionProperties property.inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends TestConnectionInput.Builder>serializableBuilderClass()TestConnectionInput.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
connectionType
public final ConnectionType connectionType()
The type of connection to test. This operation is only available for the
JDBCorSALESFORCEconnection types.If the service returns an enum value that is not available in the current SDK version,
connectionTypewill returnConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconnectionTypeAsString().- Returns:
- The type of connection to test. This operation is only available for the
JDBCorSALESFORCEconnection types. - See Also:
ConnectionType
-
connectionTypeAsString
public final String connectionTypeAsString()
The type of connection to test. This operation is only available for the
JDBCorSALESFORCEconnection types.If the service returns an enum value that is not available in the current SDK version,
connectionTypewill returnConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconnectionTypeAsString().- Returns:
- The type of connection to test. This operation is only available for the
JDBCorSALESFORCEconnection types. - See Also:
ConnectionType
-
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) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_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
AuthenticationConfigurationmember 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) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_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
AuthenticationConfigurationmember 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 theisEmpty()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) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_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
AuthenticationConfigurationmember 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) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_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
AuthenticationConfigurationmember 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<TestConnectionInput.Builder,TestConnectionInput>
-
builder
public static TestConnectionInput.Builder builder()
-
serializableBuilderClass
public static Class<? extends TestConnectionInput.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-