Package software.amazon.awssdk.services.transfer.model

Class TagStepDetails

java.lang.Object

software.amazon.awssdk.services.transfer.model.TagStepDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TagStepDetails.Builder,TagStepDetails>

@Generated("software.amazon.awssdk:codegen")
public final class TagStepDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TagStepDetails.Builder,TagStepDetails>

Each step type has its own StepDetails structure.

The key/value pairs used to tag a file during the execution of a workflow step.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TagStepDetails.Builder

Method Summary

Modifier and Type	Method	Description
static TagStepDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	The name of the step, used as an identifier.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TagStepDetails.Builder>	serializableBuilderClass()
String	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.
List<S3Tag>	tags()	Array that contains from 1 to 10 key/value pairs.
TagStepDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the step, used as an identifier.

Returns:

The name of the step, used as an identifier.

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 the 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.

tags

public final List<S3Tag> tags()

Array that contains from 1 to 10 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:

Array that contains from 1 to 10 key/value pairs.

sourceFileLocation

public final String 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}.

Returns:

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}.

toBuilder

public TagStepDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TagStepDetails.Builder,TagStepDetails>

builder

public static TagStepDetails.Builder builder()

serializableBuilderClass

public static Class<? extends TagStepDetails.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo