Class ConnectorConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ConnectorConfiguration.Builder,
ConnectorConfiguration>
The configuration settings related to a given connector.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AuthenticationConfig
The authentication config required for the connector.builder()
final Boolean
Specifies whether the connector can be used as a destination.final Boolean
Specifies whether the connector can be used as a source.final String
The Amazon Resource Name (ARN) for the registered connector.final String
A description about the connector.final String
The label used for registering the connector.final ConnectorMetadata
Specifies connector-specific metadata such asoAuthScopes
,supportedRegions
,privateLinkServiceUrl
, and so on.The connection modes that the connector supports.final String
The connector name.final String
The owner who developed the connector.The configuration required for registering the connector.The provisioning type used to register the connector.final String
The provisioning type used to register the connector.final List
<ConnectorRuntimeSetting> The required connector runtime settings.final ConnectorType
The connector type.final String
The connector type.final String
The connector version.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ConnectorModes property.final boolean
For responses, this returns true if the service returned a value for the ConnectorRuntimeSettings property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupportedApiVersions property.final boolean
For responses, this returns true if the service returned a value for the SupportedDataTransferApis property.final boolean
For responses, this returns true if the service returned a value for the SupportedDataTransferTypes property.final boolean
For responses, this returns true if the service returned a value for the SupportedDestinationConnectors property.final boolean
For responses, this returns true if the service returned a value for the SupportedOperators property.final boolean
For responses, this returns true if the service returned a value for the SupportedSchedulingFrequencies property.final boolean
For responses, this returns true if the service returned a value for the SupportedTriggerTypes property.final boolean
For responses, this returns true if the service returned a value for the SupportedWriteOperations property.final Boolean
Specifies if PrivateLink is enabled for that connector.final Boolean
Specifies if a PrivateLink endpoint URL is required.final String
logoURL()
Logo URL of the connector.final Instant
The date on which the connector was registered.final String
Information about who registered the connector.static Class
<? extends ConnectorConfiguration.Builder> A list of API versions that are supported by the connector.final List
<DataTransferApi> The APIs of the connector application that Amazon AppFlow can use to transfer your data.final List
<SupportedDataTransferType> The data transfer types that the connector supports.The data transfer types that the connector supports.final List
<ConnectorType> Lists the connectors that are available for use as destinations.Lists the connectors that are available for use as destinations.A list of operators supported by the connector.A list of operators supported by the connector.final List
<ScheduleFrequencyType> Specifies the supported flow frequency for that connector.Specifies the supported flow frequency for that connector.final List
<TriggerType> Specifies the supported trigger types for the flow.Specifies the supported trigger types for the flow.final List
<WriteOperationType> A list of write operations supported by the connector.A list of write operations supported by the connector.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
canUseAsSource
Specifies whether the connector can be used as a source.
- Returns:
- Specifies whether the connector can be used as a source.
-
canUseAsDestination
Specifies whether the connector can be used as a destination.
- Returns:
- Specifies whether the connector can be used as a destination.
-
supportedDestinationConnectors
Lists the connectors that are available for use as destinations.
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
hasSupportedDestinationConnectors()
method.- Returns:
- Lists the connectors that are available for use as destinations.
-
hasSupportedDestinationConnectors
public final boolean hasSupportedDestinationConnectors()For responses, this returns true if the service returned a value for the SupportedDestinationConnectors property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
supportedDestinationConnectorsAsStrings
Lists the connectors that are available for use as destinations.
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
hasSupportedDestinationConnectors()
method.- Returns:
- Lists the connectors that are available for use as destinations.
-
supportedSchedulingFrequencies
Specifies the supported flow frequency for that connector.
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
hasSupportedSchedulingFrequencies()
method.- Returns:
- Specifies the supported flow frequency for that connector.
-
hasSupportedSchedulingFrequencies
public final boolean hasSupportedSchedulingFrequencies()For responses, this returns true if the service returned a value for the SupportedSchedulingFrequencies property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
supportedSchedulingFrequenciesAsStrings
Specifies the supported flow frequency for that connector.
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
hasSupportedSchedulingFrequencies()
method.- Returns:
- Specifies the supported flow frequency for that connector.
-
isPrivateLinkEnabled
Specifies if PrivateLink is enabled for that connector.
- Returns:
- Specifies if PrivateLink is enabled for that connector.
-
isPrivateLinkEndpointUrlRequired
Specifies if a PrivateLink endpoint URL is required.
- Returns:
- Specifies if a PrivateLink endpoint URL is required.
-
supportedTriggerTypes
Specifies the supported trigger types for 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
hasSupportedTriggerTypes()
method.- Returns:
- Specifies the supported trigger types for the flow.
-
hasSupportedTriggerTypes
public final boolean hasSupportedTriggerTypes()For responses, this returns true if the service returned a value for the SupportedTriggerTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
supportedTriggerTypesAsStrings
Specifies the supported trigger types for 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
hasSupportedTriggerTypes()
method.- Returns:
- Specifies the supported trigger types for the flow.
-
connectorMetadata
Specifies connector-specific metadata such as
oAuthScopes
,supportedRegions
,privateLinkServiceUrl
, and so on.- Returns:
- Specifies connector-specific metadata such as
oAuthScopes
,supportedRegions
,privateLinkServiceUrl
, and so on.
-
connectorType
The connector type.
If the service returns an enum value that is not available in the current SDK version,
connectorType
will returnConnectorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectorTypeAsString()
.- Returns:
- The connector type.
- See Also:
-
connectorTypeAsString
The connector type.
If the service returns an enum value that is not available in the current SDK version,
connectorType
will returnConnectorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectorTypeAsString()
.- Returns:
- The connector type.
- See Also:
-
connectorLabel
The label used for registering the connector.
- Returns:
- The label used for registering the connector.
-
connectorDescription
A description about the connector.
- Returns:
- A description about the connector.
-
connectorOwner
The owner who developed the connector.
- Returns:
- The owner who developed the connector.
-
connectorName
The connector name.
- Returns:
- The connector name.
-
connectorVersion
The connector version.
- Returns:
- The connector version.
-
connectorArn
The Amazon Resource Name (ARN) for the registered connector.
- Returns:
- The Amazon Resource Name (ARN) for the registered connector.
-
hasConnectorModes
public final boolean hasConnectorModes()For responses, this returns true if the service returned a value for the ConnectorModes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
connectorModes
The connection modes that the connector supports.
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
hasConnectorModes()
method.- Returns:
- The connection modes that the connector supports.
-
authenticationConfig
The authentication config required for the connector.
- Returns:
- The authentication config required for the connector.
-
hasConnectorRuntimeSettings
public final boolean hasConnectorRuntimeSettings()For responses, this returns true if the service returned a value for the ConnectorRuntimeSettings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
connectorRuntimeSettings
The required connector runtime settings.
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
hasConnectorRuntimeSettings()
method.- Returns:
- The required connector runtime settings.
-
hasSupportedApiVersions
public final boolean hasSupportedApiVersions()For responses, this returns true if the service returned a value for the SupportedApiVersions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
supportedApiVersions
A list of API versions that are supported by the connector.
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
hasSupportedApiVersions()
method.- Returns:
- A list of API versions that are supported by the connector.
-
supportedOperators
A list of operators supported by the connector.
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
hasSupportedOperators()
method.- Returns:
- A list of operators supported by the connector.
-
hasSupportedOperators
public final boolean hasSupportedOperators()For responses, this returns true if the service returned a value for the SupportedOperators property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
supportedOperatorsAsStrings
A list of operators supported by the connector.
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
hasSupportedOperators()
method.- Returns:
- A list of operators supported by the connector.
-
supportedWriteOperations
A list of write operations supported by the connector.
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 write operations supported by the connector.
-
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 theisEmpty()
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
A list of write operations supported by the connector.
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 write operations supported by the connector.
-
connectorProvisioningType
The provisioning type used to register the connector.
If the service returns an enum value that is not available in the current SDK version,
connectorProvisioningType
will returnConnectorProvisioningType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectorProvisioningTypeAsString()
.- Returns:
- The provisioning type used to register the connector.
- See Also:
-
connectorProvisioningTypeAsString
The provisioning type used to register the connector.
If the service returns an enum value that is not available in the current SDK version,
connectorProvisioningType
will returnConnectorProvisioningType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectorProvisioningTypeAsString()
.- Returns:
- The provisioning type used to register the connector.
- See Also:
-
connectorProvisioningConfig
The configuration required for registering the connector.
- Returns:
- The configuration required for registering the connector.
-
logoURL
Logo URL of the connector.
- Returns:
- Logo URL of the connector.
-
registeredAt
The date on which the connector was registered.
- Returns:
- The date on which the connector was registered.
-
registeredBy
Information about who registered the connector.
- Returns:
- Information about who registered the connector.
-
supportedDataTransferTypes
The data transfer types that the connector supports.
- RECORD
-
Structured records.
- FILE
-
Files or binary data.
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
hasSupportedDataTransferTypes()
method.- Returns:
- The data transfer types that the connector supports.
- RECORD
-
Structured records.
- FILE
-
Files or binary data.
-
hasSupportedDataTransferTypes
public final boolean hasSupportedDataTransferTypes()For responses, this returns true if the service returned a value for the SupportedDataTransferTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
supportedDataTransferTypesAsStrings
The data transfer types that the connector supports.
- RECORD
-
Structured records.
- FILE
-
Files or binary data.
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
hasSupportedDataTransferTypes()
method.- Returns:
- The data transfer types that the connector supports.
- RECORD
-
Structured records.
- FILE
-
Files or binary data.
-
hasSupportedDataTransferApis
public final boolean hasSupportedDataTransferApis()For responses, this returns true if the service returned a value for the SupportedDataTransferApis property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
supportedDataTransferApis
The APIs of the connector application that Amazon AppFlow can use to transfer your data.
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
hasSupportedDataTransferApis()
method.- Returns:
- The APIs of the connector application that Amazon AppFlow can use to transfer your data.
-
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 interfaceToCopyableBuilder<ConnectorConfiguration.Builder,
ConnectorConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-