Class ConnectorEntityField
- java.lang.Object
-
- software.amazon.awssdk.services.appflow.model.ConnectorEntityField
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ConnectorEntityField.Builder,ConnectorEntityField>
@Generated("software.amazon.awssdk:codegen") public final class ConnectorEntityField extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ConnectorEntityField.Builder,ConnectorEntityField>
Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceConnectorEntityField.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ConnectorEntityField.Builderbuilder()Map<String,String>customProperties()A map that has specific properties related to the ConnectorEntityField.StringdefaultValue()Default value that can be assigned to this field.Stringdescription()A description of the connector entity field.DestinationFieldPropertiesdestinationProperties()The properties applied to a field when the connector is being used as a destination.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCustomProperties()For responses, this returns true if the service returned a value for the CustomProperties property.inthashCode()Stringidentifier()The unique identifier of the connector field.BooleanisDeprecated()Booelan value that indicates whether this field is deprecated or not.BooleanisPrimaryKey()Booelan value that indicates whether this field can be used as a primary key.Stringlabel()The label applied to a connector entity field.StringparentIdentifier()The parent identifier of the connector field.List<SdkField<?>>sdkFields()static Class<? extends ConnectorEntityField.Builder>serializableBuilderClass()SourceFieldPropertiessourceProperties()The properties that can be applied to a field when the connector is being used as a source.SupportedFieldTypeDetailssupportedFieldTypeDetails()Contains details regarding the supportedFieldType, including the correspondingfilterOperatorsandsupportedValues.ConnectorEntityField.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
-
identifier
public final String identifier()
The unique identifier of the connector field.
- Returns:
- The unique identifier of the connector field.
-
parentIdentifier
public final String parentIdentifier()
The parent identifier of the connector field.
- Returns:
- The parent identifier of the connector field.
-
label
public final String label()
The label applied to a connector entity field.
- Returns:
- The label applied to a connector entity field.
-
isPrimaryKey
public final Boolean isPrimaryKey()
Booelan value that indicates whether this field can be used as a primary key.
- Returns:
- Booelan value that indicates whether this field can be used as a primary key.
-
defaultValue
public final String defaultValue()
Default value that can be assigned to this field.
- Returns:
- Default value that can be assigned to this field.
-
isDeprecated
public final Boolean isDeprecated()
Booelan value that indicates whether this field is deprecated or not.
- Returns:
- Booelan value that indicates whether this field is deprecated or not.
-
supportedFieldTypeDetails
public final SupportedFieldTypeDetails supportedFieldTypeDetails()
Contains details regarding the supported
FieldType, including the correspondingfilterOperatorsandsupportedValues.- Returns:
- Contains details regarding the supported
FieldType, including the correspondingfilterOperatorsandsupportedValues.
-
description
public final String description()
A description of the connector entity field.
- Returns:
- A description of the connector entity field.
-
sourceProperties
public final SourceFieldProperties sourceProperties()
The properties that can be applied to a field when the connector is being used as a source.
- Returns:
- The properties that can be applied to a field when the connector is being used as a source.
-
destinationProperties
public final DestinationFieldProperties destinationProperties()
The properties applied to a field when the connector is being used as a destination.
- Returns:
- The properties applied to a field when the connector is being used as a destination.
-
hasCustomProperties
public final boolean hasCustomProperties()
For responses, this returns true if the service returned a value for the CustomProperties 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.
-
customProperties
public final Map<String,String> customProperties()
A map that has specific properties related to the ConnectorEntityField.
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
hasCustomProperties()method.- Returns:
- A map that has specific properties related to the ConnectorEntityField.
-
toBuilder
public ConnectorEntityField.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ConnectorEntityField.Builder,ConnectorEntityField>
-
builder
public static ConnectorEntityField.Builder builder()
-
serializableBuilderClass
public static Class<? extends ConnectorEntityField.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.
-
-