Class ConnectorConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.appflow.model.ConnectorConfiguration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ConnectorConfiguration.Builder,ConnectorConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ConnectorConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ConnectorConfiguration.Builder,ConnectorConfiguration>
The configuration settings related to a given connector.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceConnectorConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AuthenticationConfigauthenticationConfig()The authentication config required for the connector.static ConnectorConfiguration.Builderbuilder()BooleancanUseAsDestination()Specifies whether the connector can be used as a destination.BooleancanUseAsSource()Specifies whether the connector can be used as a source.StringconnectorArn()The Amazon Resource Name (ARN) for the registered connector.StringconnectorDescription()A description about the connector.StringconnectorLabel()The label used for registering the connector.ConnectorMetadataconnectorMetadata()Specifies connector-specific metadata such asoAuthScopes,supportedRegions,privateLinkServiceUrl, and so on.List<String>connectorModes()The connection modes that the connector supports.StringconnectorName()The connector name.StringconnectorOwner()The owner who developed the connector.ConnectorProvisioningConfigconnectorProvisioningConfig()The configuration required for registering the connector.ConnectorProvisioningTypeconnectorProvisioningType()The provisioning type used to register the connector.StringconnectorProvisioningTypeAsString()The provisioning type used to register the connector.List<ConnectorRuntimeSetting>connectorRuntimeSettings()The required connector runtime settings.ConnectorTypeconnectorType()The connector type.StringconnectorTypeAsString()The connector type.StringconnectorVersion()The connector version.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasConnectorModes()For responses, this returns true if the service returned a value for the ConnectorModes property.booleanhasConnectorRuntimeSettings()For responses, this returns true if the service returned a value for the ConnectorRuntimeSettings property.inthashCode()booleanhasSupportedApiVersions()For responses, this returns true if the service returned a value for the SupportedApiVersions property.booleanhasSupportedDataTransferApis()For responses, this returns true if the service returned a value for the SupportedDataTransferApis property.booleanhasSupportedDataTransferTypes()For responses, this returns true if the service returned a value for the SupportedDataTransferTypes property.booleanhasSupportedDestinationConnectors()For responses, this returns true if the service returned a value for the SupportedDestinationConnectors property.booleanhasSupportedOperators()For responses, this returns true if the service returned a value for the SupportedOperators property.booleanhasSupportedSchedulingFrequencies()For responses, this returns true if the service returned a value for the SupportedSchedulingFrequencies property.booleanhasSupportedTriggerTypes()For responses, this returns true if the service returned a value for the SupportedTriggerTypes property.booleanhasSupportedWriteOperations()For responses, this returns true if the service returned a value for the SupportedWriteOperations property.BooleanisPrivateLinkEnabled()Specifies if PrivateLink is enabled for that connector.BooleanisPrivateLinkEndpointUrlRequired()Specifies if a PrivateLink endpoint URL is required.StringlogoURL()Logo URL of the connector.InstantregisteredAt()The date on which the connector was registered.StringregisteredBy()Information about who registered the connector.List<SdkField<?>>sdkFields()static Class<? extends ConnectorConfiguration.Builder>serializableBuilderClass()List<String>supportedApiVersions()A list of API versions that are supported by the connector.List<DataTransferApi>supportedDataTransferApis()The APIs of the connector application that Amazon AppFlow can use to transfer your data.List<SupportedDataTransferType>supportedDataTransferTypes()The data transfer types that the connector supports.List<String>supportedDataTransferTypesAsStrings()The data transfer types that the connector supports.List<ConnectorType>supportedDestinationConnectors()Lists the connectors that are available for use as destinations.List<String>supportedDestinationConnectorsAsStrings()Lists the connectors that are available for use as destinations.List<Operators>supportedOperators()A list of operators supported by the connector.List<String>supportedOperatorsAsStrings()A list of operators supported by the connector.List<ScheduleFrequencyType>supportedSchedulingFrequencies()Specifies the supported flow frequency for that connector.List<String>supportedSchedulingFrequenciesAsStrings()Specifies the supported flow frequency for that connector.List<TriggerType>supportedTriggerTypes()Specifies the supported trigger types for the flow.List<String>supportedTriggerTypesAsStrings()Specifies the supported trigger types for the flow.List<WriteOperationType>supportedWriteOperations()A list of write operations supported by the connector.List<String>supportedWriteOperationsAsStrings()A list of write operations supported by the connector.ConnectorConfiguration.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
canUseAsSource
public final Boolean canUseAsSource()
Specifies whether the connector can be used as a source.
- Returns:
- Specifies whether the connector can be used as a source.
-
canUseAsDestination
public final Boolean canUseAsDestination()
Specifies whether the connector can be used as a destination.
- Returns:
- Specifies whether the connector can be used as a destination.
-
supportedDestinationConnectors
public final List<ConnectorType> 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
public final List<String> 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
public final List<ScheduleFrequencyType> 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
public final List<String> 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
public final Boolean isPrivateLinkEnabled()
Specifies if PrivateLink is enabled for that connector.
- Returns:
- Specifies if PrivateLink is enabled for that connector.
-
isPrivateLinkEndpointUrlRequired
public final Boolean isPrivateLinkEndpointUrlRequired()
Specifies if a PrivateLink endpoint URL is required.
- Returns:
- Specifies if a PrivateLink endpoint URL is required.
-
supportedTriggerTypes
public final List<TriggerType> 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
public final List<String> 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
public final ConnectorMetadata 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
public final ConnectorType connectorType()
The connector type.
If the service returns an enum value that is not available in the current SDK version,
connectorTypewill returnConnectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconnectorTypeAsString().- Returns:
- The connector type.
- See Also:
ConnectorType
-
connectorTypeAsString
public final String connectorTypeAsString()
The connector type.
If the service returns an enum value that is not available in the current SDK version,
connectorTypewill returnConnectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconnectorTypeAsString().- Returns:
- The connector type.
- See Also:
ConnectorType
-
connectorLabel
public final String connectorLabel()
The label used for registering the connector.
- Returns:
- The label used for registering the connector.
-
connectorDescription
public final String connectorDescription()
A description about the connector.
- Returns:
- A description about the connector.
-
connectorOwner
public final String connectorOwner()
The owner who developed the connector.
- Returns:
- The owner who developed the connector.
-
connectorName
public final String connectorName()
The connector name.
- Returns:
- The connector name.
-
connectorVersion
public final String connectorVersion()
The connector version.
- Returns:
- The connector version.
-
connectorArn
public final String 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
public final List<String> 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
public final AuthenticationConfig 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
public final List<ConnectorRuntimeSetting> 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
public final List<String> 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
public final List<Operators> 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
public final List<String> 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
public final List<WriteOperationType> 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
public final List<String> 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
public final ConnectorProvisioningType 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,
connectorProvisioningTypewill 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:
ConnectorProvisioningType
-
connectorProvisioningTypeAsString
public final String 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,
connectorProvisioningTypewill 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:
ConnectorProvisioningType
-
connectorProvisioningConfig
public final ConnectorProvisioningConfig connectorProvisioningConfig()
The configuration required for registering the connector.
- Returns:
- The configuration required for registering the connector.
-
logoURL
public final String logoURL()
Logo URL of the connector.
- Returns:
- Logo URL of the connector.
-
registeredAt
public final Instant registeredAt()
The date on which the connector was registered.
- Returns:
- The date on which the connector was registered.
-
registeredBy
public final String registeredBy()
Information about who registered the connector.
- Returns:
- Information about who registered the connector.
-
supportedDataTransferTypes
public final List<SupportedDataTransferType> 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
public final List<String> 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
public final List<DataTransferApi> 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
public ConnectorConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ConnectorConfiguration.Builder,ConnectorConfiguration>
-
builder
public static ConnectorConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends ConnectorConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-