@Generated(value="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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ConnectorConfiguration.Builder |
| Modifier and Type | Method and Description |
|---|---|
AuthenticationConfig |
authenticationConfig()
The authentication config required for the connector.
|
static ConnectorConfiguration.Builder |
builder() |
Boolean |
canUseAsDestination()
Specifies whether the connector can be used as a destination.
|
Boolean |
canUseAsSource()
Specifies whether the connector can be used as a source.
|
String |
connectorArn()
The Amazon Resource Name (ARN) for the registered connector.
|
String |
connectorDescription()
A description about the connector.
|
String |
connectorLabel()
The label used for registering the connector.
|
ConnectorMetadata |
connectorMetadata()
Specifies connector-specific metadata such as
oAuthScopes, supportedRegions,
privateLinkServiceUrl, and so on. |
List<String> |
connectorModes()
The connection modes that the connector supports.
|
String |
connectorName()
The connector name.
|
String |
connectorOwner()
The owner who developed the connector.
|
ConnectorProvisioningConfig |
connectorProvisioningConfig()
The configuration required for registering the connector.
|
ConnectorProvisioningType |
connectorProvisioningType()
The provisioning type used to register the connector.
|
String |
connectorProvisioningTypeAsString()
The provisioning type used to register the connector.
|
List<ConnectorRuntimeSetting> |
connectorRuntimeSettings()
The required connector runtime settings.
|
ConnectorType |
connectorType()
The connector type.
|
String |
connectorTypeAsString()
The connector type.
|
String |
connectorVersion()
The connector version.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasConnectorModes()
For responses, this returns true if the service returned a value for the ConnectorModes property.
|
boolean |
hasConnectorRuntimeSettings()
For responses, this returns true if the service returned a value for the ConnectorRuntimeSettings property.
|
int |
hashCode() |
boolean |
hasSupportedApiVersions()
For responses, this returns true if the service returned a value for the SupportedApiVersions property.
|
boolean |
hasSupportedDataTransferApis()
For responses, this returns true if the service returned a value for the SupportedDataTransferApis property.
|
boolean |
hasSupportedDataTransferTypes()
For responses, this returns true if the service returned a value for the SupportedDataTransferTypes property.
|
boolean |
hasSupportedDestinationConnectors()
For responses, this returns true if the service returned a value for the SupportedDestinationConnectors property.
|
boolean |
hasSupportedOperators()
For responses, this returns true if the service returned a value for the SupportedOperators property.
|
boolean |
hasSupportedSchedulingFrequencies()
For responses, this returns true if the service returned a value for the SupportedSchedulingFrequencies property.
|
boolean |
hasSupportedTriggerTypes()
For responses, this returns true if the service returned a value for the SupportedTriggerTypes property.
|
boolean |
hasSupportedWriteOperations()
For responses, this returns true if the service returned a value for the SupportedWriteOperations property.
|
Boolean |
isPrivateLinkEnabled()
Specifies if PrivateLink is enabled for that connector.
|
Boolean |
isPrivateLinkEndpointUrlRequired()
Specifies if a PrivateLink endpoint URL is required.
|
String |
logoURL()
Logo URL of the connector.
|
Instant |
registeredAt()
The date on which the connector was registered.
|
String |
registeredBy()
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.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final Boolean canUseAsSource()
Specifies whether the connector can be used as a source.
public final Boolean canUseAsDestination()
Specifies whether the connector can be used as a destination.
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.
public final boolean hasSupportedDestinationConnectors()
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.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.
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.
public final boolean hasSupportedSchedulingFrequencies()
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.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.
public final Boolean isPrivateLinkEnabled()
Specifies if PrivateLink is enabled for that connector.
public final Boolean isPrivateLinkEndpointUrlRequired()
Specifies if a PrivateLink endpoint URL is required.
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.
public final boolean hasSupportedTriggerTypes()
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.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.
public final ConnectorMetadata connectorMetadata()
Specifies connector-specific metadata such as oAuthScopes, supportedRegions,
privateLinkServiceUrl, and so on.
oAuthScopes, supportedRegions,
privateLinkServiceUrl, and so on.public final ConnectorType connectorType()
The connector type.
If the service returns an enum value that is not available in the current SDK version, connectorType
will return ConnectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
connectorTypeAsString().
ConnectorTypepublic final String connectorTypeAsString()
The connector type.
If the service returns an enum value that is not available in the current SDK version, connectorType
will return ConnectorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
connectorTypeAsString().
ConnectorTypepublic final String connectorLabel()
The label used for registering the connector.
public final String connectorDescription()
A description about the connector.
public final String connectorOwner()
The owner who developed the connector.
public final String connectorName()
The connector name.
public final String connectorVersion()
The connector version.
public final String connectorArn()
The Amazon Resource Name (ARN) for the registered connector.
public final boolean hasConnectorModes()
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.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.
public final AuthenticationConfig authenticationConfig()
The authentication config required for the connector.
public final boolean hasConnectorRuntimeSettings()
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.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.
public final boolean hasSupportedApiVersions()
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.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.
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.
public final boolean hasSupportedOperators()
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.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.
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.
public final boolean hasSupportedWriteOperations()
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.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.
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,
connectorProvisioningType will return ConnectorProvisioningType.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from connectorProvisioningTypeAsString().
ConnectorProvisioningTypepublic 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,
connectorProvisioningType will return ConnectorProvisioningType.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from connectorProvisioningTypeAsString().
ConnectorProvisioningTypepublic final ConnectorProvisioningConfig connectorProvisioningConfig()
The configuration required for registering the connector.
public final String logoURL()
Logo URL of the connector.
public final Instant registeredAt()
The date on which the connector was registered.
public final String registeredBy()
Information about who registered the connector.
public final List<SupportedDataTransferType> supportedDataTransferTypes()
The data transfer types that the connector supports.
Structured records.
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.
Structured records.
Files or binary data.
public final boolean hasSupportedDataTransferTypes()
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.public final List<String> supportedDataTransferTypesAsStrings()
The data transfer types that the connector supports.
Structured records.
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.
Structured records.
Files or binary data.
public final boolean hasSupportedDataTransferApis()
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.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.
public ConnectorConfiguration.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ConnectorConfiguration.Builder,ConnectorConfiguration>public static ConnectorConfiguration.Builder builder()
public static Class<? extends ConnectorConfiguration.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.