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 AWS storage resource's location.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
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.
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()

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 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 String destinationLocationArn()

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

Returns:

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

cloudWatchLogGroupArn

public String cloudWatchLogGroupArn()

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

For more information about how to useCloudWatchLogs with DataSync, see Monitoring Your Task.

Returns:

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

For more information about how to useCloudWatchLogs with DataSync, see Monitoring Your Task.

name

public 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 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 a the task execution. For more information, see the 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 a the task execution. For more information, see the operation.

tags

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

Returns:

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

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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