software.amazon.awssdk.services.appflow.model

Interface ConnectorConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ConnectorConfiguration.Builder,ConnectorConfiguration>, SdkBuilder<ConnectorConfiguration.Builder,ConnectorConfiguration>, SdkPojo

Enclosing class:

ConnectorConfiguration

public static interface ConnectorConfiguration.Builder
extends SdkPojo, CopyableBuilder<ConnectorConfiguration.Builder,ConnectorConfiguration>

Method Summary

Modifier and Type	Method and Description
ConnectorConfiguration.Builder	authenticationConfig(AuthenticationConfig authenticationConfig) The authentication config required for the connector.
default ConnectorConfiguration.Builder	authenticationConfig(Consumer<AuthenticationConfig.Builder> authenticationConfig) The authentication config required for the connector.
ConnectorConfiguration.Builder	canUseAsDestination(Boolean canUseAsDestination) Specifies whether the connector can be used as a destination.
ConnectorConfiguration.Builder	canUseAsSource(Boolean canUseAsSource) Specifies whether the connector can be used as a source.
ConnectorConfiguration.Builder	connectorArn(String connectorArn) The Amazon Resource Name (ARN) for the registered connector.
ConnectorConfiguration.Builder	connectorDescription(String connectorDescription) A description about the connector.
ConnectorConfiguration.Builder	connectorLabel(String connectorLabel) The label used for registering the connector.
ConnectorConfiguration.Builder	connectorMetadata(ConnectorMetadata connectorMetadata) Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
default ConnectorConfiguration.Builder	connectorMetadata(Consumer<ConnectorMetadata.Builder> connectorMetadata) Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
ConnectorConfiguration.Builder	connectorModes(Collection<String> connectorModes) The connection modes that the connector supports.
ConnectorConfiguration.Builder	connectorModes(String... connectorModes) The connection modes that the connector supports.
ConnectorConfiguration.Builder	connectorName(String connectorName) The connector name.
ConnectorConfiguration.Builder	connectorOwner(String connectorOwner) The owner who developed the connector.
ConnectorConfiguration.Builder	connectorProvisioningConfig(ConnectorProvisioningConfig connectorProvisioningConfig) The configuration required for registering the connector.
default ConnectorConfiguration.Builder	connectorProvisioningConfig(Consumer<ConnectorProvisioningConfig.Builder> connectorProvisioningConfig) The configuration required for registering the connector.
ConnectorConfiguration.Builder	connectorProvisioningType(ConnectorProvisioningType connectorProvisioningType) The provisioning type used to register the connector.
ConnectorConfiguration.Builder	connectorProvisioningType(String connectorProvisioningType) The provisioning type used to register the connector.
ConnectorConfiguration.Builder	connectorRuntimeSettings(Collection<ConnectorRuntimeSetting> connectorRuntimeSettings) The required connector runtime settings.
ConnectorConfiguration.Builder	connectorRuntimeSettings(ConnectorRuntimeSetting... connectorRuntimeSettings) The required connector runtime settings.
ConnectorConfiguration.Builder	connectorRuntimeSettings(Consumer<ConnectorRuntimeSetting.Builder>... connectorRuntimeSettings) The required connector runtime settings.
ConnectorConfiguration.Builder	connectorType(ConnectorType connectorType) The connector type.
ConnectorConfiguration.Builder	connectorType(String connectorType) The connector type.
ConnectorConfiguration.Builder	connectorVersion(String connectorVersion) The connector version.
ConnectorConfiguration.Builder	isPrivateLinkEnabled(Boolean isPrivateLinkEnabled) Specifies if PrivateLink is enabled for that connector.
ConnectorConfiguration.Builder	isPrivateLinkEndpointUrlRequired(Boolean isPrivateLinkEndpointUrlRequired) Specifies if a PrivateLink endpoint URL is required.
ConnectorConfiguration.Builder	logoURL(String logoURL) Logo URL of the connector.
ConnectorConfiguration.Builder	registeredAt(Instant registeredAt) The date on which the connector was registered.
ConnectorConfiguration.Builder	registeredBy(String registeredBy) Information about who registered the connector.
ConnectorConfiguration.Builder	supportedApiVersions(Collection<String> supportedApiVersions) A list of API versions that are supported by the connector.
ConnectorConfiguration.Builder	supportedApiVersions(String... supportedApiVersions) A list of API versions that are supported by the connector.
ConnectorConfiguration.Builder	supportedDestinationConnectors(Collection<ConnectorType> supportedDestinationConnectors) Lists the connectors that are available for use as destinations.
ConnectorConfiguration.Builder	supportedDestinationConnectors(ConnectorType... supportedDestinationConnectors) Lists the connectors that are available for use as destinations.
ConnectorConfiguration.Builder	supportedDestinationConnectorsWithStrings(Collection<String> supportedDestinationConnectors) Lists the connectors that are available for use as destinations.
ConnectorConfiguration.Builder	supportedDestinationConnectorsWithStrings(String... supportedDestinationConnectors) Lists the connectors that are available for use as destinations.
ConnectorConfiguration.Builder	supportedOperators(Collection<Operators> supportedOperators) A list of operators supported by the connector.
ConnectorConfiguration.Builder	supportedOperators(Operators... supportedOperators) A list of operators supported by the connector.
ConnectorConfiguration.Builder	supportedOperatorsWithStrings(Collection<String> supportedOperators) A list of operators supported by the connector.
ConnectorConfiguration.Builder	supportedOperatorsWithStrings(String... supportedOperators) A list of operators supported by the connector.
ConnectorConfiguration.Builder	supportedSchedulingFrequencies(Collection<ScheduleFrequencyType> supportedSchedulingFrequencies) Specifies the supported flow frequency for that connector.
ConnectorConfiguration.Builder	supportedSchedulingFrequencies(ScheduleFrequencyType... supportedSchedulingFrequencies) Specifies the supported flow frequency for that connector.
ConnectorConfiguration.Builder	supportedSchedulingFrequenciesWithStrings(Collection<String> supportedSchedulingFrequencies) Specifies the supported flow frequency for that connector.
ConnectorConfiguration.Builder	supportedSchedulingFrequenciesWithStrings(String... supportedSchedulingFrequencies) Specifies the supported flow frequency for that connector.
ConnectorConfiguration.Builder	supportedTriggerTypes(Collection<TriggerType> supportedTriggerTypes) Specifies the supported trigger types for the flow.
ConnectorConfiguration.Builder	supportedTriggerTypes(TriggerType... supportedTriggerTypes) Specifies the supported trigger types for the flow.
ConnectorConfiguration.Builder	supportedTriggerTypesWithStrings(Collection<String> supportedTriggerTypes) Specifies the supported trigger types for the flow.
ConnectorConfiguration.Builder	supportedTriggerTypesWithStrings(String... supportedTriggerTypes) Specifies the supported trigger types for the flow.
ConnectorConfiguration.Builder	supportedWriteOperations(Collection<WriteOperationType> supportedWriteOperations) A list of write operations supported by the connector.
ConnectorConfiguration.Builder	supportedWriteOperations(WriteOperationType... supportedWriteOperations) A list of write operations supported by the connector.
ConnectorConfiguration.Builder	supportedWriteOperationsWithStrings(Collection<String> supportedWriteOperations) A list of write operations supported by the connector.
ConnectorConfiguration.Builder	supportedWriteOperationsWithStrings(String... supportedWriteOperations) A list of write operations supported by the connector.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

canUseAsSource

ConnectorConfiguration.Builder canUseAsSource(Boolean canUseAsSource)

Specifies whether the connector can be used as a source.

Parameters:

canUseAsSource - Specifies whether the connector can be used as a source.

Returns:

Returns a reference to this object so that method calls can be chained together.

canUseAsDestination

ConnectorConfiguration.Builder canUseAsDestination(Boolean canUseAsDestination)

Specifies whether the connector can be used as a destination.

Parameters:

canUseAsDestination - Specifies whether the connector can be used as a destination.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedDestinationConnectorsWithStrings

ConnectorConfiguration.Builder supportedDestinationConnectorsWithStrings(Collection<String> supportedDestinationConnectors)

Lists the connectors that are available for use as destinations.

Parameters:

supportedDestinationConnectors - Lists the connectors that are available for use as destinations.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedDestinationConnectorsWithStrings

ConnectorConfiguration.Builder supportedDestinationConnectorsWithStrings(String... supportedDestinationConnectors)

Lists the connectors that are available for use as destinations.

Parameters:

supportedDestinationConnectors - Lists the connectors that are available for use as destinations.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedDestinationConnectors

ConnectorConfiguration.Builder supportedDestinationConnectors(Collection<ConnectorType> supportedDestinationConnectors)

