software.amazon.awssdk.services.rds.model.CreateIntegrationRequest Maven / Gradle / Ivy
Show all versions of rds Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.rds.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateIntegrationRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField SOURCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SourceArn").getter(getter(CreateIntegrationRequest::sourceArn)).setter(setter(Builder::sourceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceArn").build()).build();
private static final SdkField TARGET_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TargetArn").getter(getter(CreateIntegrationRequest::targetArn)).setter(setter(Builder::targetArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetArn").build()).build();
private static final SdkField INTEGRATION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("IntegrationName").getter(getter(CreateIntegrationRequest::integrationName))
.setter(setter(Builder::integrationName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IntegrationName").build()).build();
private static final SdkField KMS_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KMSKeyId").getter(getter(CreateIntegrationRequest::kmsKeyId)).setter(setter(Builder::kmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KMSKeyId").build()).build();
private static final SdkField> ADDITIONAL_ENCRYPTION_CONTEXT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("AdditionalEncryptionContext")
.getter(getter(CreateIntegrationRequest::additionalEncryptionContext))
.setter(setter(Builder::additionalEncryptionContext))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AdditionalEncryptionContext")
.build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateIntegrationRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName("Tag")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Tag").build()).build()).build()).build();
private static final SdkField DATA_FILTER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DataFilter").getter(getter(CreateIntegrationRequest::dataFilter)).setter(setter(Builder::dataFilter))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataFilter").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateIntegrationRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SOURCE_ARN_FIELD,
TARGET_ARN_FIELD, INTEGRATION_NAME_FIELD, KMS_KEY_ID_FIELD, ADDITIONAL_ENCRYPTION_CONTEXT_FIELD, TAGS_FIELD,
DATA_FILTER_FIELD, DESCRIPTION_FIELD));
private final String sourceArn;
private final String targetArn;
private final String integrationName;
private final String kmsKeyId;
private final Map additionalEncryptionContext;
private final List tags;
private final String dataFilter;
private final String description;
private CreateIntegrationRequest(BuilderImpl builder) {
super(builder);
this.sourceArn = builder.sourceArn;
this.targetArn = builder.targetArn;
this.integrationName = builder.integrationName;
this.kmsKeyId = builder.kmsKeyId;
this.additionalEncryptionContext = builder.additionalEncryptionContext;
this.tags = builder.tags;
this.dataFilter = builder.dataFilter;
this.description = builder.description;
}
/**
*
* The Amazon Resource Name (ARN) of the database to use as the source for replication.
*
*
* @return The Amazon Resource Name (ARN) of the database to use as the source for replication.
*/
public final String sourceArn() {
return sourceArn;
}
/**
*
* The ARN of the Redshift data warehouse to use as the target for replication.
*
*
* @return The ARN of the Redshift data warehouse to use as the target for replication.
*/
public final String targetArn() {
return targetArn;
}
/**
*
* The name of the integration.
*
*
* @return The name of the integration.
*/
public final String integrationName() {
return integrationName;
}
/**
*
* The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to
* encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned
* key.
*
*
* @return The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use
* to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web
* Services owned key.
*/
public final String kmsKeyId() {
return kmsKeyId;
}
/**
* 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 the {@code 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 boolean hasAdditionalEncryptionContext() {
return additionalEncryptionContext != null && !(additionalEncryptionContext instanceof SdkAutoConstructMap);
}
/**
*
* An optional set of non-secret key–value pairs that contains additional contextual information about the data. For
* more information, see Encryption context
* in the Amazon Web Services Key Management Service Developer Guide.
*
*
* You can only include this parameter if you specify the KMSKeyId parameter.
*
*
* 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 {@link #hasAdditionalEncryptionContext} method.
*
*
* @return An optional set of non-secret key–value pairs that contains additional contextual information about the
* data. For more information, see Encryption
* context in the Amazon Web Services Key Management Service Developer Guide.
*
* You can only include this parameter if you specify the KMSKeyId parameter.
*/
public final Map additionalEncryptionContext() {
return additionalEncryptionContext;
}
/**
* 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 the {@code 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 boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
* Returns the value of the Tags property for this object.
*
* 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 {@link #hasTags} method.
*
*
* @return The value of the Tags property for this object.
*/
public final List tags() {
return tags;
}
/**
*
* Data filtering options for the integration. For more information, see Data filtering for
* Aurora zero-ETL integrations with Amazon Redshift.
*
*
* Valid for: Integrations with Aurora MySQL source DB clusters only
*
*
* @return Data filtering options for the integration. For more information, see Data
* filtering for Aurora zero-ETL integrations with Amazon Redshift.
*
* Valid for: Integrations with Aurora MySQL source DB clusters only
*/
public final String dataFilter() {
return dataFilter;
}
/**
*
* A description of the integration.
*
*
* @return A description of the integration.
*/
public final String description() {
return description;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(sourceArn());
hashCode = 31 * hashCode + Objects.hashCode(targetArn());
hashCode = 31 * hashCode + Objects.hashCode(integrationName());
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyId());
hashCode = 31 * hashCode + Objects.hashCode(hasAdditionalEncryptionContext() ? additionalEncryptionContext() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(dataFilter());
hashCode = 31 * hashCode + Objects.hashCode(description());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateIntegrationRequest)) {
return false;
}
CreateIntegrationRequest other = (CreateIntegrationRequest) obj;
return Objects.equals(sourceArn(), other.sourceArn()) && Objects.equals(targetArn(), other.targetArn())
&& Objects.equals(integrationName(), other.integrationName()) && Objects.equals(kmsKeyId(), other.kmsKeyId())
&& hasAdditionalEncryptionContext() == other.hasAdditionalEncryptionContext()
&& Objects.equals(additionalEncryptionContext(), other.additionalEncryptionContext())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags())
&& Objects.equals(dataFilter(), other.dataFilter()) && Objects.equals(description(), other.description());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreateIntegrationRequest").add("SourceArn", sourceArn()).add("TargetArn", targetArn())
.add("IntegrationName", integrationName()).add("KMSKeyId", kmsKeyId())
.add("AdditionalEncryptionContext", hasAdditionalEncryptionContext() ? additionalEncryptionContext() : null)
.add("Tags", hasTags() ? tags() : null).add("DataFilter", dataFilter()).add("Description", description()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SourceArn":
return Optional.ofNullable(clazz.cast(sourceArn()));
case "TargetArn":
return Optional.ofNullable(clazz.cast(targetArn()));
case "IntegrationName":
return Optional.ofNullable(clazz.cast(integrationName()));
case "KMSKeyId":
return Optional.ofNullable(clazz.cast(kmsKeyId()));
case "AdditionalEncryptionContext":
return Optional.ofNullable(clazz.cast(additionalEncryptionContext()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "DataFilter":
return Optional.ofNullable(clazz.cast(dataFilter()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateIntegrationRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the database to use as the source for replication.
*
*
* @param sourceArn
* The Amazon Resource Name (ARN) of the database to use as the source for replication.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceArn(String sourceArn);
/**
*
* The ARN of the Redshift data warehouse to use as the target for replication.
*
*
* @param targetArn
* The ARN of the Redshift data warehouse to use as the target for replication.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetArn(String targetArn);
/**
*
* The name of the integration.
*
*
* @param integrationName
* The name of the integration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder integrationName(String integrationName);
/**
*
* The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to
* encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned
* key.
*
*
* @param kmsKeyId
* The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to
* use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web
* Services owned key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKeyId(String kmsKeyId);
/**
*
* An optional set of non-secret key–value pairs that contains additional contextual information about the data.
* For more information, see Encryption
* context in the Amazon Web Services Key Management Service Developer Guide.
*
*
* You can only include this parameter if you specify the KMSKeyId parameter.
*
*
* @param additionalEncryptionContext
* An optional set of non-secret key–value pairs that contains additional contextual information about
* the data. For more information, see Encryption
* context in the Amazon Web Services Key Management Service Developer Guide.
*
* You can only include this parameter if you specify the KMSKeyId parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder additionalEncryptionContext(Map additionalEncryptionContext);
/**
* Sets the value of the Tags property for this object.
*
* @param tags
* The new value for the Tags property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
* Sets the value of the Tags property for this object.
*
* @param tags
* The new value for the Tags property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
* Sets the value of the Tags property for this object.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.rds.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.rds.model.Tag.Builder#build()} is
* called immediately and its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link software.amazon.awssdk.services.rds.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
/**
*
* Data filtering options for the integration. For more information, see Data filtering
* for Aurora zero-ETL integrations with Amazon Redshift.
*
*
* Valid for: Integrations with Aurora MySQL source DB clusters only
*
*
* @param dataFilter
* Data filtering options for the integration. For more information, see Data
* filtering for Aurora zero-ETL integrations with Amazon Redshift.
*
* Valid for: Integrations with Aurora MySQL source DB clusters only
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataFilter(String dataFilter);
/**
*
* A description of the integration.
*
*
* @param description
* A description of the integration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String sourceArn;
private String targetArn;
private String integrationName;
private String kmsKeyId;
private Map additionalEncryptionContext = DefaultSdkAutoConstructMap.getInstance();
private List tags = DefaultSdkAutoConstructList.getInstance();
private String dataFilter;
private String description;
private BuilderImpl() {
}
private BuilderImpl(CreateIntegrationRequest model) {
super(model);
sourceArn(model.sourceArn);
targetArn(model.targetArn);
integrationName(model.integrationName);
kmsKeyId(model.kmsKeyId);
additionalEncryptionContext(model.additionalEncryptionContext);
tags(model.tags);
dataFilter(model.dataFilter);
description(model.description);
}
public final String getSourceArn() {
return sourceArn;
}
public final void setSourceArn(String sourceArn) {
this.sourceArn = sourceArn;
}
@Override
public final Builder sourceArn(String sourceArn) {
this.sourceArn = sourceArn;
return this;
}
public final String getTargetArn() {
return targetArn;
}
public final void setTargetArn(String targetArn) {
this.targetArn = targetArn;
}
@Override
public final Builder targetArn(String targetArn) {
this.targetArn = targetArn;
return this;
}
public final String getIntegrationName() {
return integrationName;
}
public final void setIntegrationName(String integrationName) {
this.integrationName = integrationName;
}
@Override
public final Builder integrationName(String integrationName) {
this.integrationName = integrationName;
return this;
}
public final String getKmsKeyId() {
return kmsKeyId;
}
public final void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
@Override
public final Builder kmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
return this;
}
public final Map getAdditionalEncryptionContext() {
if (additionalEncryptionContext instanceof SdkAutoConstructMap) {
return null;
}
return additionalEncryptionContext;
}
public final void setAdditionalEncryptionContext(Map additionalEncryptionContext) {
this.additionalEncryptionContext = EncryptionContextMapCopier.copy(additionalEncryptionContext);
}
@Override
public final Builder additionalEncryptionContext(Map additionalEncryptionContext) {
this.additionalEncryptionContext = EncryptionContextMapCopier.copy(additionalEncryptionContext);
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getDataFilter() {
return dataFilter;
}
public final void setDataFilter(String dataFilter) {
this.dataFilter = dataFilter;
}
@Override
public final Builder dataFilter(String dataFilter) {
this.dataFilter = dataFilter;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateIntegrationRequest build() {
return new CreateIntegrationRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}