Interface StartAssetBundleExportJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartAssetBundleExportJobRequest.Builder,StartAssetBundleExportJobRequest>, QuickSightRequest.Builder, SdkBuilder<StartAssetBundleExportJobRequest.Builder,StartAssetBundleExportJobRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartAssetBundleExportJobRequest
@Mutable @NotThreadSafe public static interface StartAssetBundleExportJobRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<StartAssetBundleExportJobRequest.Builder,StartAssetBundleExportJobRequest>

  • Method Details

    • awsAccountId

      StartAssetBundleExportJobRequest.Builder awsAccountId(String awsAccountId)

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

      Parameters:
      awsAccountId - The ID of the Amazon Web Services account to export assets from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assetBundleExportJobId

      StartAssetBundleExportJobRequest.Builder assetBundleExportJobId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • resourceArns

      StartAssetBundleExportJobRequest.Builder resourceArns(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceArns

      StartAssetBundleExportJobRequest.Builder resourceArns(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeAllDependencies

      StartAssetBundleExportJobRequest.Builder includeAllDependencies(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • exportFormat

      StartAssetBundleExportJobRequest.Builder exportFormat(String exportFormat)

      The export data format.

      Parameters:
      exportFormat - The export data format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • exportFormat

      StartAssetBundleExportJobRequest.Builder exportFormat(AssetBundleExportFormat exportFormat)

      The export data format.

      Parameters:
      exportFormat - The export data format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cloudFormationOverridePropertyConfiguration

      StartAssetBundleExportJobRequest.Builder cloudFormationOverridePropertyConfiguration(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • cloudFormationOverridePropertyConfiguration

      default StartAssetBundleExportJobRequest.Builder cloudFormationOverridePropertyConfiguration(Consumer<AssetBundleCloudFormationOverridePropertyConfiguration.Builder> 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.

      This is a convenience method that creates an instance of the AssetBundleCloudFormationOverridePropertyConfiguration.Builder avoiding the need to create one manually via AssetBundleCloudFormationOverridePropertyConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudFormationOverridePropertyConfiguration(AssetBundleCloudFormationOverridePropertyConfiguration).

      Parameters:
      cloudFormationOverridePropertyConfiguration - a consumer that will call methods on AssetBundleCloudFormationOverridePropertyConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includePermissions

      StartAssetBundleExportJobRequest.Builder includePermissions(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • includeTags

      StartAssetBundleExportJobRequest.Builder includeTags(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • validationStrategy

      StartAssetBundleExportJobRequest.Builder validationStrategy(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • validationStrategy

      default StartAssetBundleExportJobRequest.Builder validationStrategy(Consumer<AssetBundleExportJobValidationStrategy.Builder> 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.

      This is a convenience method that creates an instance of the AssetBundleExportJobValidationStrategy.Builder avoiding the need to create one manually via AssetBundleExportJobValidationStrategy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to validationStrategy(AssetBundleExportJobValidationStrategy).

      Parameters:
      validationStrategy - a consumer that will call methods on AssetBundleExportJobValidationStrategy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includeFolderMemberships

      StartAssetBundleExportJobRequest.Builder includeFolderMemberships(Boolean includeFolderMemberships)

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

      Parameters:
      includeFolderMemberships - A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeFolderMembers

      StartAssetBundleExportJobRequest.Builder includeFolderMembers(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includeFolderMembers

      StartAssetBundleExportJobRequest.Builder includeFolderMembers(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      StartAssetBundleExportJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartAssetBundleExportJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.