Class GetJobResponse

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

  • Method Details

    • action

      public final JobAction action()

      Action performed by the job.

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

      Returns:
      Action performed by the job.
      See Also:

    • actionAsString

      public final String actionAsString()

      Action performed by the job.

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

      Returns:
      Action performed by the job.
      See Also:

    • actionOptions

      public final JobActionOptions actionOptions()

      Additional options for configuring job action parameters.

      Returns:
      Additional options for configuring job action parameters.

    • createdAt

      public final Instant createdAt()

      Job creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.

      Returns:
      Job creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.

    • endedAt

      public final Instant endedAt()

      Job completion time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss. Only returned for jobs in a terminal status: Completed | Failed | Cancelled.

      Returns:
      Job completion time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss. Only returned for jobs in a terminal status: Completed | Failed | Cancelled.

    • error

      public final JobError error()

      Error information if the job failed.

      Returns:
      Error information if the job failed.

    • executionRoleArn

      public final String executionRoleArn()

      IAM role used for permissions when running the job.

      Returns:
      IAM role used for permissions when running the job.

    • inputOptions

      public final JobInputOptions inputOptions()

      Input configuration.

      Returns:
      Input configuration.

    • jobArn

      public final String jobArn()

      Amazon Resource Name (ARN) of the specified job.

      Returns:
      Amazon Resource Name (ARN) of the specified job.

    • jobId

      public final String jobId()

      Unique job identifier.

      Returns:
      Unique job identifier.

    • name

      public final String name()

      Job name (if provided during creation).

      Returns:
      Job name (if provided during creation).

    • outputOptions

      public final JobOutputOptions outputOptions()

      Output configuration.

      Returns:
      Output configuration.

    • status

      public final JobStatus status()

      Current job status.

      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:
      Current job status.
      See Also:

    • statusAsString

      public final String statusAsString()

      Current job status.

      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:
      Current job status.
      See Also:

    • updatedAt

      public final Instant updatedAt()

      Last update time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.

      Returns:
      Last update time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.

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

      Tags and corresponding values associated with the specified 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:
      Tags and corresponding values associated with the specified job.

    • toBuilder

      public GetJobResponse.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<GetJobResponse.Builder,GetJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetJobResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetJobResponse.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.