Class DescribeConnectionTypeResponse

    • Method Detail

      • connectionType

        public final String connectionType()

        The name of the connection type.

        Returns:
        The name of the connection type.
      • description

        public final String description()

        A description of the connection type.

        Returns:
        A description of the connection type.
      • capabilities

        public final Capabilities capabilities()

        The supported authentication types, data interface types (compute environments), and data operations of the connector.

        Returns:
        The supported authentication types, data interface types (compute environments), and data operations of the connector.
      • 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.
      • connectionProperties

        public final Map<String,​Property> connectionProperties()

        Connection properties which are common across compute environments.

        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:
        Connection properties which are common across compute environments.
      • hasConnectionOptions

        public final boolean hasConnectionOptions()
        For responses, this returns true if the service returned a value for the ConnectionOptions 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.
      • connectionOptions

        public final Map<String,​Property> connectionOptions()

        Returns properties that can be set when creating a connection in the ConnectionInput.ConnectionProperties. ConnectionOptions defines parameters that can be set in a Spark ETL script in the connection options map passed to a dataframe.

        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 hasConnectionOptions() method.

        Returns:
        Returns properties that can be set when creating a connection in the ConnectionInput.ConnectionProperties. ConnectionOptions defines parameters that can be set in a Spark ETL script in the connection options map passed to a dataframe.
      • authenticationConfiguration

        public final AuthConfiguration authenticationConfiguration()

        The type of authentication used for the connection.

        Returns:
        The type of authentication used for the connection.
      • hasComputeEnvironmentConfigurations

        public final boolean hasComputeEnvironmentConfigurations()
        For responses, this returns true if the service returned a value for the ComputeEnvironmentConfigurations 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.
      • computeEnvironmentConfigurations

        public final Map<String,​ComputeEnvironmentConfiguration> computeEnvironmentConfigurations()

        The compute environments that are supported by the connection.

        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 hasComputeEnvironmentConfigurations() method.

        Returns:
        The compute environments that are supported by the connection.
      • hasPhysicalConnectionRequirements

        public final boolean hasPhysicalConnectionRequirements()
        For responses, this returns true if the service returned a value for the PhysicalConnectionRequirements 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.
      • physicalConnectionRequirements

        public final Map<String,​Property> physicalConnectionRequirements()

        Physical requirements for a connection, such as VPC, Subnet and Security Group specifications.

        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 hasPhysicalConnectionRequirements() method.

        Returns:
        Physical requirements for a connection, such as VPC, Subnet and Security Group specifications.
      • hasAthenaConnectionProperties

        public final boolean hasAthenaConnectionProperties()
        For responses, this returns true if the service returned a value for the AthenaConnectionProperties 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.
      • athenaConnectionProperties

        public final Map<String,​Property> athenaConnectionProperties()

        Connection properties specific to the Athena compute environment.

        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 hasAthenaConnectionProperties() method.

        Returns:
        Connection properties specific to the Athena compute environment.
      • hasPythonConnectionProperties

        public final boolean hasPythonConnectionProperties()
        For responses, this returns true if the service returned a value for the PythonConnectionProperties 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.
      • pythonConnectionProperties

        public final Map<String,​Property> pythonConnectionProperties()

        Connection properties specific to the Python compute environment.

        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 hasPythonConnectionProperties() method.

        Returns:
        Connection properties specific to the Python compute environment.
      • hasSparkConnectionProperties

        public final boolean hasSparkConnectionProperties()
        For responses, this returns true if the service returned a value for the SparkConnectionProperties 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.
      • sparkConnectionProperties

        public final Map<String,​Property> sparkConnectionProperties()

        Connection properties specific to the Spark compute environment.

        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 hasSparkConnectionProperties() method.

        Returns:
        Connection properties specific to the Spark compute environment.
      • 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