software.amazon.awssdk.services.quicksight.model

Class DescribeAssetBundleExportJobResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.quicksight.model.QuickSightResponse

software.amazon.awssdk.services.quicksight.model.DescribeAssetBundleExportJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAssetBundleExportJobResponse.Builder,DescribeAssetBundleExportJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeAssetBundleExportJobResponse
extends QuickSightResponse
implements ToCopyableBuilder<DescribeAssetBundleExportJobResponse.Builder,DescribeAssetBundleExportJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeAssetBundleExportJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) for the export job.
String	assetBundleExportJobId() The ID of the job.
String	awsAccountId() The ID of the Amazon Web Services account that the export job was executed in.
static DescribeAssetBundleExportJobResponse.Builder	builder()
AssetBundleCloudFormationOverridePropertyConfiguration	cloudFormationOverridePropertyConfiguration() The CloudFormation override property configuration for the export job.
Instant	createdTime() The time that the export job was created.
String	downloadUrl() The URL to download the exported asset bundle data from.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<AssetBundleExportJobError>	errors() An array of error records that describes any failures that occurred during the export job processing.
AssetBundleExportFormat	exportFormat() The format of the exported asset bundle.
String	exportFormatAsString() The format of the exported asset bundle.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasErrors() For responses, this returns true if the service returned a value for the Errors property.
int	hashCode()
boolean	hasResourceArns() For responses, this returns true if the service returned a value for the ResourceArns property.
Boolean	includeAllDependencies() The include dependencies flag.
AssetBundleExportJobStatus	jobStatus() Indicates the status of a job through its queuing and execution.
String	jobStatusAsString() Indicates the status of a job through its queuing and execution.
String	requestId() The Amazon Web Services request ID for this operation.
List<String>	resourceArns() A list of resource ARNs that exported with the job.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAssetBundleExportJobResponse.Builder>	serializableBuilderClass()
Integer	status() The HTTP status of the response.
DescribeAssetBundleExportJobResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.quicksight.model.QuickSightResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobStatus

public final AssetBundleExportJobStatus jobStatus()

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

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

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

Returns:

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

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

See Also:

AssetBundleExportJobStatus

jobStatusAsString

public final String jobStatusAsString()

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

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

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

Returns:

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

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

See Also:

AssetBundleExportJobStatus

downloadUrl

public final 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.

Returns:

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.

hasErrors

public final boolean hasErrors()

For responses, this returns true if the service returned a value for the Errors 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.

errors

public final List<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.

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

Returns:

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.

arn

public final String arn()

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

Returns:

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

createdTime

public final Instant createdTime()

The time that the export job was created.

Returns:

The time that the export job was created.

assetBundleExportJobId

public final String assetBundleExportJobId()

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

Returns:

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

awsAccountId

public final String awsAccountId()

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

Returns:

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

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()

A list of resource ARNs that exported with the job.

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:

A list of resource ARNs that exported with the job.

includeAllDependencies

public final Boolean includeAllDependencies()

The include dependencies flag.

Returns:

The include dependencies flag.

exportFormat

public final 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.

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

See Also:

AssetBundleExportFormat

exportFormatAsString

public final String exportFormatAsString()

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.

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

See Also:

AssetBundleExportFormat

cloudFormationOverridePropertyConfiguration

public final AssetBundleCloudFormationOverridePropertyConfiguration cloudFormationOverridePropertyConfiguration()

The CloudFormation override property configuration for the export job.

Returns:

The CloudFormation override property configuration for the export job.

requestId

public final String requestId()

The Amazon Web Services request ID for this operation.

Returns:

The Amazon Web Services request ID for this operation.

status

public final Integer status()

The HTTP status of the response.

Returns:

The HTTP status of the response.

toBuilder

public DescribeAssetBundleExportJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAssetBundleExportJobResponse.Builder,DescribeAssetBundleExportJobResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeAssetBundleExportJobResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo