CreateTaskRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateTaskRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`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)`
`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()`
`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
clone, finalize, 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 contains 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 contains 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>
    
    Specified by:
    
    toBuilder in class DataSyncRequest
  - 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)
```
    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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateTaskRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

sourceLocationArn

destinationLocationArn

cloudWatchLogGroupArn

name

options

hasExcludes

excludes

schedule

hasTags

tags

hasIncludes

includes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields