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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceConnectorProperty.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>allowedValues()A list ofAllowedValueobjects representing the values allowed for the property.static ConnectorProperty.Builderbuilder()StringdefaultValue()The default value for the property.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAllowedValues()For responses, this returns true if the service returned a value for the AllowedValues property.inthashCode()StringkeyOverride()A key name to use when sending this property in API requests, if different from the display name.Stringname()The name of the property.PropertyLocationpropertyLocation()Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.StringpropertyLocationAsString()Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.PropertyTypepropertyType()The data type of this propertyStringpropertyTypeAsString()The data type of this propertyBooleanrequired()Indicates whether the property is required.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ConnectorProperty.Builder>serializableBuilderClass()ConnectorProperty.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
-
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 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.
-
allowedValues
public final List<String> allowedValues()
A list of
AllowedValueobjects 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
AllowedValueobjects 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,
propertyLocationwill returnPropertyLocation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompropertyLocationAsString().- Returns:
- Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
- See Also:
PropertyLocation
-
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,
propertyLocationwill returnPropertyLocation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompropertyLocationAsString().- Returns:
- Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
- See Also:
PropertyLocation
-
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,
propertyTypewill returnPropertyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompropertyTypeAsString().- Returns:
- The data type of this property
- See Also:
PropertyType
-
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,
propertyTypewill returnPropertyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompropertyTypeAsString().- Returns:
- The data type of this property
- See Also:
PropertyType
-
toBuilder
public ConnectorProperty.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ConnectorProperty.Builder,ConnectorProperty>
-
builder
public static ConnectorProperty.Builder builder()
-
serializableBuilderClass
public static Class<? extends ConnectorProperty.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
-
-