Class DescribeAutomationJobResponse

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

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the automation job.

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

    • createdAt

      public final Instant createdAt()

      The time that the automation job was created.

      Returns:
      The time that the automation job was created.

    • startedAt

      public final Instant startedAt()

      The time that the automation job started running.

      Returns:
      The time that the automation job started running.

    • endedAt

      public final Instant endedAt()

      The time that the automation job finished running.

      Returns:
      The time that the automation job finished running.

    • jobStatus

      public final AutomationJobStatus jobStatus()

      The current status of the automation job.

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

      Returns:
      The current status of the automation job.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The current status of the automation job.

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

      Returns:
      The current status of the automation job.
      See Also:

    • inputPayload

      public final String inputPayload()

      The input payload that was provided when the automation job was started. This field is only included when IncludeInputPayload is set to true in the request.

      Returns:
      The input payload that was provided when the automation job was started. This field is only included when IncludeInputPayload is set to true in the request.

    • outputPayload

      public final String outputPayload()

      The output payload that was generated by the automation job. This field is only included when IncludeOutputPayload is set to true in the request.

      Returns:
      The output payload that was generated by the automation job. This field is only included when IncludeOutputPayload is set to true in the request.

    • requestId

      public final String requestId()

      The Amazon Web Services request ID for this operation.

      Returns:
      The Amazon Web Services request ID for this operation.

    • toBuilder

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

    • builder

      public static DescribeAutomationJobResponse.Builder builder()

    • serializableBuilderClass

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