Class Job

java.lang.Object
software.amazon.awssdk.services.drs.model.Job
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Job.Builder,Job>
@Generated("software.amazon.awssdk:codegen") public final class Job extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Job.Builder,Job>

A job is an asynchronous workflow.

See Also:

  • Method Details

    • arn

      public final String arn()

      The ARN of a Job.

      Returns:
      The ARN of a Job.

    • creationDateTime

      public final String creationDateTime()

      The date and time of when the Job was created.

      Returns:
      The date and time of when the Job was created.

    • endDateTime

      public final String endDateTime()

      The date and time of when the Job ended.

      Returns:
      The date and time of when the Job ended.

    • initiatedBy

      public final InitiatedBy initiatedBy()

      A string representing who initiated the Job.

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

      Returns:
      A string representing who initiated the Job.
      See Also:

    • initiatedByAsString

      public final String initiatedByAsString()

      A string representing who initiated the Job.

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

      Returns:
      A string representing who initiated the Job.
      See Also:

    • jobID

      public final String jobID()

      The ID of the Job.

      Returns:
      The ID of the Job.

    • hasParticipatingResources

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

    • participatingResources

      public final List<ParticipatingResource> participatingResources()

      A list of resources that the Job is acting upon.

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

      Returns:
      A list of resources that the Job is acting upon.

    • hasParticipatingServers

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

    • participatingServers

      public final List<ParticipatingServer> participatingServers()

      A list of servers that the Job is acting upon.

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

      Returns:
      A list of servers that the Job is acting upon.

    • status

      public final JobStatus status()

      The status of the Job.

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

      Returns:
      The status of the Job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the Job.

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

      Returns:
      The status of the Job.
      See Also:

    • 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 Map<String,String> tags()

      A list of tags associated with the Job.

      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:
      A list of tags associated with the Job.

    • type

      public final JobType type()

      The type of the Job.

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

      Returns:
      The type of the Job.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the Job.

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

      Returns:
      The type of the Job.
      See Also:

    • toBuilder

      public Job.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<Job.Builder,Job>
      Returns:
      a builder for type T

    • builder

      public static Job.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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