Class DescribeDashboardSnapshotJobResponse

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.DescribeDashboardSnapshotJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeDashboardSnapshotJobResponse.Builder,DescribeDashboardSnapshotJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeDashboardSnapshotJobResponse extends QuickSightResponse implements ToCopyableBuilder<DescribeDashboardSnapshotJobResponse.Builder,DescribeDashboardSnapshotJobResponse>

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

      Returns:
      The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

    • dashboardId

      public final String dashboardId()

      The ID of the dashboard that you have started a snapshot job for.

      Returns:
      The ID of the dashboard that you have started a snapshot job for.

    • snapshotJobId

      public final String snapshotJobId()

      The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

      Returns:
      The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

    • userConfiguration

      public final SnapshotUserConfigurationRedacted userConfiguration()

      The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

      Returns:
      The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

    • snapshotConfiguration

      public final SnapshotConfiguration snapshotConfiguration()

      The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

      Returns:
      The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

      Returns:
      The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

    • jobStatus

      public final SnapshotJobStatus jobStatus()

      Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

      • COMPLETED - The job was completed successfully.

      • FAILED - The job failed to execute.

      • QUEUED - The job is queued and hasn't started yet.

      • RUNNING - The job is still running.

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

      Returns:
      Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

      • COMPLETED - The job was completed successfully.

      • FAILED - The job failed to execute.

      • QUEUED - The job is queued and hasn't started yet.

      • RUNNING - The job is still running.

      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

      • COMPLETED - The job was completed successfully.

      • FAILED - The job failed to execute.

      • QUEUED - The job is queued and hasn't started yet.

      • RUNNING - The job is still running.

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

      Returns:
      Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

      • COMPLETED - The job was completed successfully.

      • FAILED - The job failed to execute.

      • QUEUED - The job is queued and hasn't started yet.

      • RUNNING - The job is still running.

      See Also:

    • createdTime

      public final Instant createdTime()

      The time that the snapshot job was created.

      Returns:
      The time that the snapshot job was created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The time that the snapshot job status was last updated.

      Returns:
      The time that the snapshot job status was last updated.

    • requestId

      public final String requestId()

      The Amazon Web Services request ID for this operation.

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

    • status

      public final Integer status()

      The HTTP status of the request

      Returns:
      The HTTP status of the request

    • toBuilder

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

    • builder

      public static DescribeDashboardSnapshotJobResponse.Builder builder()

    • serializableBuilderClass

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