software.amazon.awssdk.services.datasync.model

Class CreateTaskRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datasync.model.DataSyncRequest

software.amazon.awssdk.services.datasync.model.CreateTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateTaskRequest
extends DataSyncRequest
implements ToCopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>

CreateTaskRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTaskRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateTaskRequest.Builder	builder()
String	cloudWatchLogGroupArn() The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
String	destinationLocationArn() The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
List<FilterRule>	excludes() A list of filter rules that determines which files to exclude from a task.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasExcludes() For responses, this returns true if the service returned a value for the Excludes property.
int	hashCode()
boolean	hasIncludes() For responses, this returns true if the service returned a value for the Includes property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<FilterRule>	includes() A list of filter rules that determines which files to include when running a task.
String	name() The name of a task.
Options	options() The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution.
TaskSchedule	schedule() Specifies a schedule used to periodically transfer files from a source to a destination location.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTaskRequest.Builder>	serializableBuilderClass()
String	sourceLocationArn() The Amazon Resource Name (ARN) of the source location for the task.
List<TagListEntry>	tags() The key-value pair that represents the tag that you want to add to the resource.
CreateTaskRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

sourceLocationArn

public final String sourceLocationArn()

The Amazon Resource Name (ARN) of the source location for the task.

Returns:

The Amazon Resource Name (ARN) of the source location for the task.

destinationLocationArn

public final String destinationLocationArn()

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

Returns:

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

cloudWatchLogGroupArn

public final String cloudWatchLogGroupArn()

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

Returns:

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

name

public final String name()

The name of a task. This value is a text reference that is used to identify the task in the console.

Returns:

The name of a task. This value is a text reference that is used to identify the task in the console.

options

public final Options options()

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

Returns:

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

hasExcludes

public final boolean hasExcludes()

For responses, this returns true if the service returned a value for the Excludes 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.

excludes

public final List<FilterRule> excludes()

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

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 hasExcludes() method.

Returns:

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

schedule

public final TaskSchedule schedule()

Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

Returns:

Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

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<TagListEntry> tags()

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

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:

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

hasIncludes

public final boolean hasIncludes()

For responses, this returns true if the service returned a value for the Includes 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.

includes

public final List<FilterRule> includes()

A list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe). For example: "/folder1|/folder2"

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 hasIncludes() method.

Returns:

A list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe). For example: "/folder1|/folder2"

toBuilder

public CreateTaskRequest.Builder 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 interface ToCopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>

Specified by:

toBuilder in class DataSyncRequest

Returns:

a builder for type T

builder

public static CreateTaskRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.