Lists the connectors that are available for use as destinations.

Parameters:

supportedDestinationConnectors - Lists the connectors that are available for use as destinations.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedDestinationConnectors

ConnectorConfiguration.Builder supportedDestinationConnectors(ConnectorType... supportedDestinationConnectors)

Lists the connectors that are available for use as destinations.

Parameters:

supportedDestinationConnectors - Lists the connectors that are available for use as destinations.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedSchedulingFrequenciesWithStrings

ConnectorConfiguration.Builder supportedSchedulingFrequenciesWithStrings(Collection<String> supportedSchedulingFrequencies)

Specifies the supported flow frequency for that connector.

Parameters:

supportedSchedulingFrequencies - Specifies the supported flow frequency for that connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedSchedulingFrequenciesWithStrings

ConnectorConfiguration.Builder supportedSchedulingFrequenciesWithStrings(String... supportedSchedulingFrequencies)

Specifies the supported flow frequency for that connector.

Parameters:

supportedSchedulingFrequencies - Specifies the supported flow frequency for that connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedSchedulingFrequencies

ConnectorConfiguration.Builder supportedSchedulingFrequencies(Collection<ScheduleFrequencyType> supportedSchedulingFrequencies)

Specifies the supported flow frequency for that connector.

Parameters:

supportedSchedulingFrequencies - Specifies the supported flow frequency for that connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedSchedulingFrequencies

ConnectorConfiguration.Builder supportedSchedulingFrequencies(ScheduleFrequencyType... supportedSchedulingFrequencies)

Specifies the supported flow frequency for that connector.

Parameters:

supportedSchedulingFrequencies - Specifies the supported flow frequency for that connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

isPrivateLinkEnabled

ConnectorConfiguration.Builder isPrivateLinkEnabled(Boolean isPrivateLinkEnabled)

Specifies if PrivateLink is enabled for that connector.

Parameters:

isPrivateLinkEnabled - Specifies if PrivateLink is enabled for that connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

isPrivateLinkEndpointUrlRequired

ConnectorConfiguration.Builder isPrivateLinkEndpointUrlRequired(Boolean isPrivateLinkEndpointUrlRequired)

Specifies if a PrivateLink endpoint URL is required.

Parameters:

isPrivateLinkEndpointUrlRequired - Specifies if a PrivateLink endpoint URL is required.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedTriggerTypesWithStrings

ConnectorConfiguration.Builder supportedTriggerTypesWithStrings(Collection<String> supportedTriggerTypes)

Specifies the supported trigger types for the flow.

Parameters:

supportedTriggerTypes - Specifies the supported trigger types for the flow.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedTriggerTypesWithStrings

ConnectorConfiguration.Builder supportedTriggerTypesWithStrings(String... supportedTriggerTypes)

Specifies the supported trigger types for the flow.

Parameters:

supportedTriggerTypes - Specifies the supported trigger types for the flow.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedTriggerTypes

ConnectorConfiguration.Builder supportedTriggerTypes(Collection<TriggerType> supportedTriggerTypes)

Specifies the supported trigger types for the flow.

Parameters:

supportedTriggerTypes - Specifies the supported trigger types for the flow.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedTriggerTypes

ConnectorConfiguration.Builder supportedTriggerTypes(TriggerType... supportedTriggerTypes)

Specifies the supported trigger types for the flow.

Parameters:

supportedTriggerTypes - Specifies the supported trigger types for the flow.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorMetadata

ConnectorConfiguration.Builder connectorMetadata(ConnectorMetadata connectorMetadata)

Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.

Parameters:

connectorMetadata - Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorMetadata

default ConnectorConfiguration.Builder connectorMetadata(Consumer<ConnectorMetadata.Builder> connectorMetadata)

Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.

This is a convenience method that creates an instance of the ConnectorMetadata.Builder avoiding the need to create one manually via ConnectorMetadata.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to connectorMetadata(ConnectorMetadata).

Parameters:

connectorMetadata - a consumer that will call methods on ConnectorMetadata.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

connectorMetadata(ConnectorMetadata)

connectorType

ConnectorConfiguration.Builder connectorType(String connectorType)

The connector type.

Parameters:

connectorType - The connector type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectorType, ConnectorType

connectorType

ConnectorConfiguration.Builder connectorType(ConnectorType connectorType)

The connector type.

Parameters:

connectorType - The connector type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectorType, ConnectorType

connectorLabel

ConnectorConfiguration.Builder connectorLabel(String connectorLabel)

The label used for registering the connector.

Parameters:

connectorLabel - The label used for registering the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorDescription

ConnectorConfiguration.Builder connectorDescription(String connectorDescription)

A description about the connector.

Parameters:

connectorDescription - A description about the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorOwner

ConnectorConfiguration.Builder connectorOwner(String connectorOwner)

The owner who developed the connector.

Parameters:

connectorOwner - The owner who developed the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorName

ConnectorConfiguration.Builder connectorName(String connectorName)

The connector name.

Parameters:

connectorName - The connector name.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorVersion

ConnectorConfiguration.Builder connectorVersion(String connectorVersion)

The connector version.

Parameters:

connectorVersion - The connector version.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorArn

ConnectorConfiguration.Builder connectorArn(String connectorArn)

The Amazon Resource Name (ARN) for the registered connector.

Parameters:

connectorArn - The Amazon Resource Name (ARN) for the registered connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorModes

ConnectorConfiguration.Builder connectorModes(Collection<String> connectorModes)

The connection modes that the connector supports.

Parameters:

connectorModes - The connection modes that the connector supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorModes

ConnectorConfiguration.Builder connectorModes(String... connectorModes)

The connection modes that the connector supports.

Parameters:

connectorModes - The connection modes that the connector supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

authenticationConfig

ConnectorConfiguration.Builder authenticationConfig(AuthenticationConfig authenticationConfig)

The authentication config required for the connector.

Parameters:

authenticationConfig - The authentication config required for the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

authenticationConfig

default ConnectorConfiguration.Builder authenticationConfig(Consumer<AuthenticationConfig.Builder> authenticationConfig)

The authentication config required for the connector.

This is a convenience method that creates an instance of the AuthenticationConfig.Builder avoiding the need to create one manually via AuthenticationConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticationConfig(AuthenticationConfig).

Parameters:

authenticationConfig - a consumer that will call methods on AuthenticationConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

authenticationConfig(AuthenticationConfig)

connectorRuntimeSettings

ConnectorConfiguration.Builder connectorRuntimeSettings(Collection<ConnectorRuntimeSetting> connectorRuntimeSettings)

The required connector runtime settings.

Parameters:

connectorRuntimeSettings - The required connector runtime settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorRuntimeSettings

ConnectorConfiguration.Builder connectorRuntimeSettings(ConnectorRuntimeSetting... connectorRuntimeSettings)

The required connector runtime settings.

Parameters:

connectorRuntimeSettings - The required connector runtime settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorRuntimeSettings

ConnectorConfiguration.Builder connectorRuntimeSettings(Consumer<ConnectorRuntimeSetting.Builder>... connectorRuntimeSettings)

The required connector runtime settings.

This is a convenience method that creates an instance of the ConnectorRuntimeSetting.Builder avoiding the need to create one manually via ConnectorRuntimeSetting.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #connectorRuntimeSettings(List).

Parameters:

connectorRuntimeSettings - a consumer that will call methods on ConnectorRuntimeSetting.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#connectorRuntimeSettings(java.util.Collection)

supportedApiVersions

ConnectorConfiguration.Builder supportedApiVersions(Collection<String> supportedApiVersions)

A list of API versions that are supported by the connector.

Parameters:

supportedApiVersions - A list of API versions that are supported by the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedApiVersions

ConnectorConfiguration.Builder supportedApiVersions(String... supportedApiVersions)

A list of API versions that are supported by the connector.

Parameters:

supportedApiVersions - A list of API versions that are supported by the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedOperatorsWithStrings

ConnectorConfiguration.Builder supportedOperatorsWithStrings(Collection<String> supportedOperators)

A list of operators supported by the connector.

Parameters:

supportedOperators - A list of operators supported by the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedOperatorsWithStrings

ConnectorConfiguration.Builder supportedOperatorsWithStrings(String... supportedOperators)

A list of operators supported by the connector.

Parameters:

supportedOperators - A list of operators supported by the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedOperators

ConnectorConfiguration.Builder supportedOperators(Collection<Operators> supportedOperators)

A list of operators supported by the connector.

Parameters:

supportedOperators - A list of operators supported by the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedOperators

ConnectorConfiguration.Builder supportedOperators(Operators... supportedOperators)

A list of operators supported by the connector.

Parameters:

supportedOperators - A list of operators supported by the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedWriteOperationsWithStrings

ConnectorConfiguration.Builder supportedWriteOperationsWithStrings(Collection<String> supportedWriteOperations)

A list of write operations supported by the connector.

Parameters:

supportedWriteOperations - A list of write operations supported by the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedWriteOperationsWithStrings

ConnectorConfiguration.Builder supportedWriteOperationsWithStrings(String... supportedWriteOperations)

A list of write operations supported by the connector.

Parameters:

supportedWriteOperations - A list of write operations supported by the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedWriteOperations

ConnectorConfiguration.Builder supportedWriteOperations(Collection<WriteOperationType> supportedWriteOperations)

A list of write operations supported by the connector.

Parameters:

supportedWriteOperations - A list of write operations supported by the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedWriteOperations

ConnectorConfiguration.Builder supportedWriteOperations(WriteOperationType... supportedWriteOperations)

A list of write operations supported by the connector.

Parameters:

supportedWriteOperations - A list of write operations supported by the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorProvisioningType

ConnectorConfiguration.Builder connectorProvisioningType(String connectorProvisioningType)

The provisioning type used to register the connector.

Parameters:

connectorProvisioningType - The provisioning type used to register the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectorProvisioningType, ConnectorProvisioningType

connectorProvisioningType

ConnectorConfiguration.Builder connectorProvisioningType(ConnectorProvisioningType connectorProvisioningType)

The provisioning type used to register the connector.

Parameters:

connectorProvisioningType - The provisioning type used to register the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectorProvisioningType, ConnectorProvisioningType

connectorProvisioningConfig

ConnectorConfiguration.Builder connectorProvisioningConfig(ConnectorProvisioningConfig connectorProvisioningConfig)

The configuration required for registering the connector.

Parameters:

connectorProvisioningConfig - The configuration required for registering the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectorProvisioningConfig

default ConnectorConfiguration.Builder connectorProvisioningConfig(Consumer<ConnectorProvisioningConfig.Builder> connectorProvisioningConfig)

The configuration required for registering the connector.

This is a convenience method that creates an instance of the ConnectorProvisioningConfig.Builder avoiding the need to create one manually via ConnectorProvisioningConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to connectorProvisioningConfig(ConnectorProvisioningConfig).

Parameters:

connectorProvisioningConfig - a consumer that will call methods on ConnectorProvisioningConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

connectorProvisioningConfig(ConnectorProvisioningConfig)

logoURL

ConnectorConfiguration.Builder logoURL(String logoURL)

Logo URL of the connector.

Parameters:

logoURL - Logo URL of the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

registeredAt

ConnectorConfiguration.Builder registeredAt(Instant registeredAt)

The date on which the connector was registered.

Parameters:

registeredAt - The date on which the connector was registered.

Returns:

Returns a reference to this object so that method calls can be chained together.

registeredBy

ConnectorConfiguration.Builder registeredBy(String registeredBy)

Information about who registered the connector.

Parameters:

registeredBy - Information about who registered the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.