Class StartDashboardSnapshotJobRequest

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

  • 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 want to start a snapshot job for.

      Returns:
      The ID of the dashboard that you want to start a snapshot job for.

    • snapshotJobId

      public final String snapshotJobId()

      An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

      Returns:
      An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

    • userConfiguration

      public final SnapshotUserConfiguration userConfiguration()

      A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

      Returns:
      A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

    • snapshotConfiguration

      public final SnapshotConfiguration snapshotConfiguration()

      A structure that describes the configuration of the dashboard snapshot.

      Returns:
      A structure that describes the configuration of the dashboard snapshot.

    • toBuilder

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

    • builder

      public static StartDashboardSnapshotJobRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.