Class DescribeAssetBundleImportJobResponse

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

  • Method Details

    • jobStatus

      public final AssetBundleImportJobStatus jobStatus()

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

      Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:

      • SUCCESSFUL

      • FAILED

      • FAILED_ROLLBACK_COMPLETED

      • FAILED_ROLLBACK_ERROR

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return AssetBundleImportJobStatus.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 the DescribeAssetBundleImport API until JobStatus returns one of the following values:

      • SUCCESSFUL

      • FAILED

      • FAILED_ROLLBACK_COMPLETED

      • FAILED_ROLLBACK_ERROR

      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

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

      Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:

      • SUCCESSFUL

      • FAILED

      • FAILED_ROLLBACK_COMPLETED

      • FAILED_ROLLBACK_ERROR

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return AssetBundleImportJobStatus.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 the DescribeAssetBundleImport API until JobStatus returns one of the following values:

      • SUCCESSFUL

      • FAILED

      • FAILED_ROLLBACK_COMPLETED

      • FAILED_ROLLBACK_ERROR

      See Also:

    • 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<AssetBundleImportJobError> errors()

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

      Error records accumulate while the job is still running. 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 is still running. The complete set of error records is available after the job has completed and failed.

    • hasRollbackErrors

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

    • rollbackErrors

      public final List<AssetBundleImportJobError> rollbackErrors()

      An array of error records that describes any failures that occurred while an import job was attempting a rollback.

      Error records accumulate while the job is still running. 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 hasRollbackErrors() method.

      Returns:
      An array of error records that describes any failures that occurred while an import job was attempting a rollback.

      Error records accumulate while the job is still running. 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 import job.

      Returns:
      The Amazon Resource Name (ARN) for the import job.

    • createdTime

      public final Instant createdTime()

      The time that the import job was created.

      Returns:
      The time that the import job was created.

    • assetBundleImportJobId

      public final String assetBundleImportJobId()

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

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

    • awsAccountId

      public final String awsAccountId()

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

      Returns:
      The ID of the Amazon Web Services account the import job was executed in.

    • assetBundleImportSource

      public final AssetBundleImportSourceDescription assetBundleImportSource()

      The source of the asset bundle zip file that contains the data that is imported by the job.

      Returns:
      The source of the asset bundle zip file that contains the data that is imported by the job.

    • overrideParameters

      public final AssetBundleImportJobOverrideParameters overrideParameters()

      Optional overrides that are applied to the resource configuration before import.

      Returns:
      Optional overrides that are applied to the resource configuration before import.

    • failureAction

      public final AssetBundleImportFailureAction failureAction()

      The failure action for the import job.

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

      Returns:
      The failure action for the import job.
      See Also:

    • failureActionAsString

      public final String failureActionAsString()

      The failure action for the import job.

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

      Returns:
      The failure action for the import job.
      See Also:

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

    • overridePermissions

      public final AssetBundleImportJobOverridePermissions overridePermissions()

      Optional permission overrides that are applied to the resource configuration before import.

      Returns:
      Optional permission overrides that are applied to the resource configuration before import.

    • overrideTags

      public final AssetBundleImportJobOverrideTags overrideTags()

      Optional tag overrides that are applied to the resource configuration before import.

      Returns:
      Optional tag overrides that are applied to the resource configuration before import.

    • overrideValidationStrategy

      public final AssetBundleImportJobOverrideValidationStrategy overrideValidationStrategy()

      An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

      Returns:
      An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

    • 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<AssetBundleImportJobWarning> warnings()

      An array of warning records that describe all permitted errors that are encountered during the import 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 hasWarnings() method.

      Returns:
      An array of warning records that describe all permitted errors that are encountered during the import job.

    • toBuilder

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

    • builder

      public static DescribeAssetBundleImportJobResponse.Builder builder()

    • serializableBuilderClass

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