Class CustomConnectorDestinationProperties

    • Method Detail

      • entityName

        public final String entityName()

        The entity specified in the custom connector as a destination in the flow.

        Returns:
        The entity specified in the custom connector as a destination in the flow.
      • errorHandlingConfig

        public final ErrorHandlingConfig errorHandlingConfig()

        The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination.

        Returns:
        The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination.
      • writeOperationTypeAsString

        public final String writeOperationTypeAsString()

        Specifies the type of write operation to be performed in the custom connector when it's used as destination.

        If the service returns an enum value that is not available in the current SDK version, writeOperationType will return WriteOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from writeOperationTypeAsString().

        Returns:
        Specifies the type of write operation to be performed in the custom connector when it's used as destination.
        See Also:
        WriteOperationType
      • hasIdFieldNames

        public final boolean hasIdFieldNames()
        For responses, this returns true if the service returned a value for the IdFieldNames 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.
      • idFieldNames

        public final List<String> idFieldNames()

        The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert.

        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 hasIdFieldNames() method.

        Returns:
        The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert.
      • 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 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.
      • customProperties

        public final Map<String,​String> customProperties()

        The custom properties that are specific to the connector when it's used as a destination in the flow.

        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:
        The custom properties that are specific to the connector when it's used as a destination in the flow.
      • 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)