Class StartTaskExecutionRequest
- 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.StartTaskExecutionRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<StartTaskExecutionRequest.Builder,StartTaskExecutionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartTaskExecutionRequest extends DataSyncRequest implements ToCopyableBuilder<StartTaskExecutionRequest.Builder,StartTaskExecutionRequest>
StartTaskExecutionRequest
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStartTaskExecutionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StartTaskExecutionRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<FilterRule>excludes()Specifies a list of filter rules that determines which files to exclude from a task.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasExcludes()For responses, this returns true if the service returned a value for the Excludes property.inthashCode()booleanhasIncludes()For responses, this returns true if the service returned a value for the Includes property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.List<FilterRule>includes()Specifies a list of filter rules that determines which files to include when running a task.OptionsoverrideOptions()Returns the value of the OverrideOptions property for this object.List<SdkField<?>>sdkFields()static Class<? extends StartTaskExecutionRequest.Builder>serializableBuilderClass()List<TagListEntry>tags()Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.StringtaskArn()Specifies the Amazon Resource Name (ARN) of the task that you want to start.TaskReportConfigtaskReportConfig()Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.StartTaskExecutionRequest.BuildertoBuilder()StringtoString()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
-
taskArn
public final String taskArn()
Specifies the Amazon Resource Name (ARN) of the task that you want to start.
- Returns:
- Specifies the Amazon Resource Name (ARN) of the task that you want to start.
-
overrideOptions
public final Options overrideOptions()
Returns the value of the OverrideOptions property for this object.- Returns:
- The value of the OverrideOptions property for this object.
-
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 theisEmpty()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()
Specifies 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:
- Specifies 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".
-
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 theisEmpty()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()
Specifies a list of filter rules that determines which files to exclude from a task. The list contains 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:
- Specifies a list of filter rules that determines which files to exclude from a task. The list contains a
single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that
is, a pipe), for example,
"/folder1|/folder2".
-
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 theisEmpty()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()
Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
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:
- Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task
execution.
Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
-
taskReportConfig
public final TaskReportConfig taskReportConfig()
Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.
- Returns:
- Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.
-
toBuilder
public StartTaskExecutionRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<StartTaskExecutionRequest.Builder,StartTaskExecutionRequest>- Specified by:
toBuilderin classDataSyncRequest
-
builder
public static StartTaskExecutionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends StartTaskExecutionRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-