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("software.amazon.awssdk:codegen") public final class DescribeAssetBundleExportJobResponse extends QuickSightResponse implements ToCopyableBuilder<DescribeAssetBundleExportJobResponse.Builder,DescribeAssetBundleExportJobResponse>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

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

    • includePermissions

      public final Boolean includePermissions()

      The include permissions flag.

      Returns:
      The include permissions flag.

    • includeTags

      public final Boolean includeTags()

      The include tags flag.

      Returns:
      The include tags flag.

    • validationStrategy

      public final AssetBundleExportJobValidationStrategy validationStrategy()

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

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

    • hasWarnings

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

    • warnings

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

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

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

    • includeFolderMemberships

      public final Boolean includeFolderMemberships()

      The include folder memberships flag.

      Returns:
      The include folder memberships flag.

    • includeFolderMembers

      public final IncludeFolderMembers includeFolderMembers()

      A setting that determines whether folder members are included.

      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 determines whether folder members are included.
      See Also:

    • includeFolderMembersAsString

      public final String includeFolderMembersAsString()

      A setting that determines whether folder members are included.

      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 determines whether folder members are included.
      See Also:

    • toBuilder

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

    • 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)
      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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.