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

Class DescribeTaskResponse

    • Method Detail

      • taskArn

        public final String taskArn()

        The Amazon Resource Name (ARN) of the task that was described.

        Returns:
        The Amazon Resource Name (ARN) of the task that was described.

      • status

        public final TaskStatus status()

        The status of the task that was described.

        For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

        If the service returns an enum value that is not available in the current SDK version, status will return TaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the task that was described.

        For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

        See Also:
        TaskStatus

      • statusAsString

        public final String statusAsString()

        The status of the task that was described.

        For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

        If the service returns an enum value that is not available in the current SDK version, status will return TaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the task that was described.

        For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

        See Also:
        TaskStatus

      • name

        public final String name()

        The name of the task that was described.

        Returns:
        The name of the task that was described.

      • currentTaskExecutionArn

        public final String currentTaskExecutionArn()

        The Amazon Resource Name (ARN) of the task execution that is transferring files.

        Returns:
        The Amazon Resource Name (ARN) of the task execution that is transferring files.

      • sourceLocationArn

        public final String sourceLocationArn()

        The Amazon Resource Name (ARN) of the source file system's location.

        Returns:
        The Amazon Resource Name (ARN) of the source file system's location.

      • destinationLocationArn

        public final String destinationLocationArn()

        The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.

        Returns:
        The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.

      • cloudWatchLogGroupArn

        public final String cloudWatchLogGroupArn()

        The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was 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.

        Returns:
        The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was 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.

      • hasSourceNetworkInterfaceArns

        public final boolean hasSourceNetworkInterfaceArns()
        For responses, this returns true if the service returned a value for the SourceNetworkInterfaceArns 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.

      • sourceNetworkInterfaceArns

        public final List<String> sourceNetworkInterfaceArns()

        The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.

        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 hasSourceNetworkInterfaceArns() method.

        Returns:
        The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.

      • hasDestinationNetworkInterfaceArns

        public final boolean hasDestinationNetworkInterfaceArns()
        For responses, this returns true if the service returned a value for the DestinationNetworkInterfaceArns 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.

      • destinationNetworkInterfaceArns

        public final List<String> destinationNetworkInterfaceArns()

        The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.

        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 hasDestinationNetworkInterfaceArns() method.

        Returns:
        The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.

      • options

        public final Options options()

        The configuration options that control the behavior of the StartTaskExecution operation. Some options include preserving file or object metadata and verifying data integrity.

        You can override these options for each task execution. For more information, see StartTaskExecution.

        Returns:
        The configuration options that control the behavior of the StartTaskExecution operation. Some options include preserving file or object metadata and verifying data integrity.

        You can override these options for each task execution. For more information, see StartTaskExecution.

      • 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 exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

        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 exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

      • schedule

        public final TaskSchedule schedule()

        The schedule used to periodically transfer files from a source to a destination location.

        Returns:
        The schedule used to periodically transfer files from a source to a destination location.

      • errorCode

        public final String errorCode()

        Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

        Returns:
        Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

      • errorDetail

        public final String errorDetail()

        Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

        Returns:
        Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

      • creationTime

        public final Instant creationTime()

        The time that the task was created.

        Returns:
        The time that the task was created.

      • 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 include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

        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 include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

      • 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