software.amazon.awssdk.services.databasemigration.model.ReloadTablesRequest Maven / Gradle / Ivy
Show all versions of databasemigration 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.databasemigration.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
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.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 ReloadTablesRequest extends DatabaseMigrationRequest implements
ToCopyableBuilder {
private static final SdkField REPLICATION_TASK_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReplicationTaskArn").getter(getter(ReloadTablesRequest::replicationTaskArn))
.setter(setter(Builder::replicationTaskArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplicationTaskArn").build())
.build();
private static final SdkField> TABLES_TO_RELOAD_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TablesToReload")
.getter(getter(ReloadTablesRequest::tablesToReload))
.setter(setter(Builder::tablesToReload))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TablesToReload").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(TableToReload::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField RELOAD_OPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReloadOption").getter(getter(ReloadTablesRequest::reloadOptionAsString))
.setter(setter(Builder::reloadOption))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReloadOption").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REPLICATION_TASK_ARN_FIELD,
TABLES_TO_RELOAD_FIELD, RELOAD_OPTION_FIELD));
private final String replicationTaskArn;
private final List tablesToReload;
private final String reloadOption;
private ReloadTablesRequest(BuilderImpl builder) {
super(builder);
this.replicationTaskArn = builder.replicationTaskArn;
this.tablesToReload = builder.tablesToReload;
this.reloadOption = builder.reloadOption;
}
/**
*
* The Amazon Resource Name (ARN) of the replication task.
*
*
* @return The Amazon Resource Name (ARN) of the replication task.
*/
public final String replicationTaskArn() {
return replicationTaskArn;
}
/**
* For responses, this returns true if the service returned a value for the TablesToReload 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 hasTablesToReload() {
return tablesToReload != null && !(tablesToReload instanceof SdkAutoConstructList);
}
/**
*
* The name and schema of the table to be reloaded.
*
*
* 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 #hasTablesToReload} method.
*
*
* @return The name and schema of the table to be reloaded.
*/
public final List tablesToReload() {
return tablesToReload;
}
/**
*
* Options for reload. Specify data-reload to reload the data and re-validate it if validation is
* enabled. Specify validate-only to re-validate the table. This option applies only when validation is
* enabled for the task.
*
*
* Valid values: data-reload, validate-only
*
*
* Default value is data-reload.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #reloadOption} will
* return {@link ReloadOptionValue#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #reloadOptionAsString}.
*
*
* @return Options for reload. Specify data-reload to reload the data and re-validate it if validation
* is enabled. Specify validate-only to re-validate the table. This option applies only when
* validation is enabled for the task.
*
* Valid values: data-reload, validate-only
*
*
* Default value is data-reload.
* @see ReloadOptionValue
*/
public final ReloadOptionValue reloadOption() {
return ReloadOptionValue.fromValue(reloadOption);
}
/**
*
* Options for reload. Specify data-reload to reload the data and re-validate it if validation is
* enabled. Specify validate-only to re-validate the table. This option applies only when validation is
* enabled for the task.
*
*
* Valid values: data-reload, validate-only
*
*
* Default value is data-reload.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #reloadOption} will
* return {@link ReloadOptionValue#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #reloadOptionAsString}.
*
*
* @return Options for reload. Specify data-reload to reload the data and re-validate it if validation
* is enabled. Specify validate-only to re-validate the table. This option applies only when
* validation is enabled for the task.
*
* Valid values: data-reload, validate-only
*
*
* Default value is data-reload.
* @see ReloadOptionValue
*/
public final String reloadOptionAsString() {
return reloadOption;
}
@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(replicationTaskArn());
hashCode = 31 * hashCode + Objects.hashCode(hasTablesToReload() ? tablesToReload() : null);
hashCode = 31 * hashCode + Objects.hashCode(reloadOptionAsString());
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 ReloadTablesRequest)) {
return false;
}
ReloadTablesRequest other = (ReloadTablesRequest) obj;
return Objects.equals(replicationTaskArn(), other.replicationTaskArn())
&& hasTablesToReload() == other.hasTablesToReload() && Objects.equals(tablesToReload(), other.tablesToReload())
&& Objects.equals(reloadOptionAsString(), other.reloadOptionAsString());
}
/**
* 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("ReloadTablesRequest").add("ReplicationTaskArn", replicationTaskArn())
.add("TablesToReload", hasTablesToReload() ? tablesToReload() : null).add("ReloadOption", reloadOptionAsString())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ReplicationTaskArn":
return Optional.ofNullable(clazz.cast(replicationTaskArn()));
case "TablesToReload":
return Optional.ofNullable(clazz.cast(tablesToReload()));
case "ReloadOption":
return Optional.ofNullable(clazz.cast(reloadOptionAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ReloadTablesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DatabaseMigrationRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the replication task.
*
*
* @param replicationTaskArn
* The Amazon Resource Name (ARN) of the replication task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder replicationTaskArn(String replicationTaskArn);
/**
*
* The name and schema of the table to be reloaded.
*
*
* @param tablesToReload
* The name and schema of the table to be reloaded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tablesToReload(Collection tablesToReload);
/**
*
* The name and schema of the table to be reloaded.
*
*
* @param tablesToReload
* The name and schema of the table to be reloaded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tablesToReload(TableToReload... tablesToReload);
/**
*
* The name and schema of the table to be reloaded.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.databasemigration.model.TableToReload.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.databasemigration.model.TableToReload#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.databasemigration.model.TableToReload.Builder#build()} is called
* immediately and its result is passed to {@link #tablesToReload(List)}.
*
* @param tablesToReload
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.databasemigration.model.TableToReload.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tablesToReload(java.util.Collection)
*/
Builder tablesToReload(Consumer... tablesToReload);
/**
*
* Options for reload. Specify data-reload to reload the data and re-validate it if validation is
* enabled. Specify validate-only to re-validate the table. This option applies only when
* validation is enabled for the task.
*
*
* Valid values: data-reload, validate-only
*
*
* Default value is data-reload.
*
*
* @param reloadOption
* Options for reload. Specify data-reload to reload the data and re-validate it if
* validation is enabled. Specify validate-only to re-validate the table. This option
* applies only when validation is enabled for the task.
*
* Valid values: data-reload, validate-only
*
*
* Default value is data-reload.
* @see ReloadOptionValue
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReloadOptionValue
*/
Builder reloadOption(String reloadOption);
/**
*
* Options for reload. Specify data-reload to reload the data and re-validate it if validation is
* enabled. Specify validate-only to re-validate the table. This option applies only when
* validation is enabled for the task.
*
*
* Valid values: data-reload, validate-only
*
*
* Default value is data-reload.
*
*
* @param reloadOption
* Options for reload. Specify data-reload to reload the data and re-validate it if
* validation is enabled. Specify validate-only to re-validate the table. This option
* applies only when validation is enabled for the task.
*
* Valid values: data-reload, validate-only
*
*
* Default value is data-reload.
* @see ReloadOptionValue
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReloadOptionValue
*/
Builder reloadOption(ReloadOptionValue reloadOption);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends DatabaseMigrationRequest.BuilderImpl implements Builder {
private String replicationTaskArn;
private List tablesToReload = DefaultSdkAutoConstructList.getInstance();
private String reloadOption;
private BuilderImpl() {
}
private BuilderImpl(ReloadTablesRequest model) {
super(model);
replicationTaskArn(model.replicationTaskArn);
tablesToReload(model.tablesToReload);
reloadOption(model.reloadOption);
}
public final String getReplicationTaskArn() {
return replicationTaskArn;
}
public final void setReplicationTaskArn(String replicationTaskArn) {
this.replicationTaskArn = replicationTaskArn;
}
@Override
public final Builder replicationTaskArn(String replicationTaskArn) {
this.replicationTaskArn = replicationTaskArn;
return this;
}
public final List getTablesToReload() {
List result = TableListToReloadCopier.copyToBuilder(this.tablesToReload);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTablesToReload(Collection tablesToReload) {
this.tablesToReload = TableListToReloadCopier.copyFromBuilder(tablesToReload);
}
@Override
public final Builder tablesToReload(Collection tablesToReload) {
this.tablesToReload = TableListToReloadCopier.copy(tablesToReload);
return this;
}
@Override
@SafeVarargs
public final Builder tablesToReload(TableToReload... tablesToReload) {
tablesToReload(Arrays.asList(tablesToReload));
return this;
}
@Override
@SafeVarargs
public final Builder tablesToReload(Consumer... tablesToReload) {
tablesToReload(Stream.of(tablesToReload).map(c -> TableToReload.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getReloadOption() {
return reloadOption;
}
public final void setReloadOption(String reloadOption) {
this.reloadOption = reloadOption;
}
@Override
public final Builder reloadOption(String reloadOption) {
this.reloadOption = reloadOption;
return this;
}
@Override
public final Builder reloadOption(ReloadOptionValue reloadOption) {
this.reloadOption(reloadOption == null ? null : reloadOption.toString());
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 ReloadTablesRequest build() {
return new ReloadTablesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}