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

      Returns:
      The ARN of your task.

    • status

      public final TaskStatus status()

      The status of your task. For information about what each status means, see Task statuses.

      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 your task. For information about what each status means, see Task statuses.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of your task. For information about what each status means, see Task statuses.

      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 your task. For information about what each status means, see Task statuses.
      See Also:

    • name

      public final String name()

      The name of your task.

      Returns:
      The name of your task.

    • currentTaskExecutionArn

      public final String currentTaskExecutionArn()

      The ARN of the most recent task execution.

      Returns:
      The ARN of the most recent task execution.

    • sourceLocationArn

      public final String sourceLocationArn()

      The ARN of your transfer's source location.

      Returns:
      The ARN of your transfer's source location.

    • destinationLocationArn

      public final String destinationLocationArn()

      The ARN of your transfer's destination location.

      Returns:
      The ARN of your transfer's destination location.

    • cloudWatchLogGroupArn

      public final String cloudWatchLogGroupArn()

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

      For more information, see Monitoring data transfers with CloudWatch Logs.

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

      For more information, see Monitoring data transfers with CloudWatch Logs.

    • 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 ARNs of the network interfaces that DataSync created for your source location.

      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 ARNs of the network interfaces that DataSync created for your source location.

    • 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 ARNs of the network interfaces that DataSync created for your destination location.

      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 ARNs of the network interfaces that DataSync created for your destination location.

    • options

      public final Options options()

      The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.

      Returns:
      The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, 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()

      The 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:
      The 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()

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

      Returns:
      The schedule for when you want your task to run. For more information, see Scheduling your task.

    • errorCode

      public final String errorCode()

      If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

      Returns:
      If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

    • errorDetail

      public final String errorDetail()

      If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

      Returns:
      If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

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

      The include filters that 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:
      The include filters that 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()

      The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

      Returns:
      The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

    • taskReportConfig

      public final TaskReportConfig taskReportConfig()

      The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

      Returns:
      The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

    • scheduleDetails

      public final TaskScheduleDetails scheduleDetails()

      The details about your task schedule.

      Returns:
      The details about your task schedule.

    • taskMode

      public final TaskMode taskMode()

      The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

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

      Returns:
      The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
      See Also:

    • taskModeAsString

      public final String taskModeAsString()

      The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

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

      Returns:
      The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
      See Also:

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.