Class ConnectivityProperties

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

Contains the network and authentication settings for a connection, including connection credentials, physical network requirements, and compute-environment validation options.

See Also:

  • Method Details

    • 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,String> connectionProperties()

      The connection properties for this configuration.

      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 connection properties for this configuration.

    • physicalConnectionRequirements

      public final PhysicalConnectionRequirements physicalConnectionRequirements()

      The physical network requirements for the connection, such as the subnet, security group, and VPC settings needed to reach the data source.

      Returns:
      The physical network requirements for the connection, such as the subnet, security group, and VPC settings needed to reach the data source.

    • name

      public final String name()

      The name of the connectivity configuration.

      Returns:
      The name of the connectivity configuration.

    • description

      public final String description()

      The description of the connectivity configuration.

      Returns:
      The description of the connectivity configuration.

    • validateCredentials

      public final Boolean validateCredentials()

      Specifies whether to validate credentials for the connectivity configuration. Defaults to true if not specified.

      Returns:
      Specifies whether to validate credentials for the connectivity configuration. Defaults to true if not specified.

    • validateForComputeEnvironments

      public final List<ComputeEnvironments> validateForComputeEnvironments()

      The compute environments to use when validating connectivity. The service validates that the connection is reachable from each specified 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 hasValidateForComputeEnvironments() method.

      Returns:
      The compute environments to use when validating connectivity. The service validates that the connection is reachable from each specified environment.

    • hasValidateForComputeEnvironments

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

    • validateForComputeEnvironmentsAsStrings

      public final List<String> validateForComputeEnvironmentsAsStrings()

      The compute environments to use when validating connectivity. The service validates that the connection is reachable from each specified 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 hasValidateForComputeEnvironments() method.

      Returns:
      The compute environments to use when validating connectivity. The service validates that the connection is reachable from each specified environment.

    • hasSparkProperties

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

    • sparkProperties

      public final Map<String,String> sparkProperties()

      The Spark properties for this configuration.

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

      Returns:
      The Spark properties for this configuration.

    • hasAthenaProperties

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

    • athenaProperties

      public final Map<String,String> athenaProperties()

      The Athena properties for this configuration.

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

      Returns:
      The Athena properties for this configuration.

    • hasPythonProperties

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

    • pythonProperties

      public final Map<String,String> pythonProperties()

      The Python properties for this configuration.

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

      Returns:
      The Python properties for this configuration.

    • authenticationConfiguration

      public final AuthenticationConfigurationInput authenticationConfiguration()

      The authentication settings for this configuration.

      Returns:
      The authentication settings for this configuration.

    • toBuilder

      public ConnectivityProperties.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<ConnectivityProperties.Builder,ConnectivityProperties>
      Returns:
      a builder for type T

    • builder

      public static ConnectivityProperties.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ConnectivityProperties.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.