Package software.amazon.awssdk.services.quicksight.model

Interface DescribeAssetBundleExportJobResponse.Builder

    • Method Detail

      • jobStatus

        DescribeAssetBundleExportJobResponse.Builder jobStatus​(String jobStatus)

        Indicates the status of a job through its queuing and execution.

        Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

        Parameters:
        jobStatus - Indicates the status of a job through its queuing and execution.

        Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

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

      • downloadUrl

        DescribeAssetBundleExportJobResponse.Builder downloadUrl​(String downloadUrl)

        The URL to download the exported asset bundle data from.

        This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

        The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.

        This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

        Parameters:
        downloadUrl - The URL to download the exported asset bundle data from.

        This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

        The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.

        This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

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

      • errors

        DescribeAssetBundleExportJobResponse.Builder errors​(Collection<AssetBundleExportJobError> errors)

        An array of error records that describes any failures that occurred during the export job processing.

        Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

        Parameters:
        errors - An array of error records that describes any failures that occurred during the export job processing.

        Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

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

      • errors

        DescribeAssetBundleExportJobResponse.Builder errors​(AssetBundleExportJobError... errors)

        An array of error records that describes any failures that occurred during the export job processing.

        Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

        Parameters:
        errors - An array of error records that describes any failures that occurred during the export job processing.

        Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

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

      • arn

        DescribeAssetBundleExportJobResponse.Builder arn​(String arn)

        The Amazon Resource Name (ARN) for the export job.

        Parameters:
        arn - The Amazon Resource Name (ARN) for the export job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdTime

        DescribeAssetBundleExportJobResponse.Builder createdTime​(Instant createdTime)

        The time that the export job was created.

        Parameters:
        createdTime - The time that the export job was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • assetBundleExportJobId

        DescribeAssetBundleExportJobResponse.Builder assetBundleExportJobId​(String assetBundleExportJobId)

        The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

        Parameters:
        assetBundleExportJobId - The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • awsAccountId

        DescribeAssetBundleExportJobResponse.Builder awsAccountId​(String awsAccountId)

        The ID of the Amazon Web Services account that the export job was executed in.

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

      • resourceArns

        DescribeAssetBundleExportJobResponse.Builder resourceArns​(Collection<String> resourceArns)

        A list of resource ARNs that exported with the job.

        Parameters:
        resourceArns - A list of resource ARNs that exported with the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceArns

        DescribeAssetBundleExportJobResponse.Builder resourceArns​(String... resourceArns)

        A list of resource ARNs that exported with the job.

        Parameters:
        resourceArns - A list of resource ARNs that exported with the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeAllDependencies

        DescribeAssetBundleExportJobResponse.Builder includeAllDependencies​(Boolean includeAllDependencies)

        The include dependencies flag.

        Parameters:
        includeAllDependencies - The include dependencies flag.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exportFormat

        DescribeAssetBundleExportJobResponse.Builder exportFormat​(String exportFormat)

        The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

        Parameters:
        exportFormat - The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AssetBundleExportFormat, AssetBundleExportFormat

      • exportFormat

        DescribeAssetBundleExportJobResponse.Builder exportFormat​(AssetBundleExportFormat exportFormat)

        The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

        Parameters:
        exportFormat - The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AssetBundleExportFormat, AssetBundleExportFormat

      • cloudFormationOverridePropertyConfiguration

        DescribeAssetBundleExportJobResponse.Builder cloudFormationOverridePropertyConfiguration​(AssetBundleCloudFormationOverridePropertyConfiguration cloudFormationOverridePropertyConfiguration)

        The CloudFormation override property configuration for the export job.

        Parameters:
        cloudFormationOverridePropertyConfiguration - The CloudFormation override property configuration for the export job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requestId

        DescribeAssetBundleExportJobResponse.Builder requestId​(String requestId)

        The Amazon Web Services request ID for this operation.

        Parameters:
        requestId - The Amazon Web Services request ID for this operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        DescribeAssetBundleExportJobResponse.Builder status​(Integer status)

        The HTTP status of the response.

        Parameters:
        status - The HTTP status of the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includePermissions

        DescribeAssetBundleExportJobResponse.Builder includePermissions​(Boolean includePermissions)

        The include permissions flag.

        Parameters:
        includePermissions - The include permissions flag.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeTags

        DescribeAssetBundleExportJobResponse.Builder includeTags​(Boolean includeTags)

        The include tags flag.

        Parameters:
        includeTags - The include tags flag.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • validationStrategy

        DescribeAssetBundleExportJobResponse.Builder validationStrategy​(AssetBundleExportJobValidationStrategy validationStrategy)

        The validation strategy that is used to export the analysis or dashboard.

        Parameters:
        validationStrategy - The validation strategy that is used to export the analysis or dashboard.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • warnings

        DescribeAssetBundleExportJobResponse.Builder warnings​(Collection<AssetBundleExportJobWarning> warnings)

        An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

        This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

        Parameters:
        warnings - An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

        This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

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

      • warnings

        DescribeAssetBundleExportJobResponse.Builder warnings​(AssetBundleExportJobWarning... warnings)

        An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

        This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

        Parameters:
        warnings - An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

        This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

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