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.Builder
builder()
final Instant
The time that the integration was created, in UTC.final String
Selects source tables for the integration using Maxwell filter syntax.final String
A description for the integration.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<IntegrationError> errors()
A list of errors associated with the integration.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 AdditionalEncryptionContext property.final boolean
For responses, this returns true if the service returned a value for the Errors property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amazon Resource Name (ARN) for the integration.final IntegrationConfig
Properties associated with the integration.final String
A unique name for the integration.final String
kmsKeyId()
The ARN of a KMS key used for encrypting the channel.static Class
<? extends Integration.Builder> final String
The ARN for the source of the integration.final IntegrationStatus
status()
The possible statuses are:final String
The possible statuses are:tags()
Metadata assigned to the resource consisting of a list of key-value pairs.final String
The ARN for the target of the integration.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
-
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
KMSKeyId
is 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
KMSKeyId
is 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,
status
will 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,
status
will 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
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<Integration.Builder,
Integration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-