software.amazon.awssdk.services.transfer.model.CopyStepDetails Maven / Gradle / Ivy
/*
* 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.transfer.model;
import java.io.Serializable;
import java.util.Arrays;
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 software.amazon.awssdk.annotations.Generated;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Each step type has its own StepDetails structure.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CopyStepDetails implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CopyStepDetails::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DESTINATION_FILE_LOCATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DestinationFileLocation")
.getter(getter(CopyStepDetails::destinationFileLocation)).setter(setter(Builder::destinationFileLocation))
.constructor(InputFileLocation::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DestinationFileLocation").build())
.build();
private static final SdkField OVERWRITE_EXISTING_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OverwriteExisting").getter(getter(CopyStepDetails::overwriteExistingAsString))
.setter(setter(Builder::overwriteExisting))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OverwriteExisting").build()).build();
private static final SdkField SOURCE_FILE_LOCATION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SourceFileLocation").getter(getter(CopyStepDetails::sourceFileLocation))
.setter(setter(Builder::sourceFileLocation))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceFileLocation").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD,
DESTINATION_FILE_LOCATION_FIELD, OVERWRITE_EXISTING_FIELD, SOURCE_FILE_LOCATION_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final InputFileLocation destinationFileLocation;
private final String overwriteExisting;
private final String sourceFileLocation;
private CopyStepDetails(BuilderImpl builder) {
this.name = builder.name;
this.destinationFileLocation = builder.destinationFileLocation;
this.overwriteExisting = builder.overwriteExisting;
this.sourceFileLocation = builder.sourceFileLocation;
}
/**
*
* The name of the step, used as an identifier.
*
*
* @return The name of the step, used as an identifier.
*/
public final String name() {
return name;
}
/**
*
* Specifies the location for the file being copied. Use ${Transfer:UserName} or
* ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded
* date.
*
*
* -
*
* Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files
* to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.
*
*
* -
*
* Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded
* files to an Amazon S3 bucket that is prefixed with the date of the upload.
*
*
*
* The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file is
* uploaded in UTC.
*
*
*
*
* @return Specifies the location for the file being copied. Use ${Transfer:UserName} or
* ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or
* uploaded date.
*
* -
*
* Set the value of DestinationFileLocation to ${Transfer:UserName} to copy
* uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that
* uploaded the file.
*
*
* -
*
* Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy
* uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.
*
*
*
* The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the
* file is uploaded in UTC.
*
*
*/
public final InputFileLocation destinationFileLocation() {
return destinationFileLocation;
}
/**
*
* A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
*
*
* If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
*
*
* -
*
* If OverwriteExisting is TRUE, the existing file is replaced with the file being
* processed.
*
*
* -
*
* If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #overwriteExisting}
* will return {@link OverwriteExisting#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #overwriteExistingAsString}.
*
*
* @return A flag that indicates whether to overwrite an existing file of the same name. The default is
* FALSE.
*
* If the workflow is processing a file that has the same name as an existing file, the behavior is as
* follows:
*
*
* -
*
* If OverwriteExisting is TRUE, the existing file is replaced with the file being
* processed.
*
*
* -
*
* If OverwriteExisting is FALSE, nothing happens, and the workflow processing
* stops.
*
*
* @see OverwriteExisting
*/
public final OverwriteExisting overwriteExisting() {
return OverwriteExisting.fromValue(overwriteExisting);
}
/**
*
* A flag that indicates whether to overwrite an existing file of the same name. The default is FALSE.
*
*
* If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
*
*
* -
*
* If OverwriteExisting is TRUE, the existing file is replaced with the file being
* processed.
*
*
* -
*
* If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #overwriteExisting}
* will return {@link OverwriteExisting#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #overwriteExistingAsString}.
*
*
* @return A flag that indicates whether to overwrite an existing file of the same name. The default is
* FALSE.
*
* If the workflow is processing a file that has the same name as an existing file, the behavior is as
* follows:
*
*
* -
*
* If OverwriteExisting is TRUE, the existing file is replaced with the file being
* processed.
*
*
* -
*
* If OverwriteExisting is FALSE, nothing happens, and the workflow processing
* stops.
*
*
* @see OverwriteExisting
*/
public final String overwriteExistingAsString() {
return overwriteExisting;
}
/**
*
* Specifies which file to use as input to the workflow step: either the output from the previous step, or the
* originally uploaded file for the workflow.
*
*
* -
*
* To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses
* the output file from the previous workflow step as input. This is the default value.
*
*
* -
*
* To use the originally uploaded file location as input for this step, enter ${original.file}.
*
*
*
*
* @return Specifies which file to use as input to the workflow step: either the output from the previous step, or
* the originally uploaded file for the workflow.
*
* -
*
* To use the previous file as the input, enter ${previous.file}. In this case, this workflow
* step uses the output file from the previous workflow step as input. This is the default value.
*
*
* -
*
* To use the originally uploaded file location as input for this step, enter ${original.file}.
*
*
*/
public final String sourceFileLocation() {
return sourceFileLocation;
}
@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 + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(destinationFileLocation());
hashCode = 31 * hashCode + Objects.hashCode(overwriteExistingAsString());
hashCode = 31 * hashCode + Objects.hashCode(sourceFileLocation());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CopyStepDetails)) {
return false;
}
CopyStepDetails other = (CopyStepDetails) obj;
return Objects.equals(name(), other.name()) && Objects.equals(destinationFileLocation(), other.destinationFileLocation())
&& Objects.equals(overwriteExistingAsString(), other.overwriteExistingAsString())
&& Objects.equals(sourceFileLocation(), other.sourceFileLocation());
}
/**
* 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("CopyStepDetails").add("Name", name()).add("DestinationFileLocation", destinationFileLocation())
.add("OverwriteExisting", overwriteExistingAsString()).add("SourceFileLocation", sourceFileLocation()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "DestinationFileLocation":
return Optional.ofNullable(clazz.cast(destinationFileLocation()));
case "OverwriteExisting":
return Optional.ofNullable(clazz.cast(overwriteExistingAsString()));
case "SourceFileLocation":
return Optional.ofNullable(clazz.cast(sourceFileLocation()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CopyStepDetails) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the step, used as an identifier.
*
*
* @param name
* The name of the step, used as an identifier.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* Specifies the location for the file being copied. Use ${Transfer:UserName} or
* ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or
* uploaded date.
*
*
* -
*
* Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded
* files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the
* file.
*
*
* -
*
* Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded
* files to an Amazon S3 bucket that is prefixed with the date of the upload.
*
*
*
* The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file
* is uploaded in UTC.
*
*
*
*
* @param destinationFileLocation
* Specifies the location for the file being copied. Use ${Transfer:UserName} or
* ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or
* uploaded date.
*
* -
*
* Set the value of DestinationFileLocation to ${Transfer:UserName} to copy
* uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that
* uploaded the file.
*
*
* -
*
* Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy
* uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.
*
*
*
* The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date
* the file is uploaded in UTC.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder destinationFileLocation(InputFileLocation destinationFileLocation);
/**
*
* Specifies the location for the file being copied. Use ${Transfer:UserName} or
* ${Transfer:UploadDate} in this field to parametrize the destination prefix by username or
* uploaded date.
*
*
* -
*
* Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded
* files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the
* file.
*
*
* -
*
* Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded
* files to an Amazon S3 bucket that is prefixed with the date of the upload.
*
*
*
* The system resolves UploadDate to a date format of YYYY-MM-DD, based on the date the file
* is uploaded in UTC.
*
*
*
* This is a convenience method that creates an instance of the {@link InputFileLocation.Builder} avoiding the
* need to create one manually via {@link InputFileLocation#builder()}.
*
*
* When the {@link Consumer} completes, {@link InputFileLocation.Builder#build()} is called immediately and its
* result is passed to {@link #destinationFileLocation(InputFileLocation)}.
*
* @param destinationFileLocation
* a consumer that will call methods on {@link InputFileLocation.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #destinationFileLocation(InputFileLocation)
*/
default Builder destinationFileLocation(Consumer destinationFileLocation) {
return destinationFileLocation(InputFileLocation.builder().applyMutation(destinationFileLocation).build());
}
/**
*
* A flag that indicates whether to overwrite an existing file of the same name. The default is
* FALSE.
*
*
* If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
*
*
* -
*
* If OverwriteExisting is TRUE, the existing file is replaced with the file being
* processed.
*
*
* -
*
* If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
*
*
*
*
* @param overwriteExisting
* A flag that indicates whether to overwrite an existing file of the same name. The default is
* FALSE.
*
* If the workflow is processing a file that has the same name as an existing file, the behavior is as
* follows:
*
*
* -
*
* If OverwriteExisting is TRUE, the existing file is replaced with the file
* being processed.
*
*
* -
*
* If OverwriteExisting is FALSE, nothing happens, and the workflow processing
* stops.
*
*
* @see OverwriteExisting
* @return Returns a reference to this object so that method calls can be chained together.
* @see OverwriteExisting
*/
Builder overwriteExisting(String overwriteExisting);
/**
*
* A flag that indicates whether to overwrite an existing file of the same name. The default is
* FALSE.
*
*
* If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:
*
*
* -
*
* If OverwriteExisting is TRUE, the existing file is replaced with the file being
* processed.
*
*
* -
*
* If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.
*
*
*
*
* @param overwriteExisting
* A flag that indicates whether to overwrite an existing file of the same name. The default is
* FALSE.
*
* If the workflow is processing a file that has the same name as an existing file, the behavior is as
* follows:
*
*
* -
*
* If OverwriteExisting is TRUE, the existing file is replaced with the file
* being processed.
*
*
* -
*
* If OverwriteExisting is FALSE, nothing happens, and the workflow processing
* stops.
*
*
* @see OverwriteExisting
* @return Returns a reference to this object so that method calls can be chained together.
* @see OverwriteExisting
*/
Builder overwriteExisting(OverwriteExisting overwriteExisting);
/**
*
* Specifies which file to use as input to the workflow step: either the output from the previous step, or the
* originally uploaded file for the workflow.
*
*
* -
*
* To use the previous file as the input, enter ${previous.file}. In this case, this workflow step
* uses the output file from the previous workflow step as input. This is the default value.
*
*
* -
*
* To use the originally uploaded file location as input for this step, enter ${original.file}.
*
*
*
*
* @param sourceFileLocation
* Specifies which file to use as input to the workflow step: either the output from the previous step,
* or the originally uploaded file for the workflow.
*
* -
*
* To use the previous file as the input, enter ${previous.file}. In this case, this
* workflow step uses the output file from the previous workflow step as input. This is the default
* value.
*
*
* -
*
* To use the originally uploaded file location as input for this step, enter
* ${original.file}.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceFileLocation(String sourceFileLocation);
}
static final class BuilderImpl implements Builder {
private String name;
private InputFileLocation destinationFileLocation;
private String overwriteExisting;
private String sourceFileLocation;
private BuilderImpl() {
}
private BuilderImpl(CopyStepDetails model) {
name(model.name);
destinationFileLocation(model.destinationFileLocation);
overwriteExisting(model.overwriteExisting);
sourceFileLocation(model.sourceFileLocation);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final InputFileLocation.Builder getDestinationFileLocation() {
return destinationFileLocation != null ? destinationFileLocation.toBuilder() : null;
}
public final void setDestinationFileLocation(InputFileLocation.BuilderImpl destinationFileLocation) {
this.destinationFileLocation = destinationFileLocation != null ? destinationFileLocation.build() : null;
}
@Override
public final Builder destinationFileLocation(InputFileLocation destinationFileLocation) {
this.destinationFileLocation = destinationFileLocation;
return this;
}
public final String getOverwriteExisting() {
return overwriteExisting;
}
public final void setOverwriteExisting(String overwriteExisting) {
this.overwriteExisting = overwriteExisting;
}
@Override
public final Builder overwriteExisting(String overwriteExisting) {
this.overwriteExisting = overwriteExisting;
return this;
}
@Override
public final Builder overwriteExisting(OverwriteExisting overwriteExisting) {
this.overwriteExisting(overwriteExisting == null ? null : overwriteExisting.toString());
return this;
}
public final String getSourceFileLocation() {
return sourceFileLocation;
}
public final void setSourceFileLocation(String sourceFileLocation) {
this.sourceFileLocation = sourceFileLocation;
}
@Override
public final Builder sourceFileLocation(String sourceFileLocation) {
this.sourceFileLocation = sourceFileLocation;
return this;
}
@Override
public CopyStepDetails build() {
return new CopyStepDetails(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}