Class ConnectorProperty

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

Defines a property configuration for connection types, default values, and where the property should be used in requests.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the property.

      Returns:
      The name of the property.

    • keyOverride

      public final String keyOverride()

      A key name to use when sending this property in API requests, if different from the display name.

      Returns:
      A key name to use when sending this property in API requests, if different from the display name.

    • required

      public final Boolean required()

      Indicates whether the property is required.

      Returns:
      Indicates whether the property is required.

    • defaultValue

      public final String defaultValue()

      The default value for the property.

      Returns:
      The default value for the property.

    • hasAllowedValues

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

    • allowedValues

      public final List<String> allowedValues()

      A list of AllowedValue objects representing the values allowed for the property.

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

      Returns:
      A list of AllowedValue objects representing the values allowed for the property.

    • propertyLocation

      public final PropertyLocation propertyLocation()

      Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

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

      Returns:
      Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
      See Also:

    • propertyLocationAsString

      public final String propertyLocationAsString()

      Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

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

      Returns:
      Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
      See Also:

    • propertyType

      public final PropertyType propertyType()

      The data type of this property

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

      Returns:
      The data type of this property
      See Also:

    • propertyTypeAsString

      public final String propertyTypeAsString()

      The data type of this property

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

      Returns:
      The data type of this property
      See Also:

    • toBuilder

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

    • builder

      public static ConnectorProperty.Builder builder()

    • serializableBuilderClass

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