com.amazonaws.appflow.custom.connector.model.connectorconfiguration

Interface DescribeConnectorConfigurationResponse

All Known Implementing Classes:

ImmutableDescribeConnectorConfigurationResponse

@Value.Immutable
public interface DescribeConnectorConfigurationResponse

Represents the output of a DescribeConnectorConfiguration operation.

Method Summary

Modifier and Type	Method and Description
AuthenticationConfig	authenticationConfig() AuthenticationConfig supported by the connector.
List<ConnectorModes>	connectorModes() List of ConnectorMode supported by the connector.
String	connectorName() Name of the connector.
String	connectorOwner() Name of the connector owner.
List<ConnectorRuntimeSetting>	connectorRuntimeSetting() Custom connector runtime settings for which connector requires input from the end user.
String	connectorVersion() Version of the connector.
ErrorDetails	errorDetails() Error details if the Operation is unsuccessful.
boolean	isSuccess() Specifies if the operation is successful or not.
String	logoURL() Logo URL for display purposes for connector icon.
default List<ConnectorOperator>	operatorsSupported() Operators supported by the connector.
List<String>	supportedApiVersions() List of API versions supported by connector for the underlying application.
default List<TriggerType>	supportedTriggerTypes() Trigger types supported by connector.
default List<WriteOperationType>	supportedWriteOperations() Write Operations supported by Connector.
default List<TriggerFrequency>	triggerFrequenciesSupported() Trigger frequencies supported by Connector.

Method Detail

connectorOwner

String connectorOwner()

Name of the connector owner.

connectorName

String connectorName()

Name of the connector.

connectorVersion

String connectorVersion()

Version of the connector.

connectorModes

List<ConnectorModes> connectorModes()

List of ConnectorMode supported by the connector.

authenticationConfig

@Nullable
AuthenticationConfig authenticationConfig()

AuthenticationConfig supported by the connector. Can be null if connector doesn't need any credentials from customer.

connectorRuntimeSetting

@Nullable
List<ConnectorRuntimeSetting> connectorRuntimeSetting()

Custom connector runtime settings for which connector requires input from the end user.

supportedApiVersions

List<String> supportedApiVersions()

List of API versions supported by connector for the underlying application. For example, if the underlying application is Salesforce, then example could be List of {v46.0, v47.0, v48.9}.

operatorsSupported

@Value.Default
default List<ConnectorOperator> operatorsSupported()

Operators supported by the connector. Default: all the operators

supportedTriggerTypes

@Value.Default
default List<TriggerType> supportedTriggerTypes()

Trigger types supported by connector. Default is OnDemand and Scheduled.

triggerFrequenciesSupported

@Value.Default
default List<TriggerFrequency> triggerFrequenciesSupported()

Trigger frequencies supported by Connector. Default: all trigger frequencies

supportedWriteOperations

@Value.Default
default List<WriteOperationType> supportedWriteOperations()

Write Operations supported by Connector. Only applicable if the connector support DESTINATION mode. Default is all the Write Operation types supported.

logoURL

@Nullable
String logoURL()

Logo URL for display purposes for connector icon.

isSuccess

boolean isSuccess()

Specifies if the operation is successful or not.

errorDetails

@Nullable
ErrorDetails errorDetails()

Error details if the Operation is unsuccessful.