Package software.amazon.awssdk.services.datasync.model

Class CreateTaskRequest

    • Method Detail

      • sourceLocationArn

        public final String sourceLocationArn()

        Specifies the ARN of your transfer's source location.

        Returns:
        Specifies the ARN of your transfer's source location.

      • destinationLocationArn

        public final String destinationLocationArn()

        Specifies the ARN of your transfer's destination location.

        Returns:
        Specifies the ARN of your transfer's destination location.

      • cloudWatchLogGroupArn

        public final String cloudWatchLogGroupArn()

        Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

        Returns:
        Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

      • name

        public final String name()

        Specifies the name of your task.

        Returns:
        Specifies the name of your task.

      • options

        public final Options options()

        Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

        Returns:
        Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

      • 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()

        Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

        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 exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

      • schedule

        public final TaskSchedule schedule()

        Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

        Returns:
        Specifies a schedule for when you want your task to run. 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()

        Specifies the tags that you want to apply to your task.

        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 your task.

        Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

      • 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()

        Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

        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 include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

      • manifestConfig

        public final ManifestConfig manifestConfig()

        Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

        When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

        Returns:
        Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

        When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

      • taskReportConfig

        public final TaskReportConfig taskReportConfig()

        Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

        When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

        Returns:
        Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

        When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

      • 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