Class StartAssetBundleExportJobRequest

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

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The ID of the Amazon Web Services account to export assets from.

      Returns:
      The ID of the Amazon Web Services account to export assets from.

    • assetBundleExportJobId

      public final String assetBundleExportJobId()

      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.

    • hasResourceArns

      public final boolean hasResourceArns()
      For responses, this returns true if the service returned a value for the ResourceArns 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.

    • resourceArns

      public final List<String> resourceArns()

      An array of resource ARNs to export. The following resources are supported.

      • Analysis

      • Dashboard

      • DataSet

      • DataSource

      • RefreshSchedule

      • Theme

      • VPCConnection

      The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

      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 hasResourceArns() method.

      Returns:
      An array of resource ARNs to export. The following resources are supported.

      • Analysis

      • Dashboard

      • DataSet

      • DataSource

      • RefreshSchedule

      • Theme

      • VPCConnection

      The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

    • includeAllDependencies

      public final Boolean includeAllDependencies()

      A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.

      Returns:
      A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.

    • exportFormat

      public final AssetBundleExportFormat exportFormat()

      The export data format.

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

      Returns:
      The export data format.
      See Also:

    • exportFormatAsString

      public final String exportFormatAsString()

      The export data format.

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

      Returns:
      The export data format.
      See Also:

    • cloudFormationOverridePropertyConfiguration

      public final AssetBundleCloudFormationOverridePropertyConfiguration cloudFormationOverridePropertyConfiguration()

      An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

      Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

      Returns:
      An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

      Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

    • includePermissions

      public final Boolean includePermissions()

      A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

      Returns:
      A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

    • includeTags

      public final Boolean includeTags()

      A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

      Returns:
      A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

    • validationStrategy

      public final AssetBundleExportJobValidationStrategy validationStrategy()

      An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

      Returns:
      An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

    • includeFolderMemberships

      public final Boolean includeFolderMemberships()

      A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.

      Returns:
      A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.

    • includeFolderMembers

      public final IncludeFolderMembers includeFolderMembers()

      A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.

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

      Returns:
      A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.
      See Also:

    • includeFolderMembersAsString

      public final String includeFolderMembersAsString()

      A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.

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

      Returns:
      A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.
      See Also:

    • toBuilder

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

    • builder

      public static StartAssetBundleExportJobRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.