Class StartAssetBundleImportJobRequest

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

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The ID of the Amazon Web Services account to import assets into.

      Returns:
      The ID of the Amazon Web Services account to import assets into.

    • assetBundleImportJobId

      public final String assetBundleImportJobId()

      The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

      Returns:
      The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

    • assetBundleImportSource

      public final AssetBundleImportSource assetBundleImportSource()

      The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

      Returns:
      The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

    • overrideParameters

      public final AssetBundleImportJobOverrideParameters overrideParameters()

      Optional overrides that are applied to the resource configuration before import.

      Returns:
      Optional overrides that are applied to the resource configuration before import.

    • failureAction

      public final AssetBundleImportFailureAction failureAction()

      The failure action for the import job.

      If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

      If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

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

      Returns:
      The failure action for the import job.

      If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

      If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

      See Also:

    • failureActionAsString

      public final String failureActionAsString()

      The failure action for the import job.

      If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

      If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

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

      Returns:
      The failure action for the import job.

      If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

      If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

      See Also:

    • overridePermissions

      public final AssetBundleImportJobOverridePermissions overridePermissions()

      Optional permission overrides that are applied to the resource configuration before import.

      Returns:
      Optional permission overrides that are applied to the resource configuration before import.

    • overrideTags

      public final AssetBundleImportJobOverrideTags overrideTags()

      Optional tag overrides that are applied to the resource configuration before import.

      Returns:
      Optional tag overrides that are applied to the resource configuration before import.

    • overrideValidationStrategy

      public final AssetBundleImportJobOverrideValidationStrategy overrideValidationStrategy()

      An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

      Returns:
      An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

    • toBuilder

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

    • builder

      public static StartAssetBundleImportJobRequest.Builder builder()

    • serializableBuilderClass

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