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

Class DescribeTaskResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.datasync.model.DataSyncResponse
software.amazon.awssdk.services.datasync.model.DescribeTaskResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeTaskResponse.Builder,DescribeTaskResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeTaskResponse extends DataSyncResponse implements ToCopyableBuilder<DescribeTaskResponse.Builder,DescribeTaskResponse>

DescribeTaskResponse

  • Method Details

    • 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:

    • 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:

    • 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.

    • taskReportConfig

      public final TaskReportConfig taskReportConfig()

      The configuration of your task report. For more information, see Creating a task report.

      Returns:
      The configuration of your task report. For more information, see Creating a task report.

    • toBuilder

      public DescribeTaskResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeTaskResponse.Builder,DescribeTaskResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeTaskResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeTaskResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.