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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeAssetBundleImportJobResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) for the import job.StringassetBundleImportJobId()The ID of the job.AssetBundleImportSourceDescriptionassetBundleImportSource()The source of the asset bundle zip file that contains the data that is imported by the job.StringawsAccountId()The ID of the Amazon Web Services account the import job was executed in.static DescribeAssetBundleImportJobResponse.Builderbuilder()InstantcreatedTime()The time that the import job was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<AssetBundleImportJobError>errors()An array of error records that describes any failures that occurred during the export job processing.AssetBundleImportFailureActionfailureAction()The failure action for the import job.StringfailureActionAsString()The failure action for the import job.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasErrors()For responses, this returns true if the service returned a value for the Errors property.inthashCode()booleanhasRollbackErrors()For responses, this returns true if the service returned a value for the RollbackErrors property.AssetBundleImportJobStatusjobStatus()Indicates the status of a job through its queuing and execution.StringjobStatusAsString()Indicates the status of a job through its queuing and execution.AssetBundleImportJobOverrideParametersoverrideParameters()Optional overrides that are applied to the resource configuration before import.AssetBundleImportJobOverridePermissionsoverridePermissions()Optional permission overrides that are applied to the resource configuration before import.AssetBundleImportJobOverrideTagsoverrideTags()Optional tag overrides that are applied to the resource configuration before import.AssetBundleImportJobOverrideValidationStrategyoverrideValidationStrategy()An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.StringrequestId()The Amazon Web Services request ID for this operation.List<AssetBundleImportJobError>rollbackErrors()An array of error records that describes any failures that occurred while an import job was attempting a rollback.List<SdkField<?>>sdkFields()static Class<? extends DescribeAssetBundleImportJobResponse.Builder>serializableBuilderClass()Integerstatus()The HTTP status of the response.DescribeAssetBundleImportJobResponse.BuildertoBuilder()StringtoString()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 AssetBundleImportJobStatus jobStatus()
Indicates the status of a job through its queuing and execution.
Poll the
DescribeAssetBundleImportAPI untilJobStatusreturns 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,
jobStatuswill returnAssetBundleImportJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromjobStatusAsString().- Returns:
- Indicates the status of a job through its queuing and execution.
Poll the
DescribeAssetBundleImportAPI untilJobStatusreturns one of the following values:-
SUCCESSFUL -
FAILED -
FAILED_ROLLBACK_COMPLETED -
FAILED_ROLLBACK_ERROR
-
- See Also:
AssetBundleImportJobStatus
-
-
jobStatusAsString
public final String jobStatusAsString()
Indicates the status of a job through its queuing and execution.
Poll the
DescribeAssetBundleImportAPI untilJobStatusreturns 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,
jobStatuswill returnAssetBundleImportJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromjobStatusAsString().- Returns:
- Indicates the status of a job through its queuing and execution.
Poll the
DescribeAssetBundleImportAPI untilJobStatusreturns one of the following values:-
SUCCESSFUL -
FAILED -
FAILED_ROLLBACK_COMPLETED -
FAILED_ROLLBACK_ERROR
-
- See Also:
AssetBundleImportJobStatus
-
-
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 theisEmpty()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 theisEmpty()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
StartAssetBundleImportJobAPI call.- Returns:
- The ID of the job. The job ID is set when you start a new job with a
StartAssetBundleImportJobAPI 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,
failureActionwill returnAssetBundleImportFailureAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfailureActionAsString().- Returns:
- The failure action for the import job.
- See Also:
AssetBundleImportFailureAction
-
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,
failureActionwill returnAssetBundleImportFailureAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfailureActionAsString().- Returns:
- The failure action for the import job.
- See Also:
AssetBundleImportFailureAction
-
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.
-
toBuilder
public DescribeAssetBundleImportJobResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeAssetBundleImportJobResponse.Builder,DescribeAssetBundleImportJobResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static DescribeAssetBundleImportJobResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeAssetBundleImportJobResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-