software.amazon.awssdk.services.appflow.model

Class DestinationFieldProperties

java.lang.Object

software.amazon.awssdk.services.appflow.model.DestinationFieldProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DestinationFieldProperties.Builder,DestinationFieldProperties>

@Generated(value="software.amazon.awssdk:codegen")
public final class DestinationFieldProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DestinationFieldProperties.Builder,DestinationFieldProperties>

The properties that can be applied to a field when connector is being used as a destination.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DestinationFieldProperties.Builder

Method Summary

Modifier and Type	Method and Description
static DestinationFieldProperties.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSupportedWriteOperations() For responses, this returns true if the service returned a value for the SupportedWriteOperations property.
Boolean	isCreatable() Specifies if the destination field can be created by the current user.
Boolean	isNullable() Specifies if the destination field can have a null value.
Boolean	isUpdatable() Specifies whether the field can be updated during an UPDATE or UPSERT write operation.
Boolean	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.
List<SdkField<?>>	sdkFields()
static Class<? extends DestinationFieldProperties.Builder>	serializableBuilderClass()
List<WriteOperationType>	supportedWriteOperations() A list of supported write operations.
List<String>	supportedWriteOperationsAsStrings() A list of supported write operations.
DestinationFieldProperties.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

isCreatable

public final Boolean 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

public final Boolean isNullable()

Specifies if the destination field can have a null value.

Returns:

Specifies if the destination field can have a null value.

isUpsertable

public final Boolean 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

public final Boolean isUpdatable()

Specifies whether the field can be updated during an UPDATE or UPSERT write operation.

Returns:

Specifies whether the field can be updated during an UPDATE or UPSERT write operation.

supportedWriteOperations

public final List<WriteOperationType> 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 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.

supportedWriteOperationsAsStrings

public final List<String> 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

public DestinationFieldProperties.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<DestinationFieldProperties.Builder,DestinationFieldProperties>

Returns:

a builder for type T

builder

public static DestinationFieldProperties.Builder builder()

serializableBuilderClass

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