Class DestinationFieldProperties
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DestinationFieldProperties.Builder,
DestinationFieldProperties>
The properties that can be applied to a field when connector is being used as a destination.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupportedWriteOperations property.final Boolean
Specifies if the destination field can be created by the current user.final Boolean
Specifies whether the field can use the default value during a Create operation.final Boolean
Specifies if the destination field can have a null value.final Boolean
Specifies whether the field can be updated during anUPDATE
orUPSERT
write operation.final Boolean
Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.static Class
<? extends DestinationFieldProperties.Builder> final List
<WriteOperationType> A list of supported write operations.A list of supported write operations.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
isCreatable
Specifies if the destination field can be created by the current user.
- Returns:
- Specifies if the destination field can be created by the current user.
-
isNullable
Specifies if the destination field can have a null value.
- Returns:
- Specifies if the destination field can have a null value.
-
isUpsertable
Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.
- Returns:
- Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.
-
isUpdatable
Specifies whether the field can be updated during an
UPDATE
orUPSERT
write operation.- Returns:
- Specifies whether the field can be updated during an
UPDATE
orUPSERT
write operation.
-
isDefaultedOnCreate
Specifies whether the field can use the default value during a Create operation.
- Returns:
- Specifies whether the field can use the default value during a Create operation.
-
supportedWriteOperations
A list of supported write operations. For each write operation listed, this field can be used in
idFieldNames
when that write operation is present as a destination option.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
hasSupportedWriteOperations()
method.- Returns:
- A list of supported write operations. For each write operation listed, this field can be used in
idFieldNames
when that write operation is present as a destination option.
-
hasSupportedWriteOperations
public final boolean hasSupportedWriteOperations()For responses, this returns true if the service returned a value for the SupportedWriteOperations 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. -
supportedWriteOperationsAsStrings
A list of supported write operations. For each write operation listed, this field can be used in
idFieldNames
when that write operation is present as a destination option.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
hasSupportedWriteOperations()
method.- Returns:
- A list of supported write operations. For each write operation listed, this field can be used in
idFieldNames
when that write operation is present as a destination option.
-
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 interfaceToCopyableBuilder<DestinationFieldProperties.Builder,
DestinationFieldProperties> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-