Class Integration
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Integration.Builder,Integration>
Describes a zero-ETL integration.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionAn optional set of non-secret key–value pairs that contains additional contextual information for encryption.static Integration.Builderbuilder()final InstantThe time that the integration was created, in UTC.final StringSelects source tables for the integration using Maxwell filter syntax.final StringA description for the integration.final booleanfinal booleanequalsBySdkFields(Object obj) final List<IntegrationError>errors()A list of errors associated with the integration.final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the AdditionalEncryptionContext property.final booleanFor responses, this returns true if the service returned a value for the Errors property.final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final StringThe Amazon Resource Name (ARN) for the integration.final IntegrationConfigProperties associated with the integration.final StringA unique name for the integration.final StringkmsKeyId()The ARN of a KMS key used for encrypting the channel.static Class<? extends Integration.Builder>final StringThe ARN for the source of the integration.final IntegrationStatusstatus()The possible statuses are:final StringThe possible statuses are:tags()Metadata assigned to the resource consisting of a list of key-value pairs.final StringThe ARN for the target of the integration.final StringtoString()Returns a string representation of this object.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
sourceArn
The ARN for the source of the integration.
- Returns:
- The ARN for the source of the integration.
-
targetArn
The ARN for the target of the integration.
- Returns:
- The ARN for the target of the integration.
-
description
A description for the integration.
- Returns:
- A description for the integration.
-
integrationName
A unique name for the integration.
- Returns:
- A unique name for the integration.
-
integrationArn
The Amazon Resource Name (ARN) for the integration.
- Returns:
- The Amazon Resource Name (ARN) for the integration.
-
kmsKeyId
The ARN of a KMS key used for encrypting the channel.
- Returns:
- The ARN of a KMS key used for encrypting the channel.
-
hasAdditionalEncryptionContext
public final boolean hasAdditionalEncryptionContext()For responses, this returns true if the service returned a value for the AdditionalEncryptionContext 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. -
additionalEncryptionContext
An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if
KMSKeyIdis provided.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
hasAdditionalEncryptionContext()method.- Returns:
- An optional set of non-secret key–value pairs that contains additional contextual information for
encryption. This can only be provided if
KMSKeyIdis provided.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
Metadata assigned to the resource consisting of a list of key-value pairs.
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
hasTags()method.- Returns:
- Metadata assigned to the resource consisting of a list of key-value pairs.
-
status
The possible statuses are:
-
CREATING: The integration is being created.
-
ACTIVE: The integration creation succeeds.
-
MODIFYING: The integration is being modified.
-
FAILED: The integration creation fails.
-
DELETING: The integration is deleted.
-
SYNCING: The integration is synchronizing.
-
NEEDS_ATTENTION: The integration needs attention, such as synchronization.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnIntegrationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The possible statuses are:
-
CREATING: The integration is being created.
-
ACTIVE: The integration creation succeeds.
-
MODIFYING: The integration is being modified.
-
FAILED: The integration creation fails.
-
DELETING: The integration is deleted.
-
SYNCING: The integration is synchronizing.
-
NEEDS_ATTENTION: The integration needs attention, such as synchronization.
-
- See Also:
-
-
statusAsString
The possible statuses are:
-
CREATING: The integration is being created.
-
ACTIVE: The integration creation succeeds.
-
MODIFYING: The integration is being modified.
-
FAILED: The integration creation fails.
-
DELETING: The integration is deleted.
-
SYNCING: The integration is synchronizing.
-
NEEDS_ATTENTION: The integration needs attention, such as synchronization.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnIntegrationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The possible statuses are:
-
CREATING: The integration is being created.
-
ACTIVE: The integration creation succeeds.
-
MODIFYING: The integration is being modified.
-
FAILED: The integration creation fails.
-
DELETING: The integration is deleted.
-
SYNCING: The integration is synchronizing.
-
NEEDS_ATTENTION: The integration needs attention, such as synchronization.
-
- See Also:
-
-
createTime
The time that the integration was created, in UTC.
- Returns:
- The time that the integration was created, in UTC.
-
integrationConfig
Properties associated with the integration.
- Returns:
- Properties associated with the integration.
-
hasErrors
public final boolean hasErrors()For responses, this returns true if the service returned a value for the Errors 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. -
errors
A list of errors associated with the integration.
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
hasErrors()method.- Returns:
- A list of errors associated with the integration.
-
dataFilter
Selects source tables for the integration using Maxwell filter syntax.
- Returns:
- Selects source tables for the integration using Maxwell filter syntax.
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<Integration.Builder,Integration>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-