@Generated(value="software.amazon.awssdk:codegen") public final class CreateTaskRequest extends DataSyncRequest implements ToCopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>
CreateTaskRequest
Modifier and Type | Class and Description |
---|---|
static interface |
CreateTaskRequest.Builder |
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) |
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()
Returns true if the Excludes property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
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.
|
overrideConfiguration
copy
public final String sourceLocationArn()
The Amazon Resource Name (ARN) of the source location for the task.
public final String destinationLocationArn()
The Amazon Resource Name (ARN) of an AWS storage resource's location.
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.
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.
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 operation.
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 operation.
public final boolean hasExcludes()
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.
You can use hasExcludes()
to see if a value was sent in this field.
"/folder1|/folder2"
.
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 task-scheduling.
public final boolean hasTags()
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.
You can use hasTags()
to see if a value was sent in this field.
public CreateTaskRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateTaskRequest.Builder,CreateTaskRequest>
toBuilder
in class DataSyncRequest
public static CreateTaskRequest.Builder builder()
public static Class<? extends CreateTaskRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.