Class DestinationFieldProperties

    • 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.
      • isDefaultedOnCreate

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

        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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)