@Generated(value="software.amazon.awssdk:codegen") public final class RecordDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RecordDetail.Builder,RecordDetail>
Information about a request operation.
| Modifier and Type | Class and Description |
|---|---|
static interface |
RecordDetail.Builder |
| Modifier and Type | Method and Description |
|---|---|
static RecordDetail.Builder |
builder() |
Instant |
createdTime()
The UTC time stamp of the creation time.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasRecordErrors()
For responses, this returns true if the service returned a value for the RecordErrors property.
|
boolean |
hasRecordTags()
For responses, this returns true if the service returned a value for the RecordTags property.
|
String |
launchRoleArn()
The ARN of the launch role associated with the provisioned product.
|
String |
pathId()
The path identifier.
|
String |
productId()
The product identifier.
|
String |
provisionedProductId()
The identifier of the provisioned product.
|
String |
provisionedProductName()
The user-friendly name of the provisioned product.
|
String |
provisionedProductType()
The type of provisioned product.
|
String |
provisioningArtifactId()
The identifier of the provisioning artifact.
|
List<RecordError> |
recordErrors()
The errors that occurred.
|
String |
recordId()
The identifier of the record.
|
List<RecordTag> |
recordTags()
One or more tags.
|
String |
recordType()
The record type.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends RecordDetail.Builder> |
serializableBuilderClass() |
RecordStatus |
status()
The status of the provisioned product.
|
String |
statusAsString()
The status of the provisioned product.
|
RecordDetail.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Instant |
updatedTime()
The time when the record was last updated.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String recordId()
The identifier of the record.
public final String provisionedProductName()
The user-friendly name of the provisioned product.
public final RecordStatus status()
The status of the provisioned product.
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed
and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages
returned.
If the service returns an enum value that is not available in the current SDK version, status will
return RecordStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
statusAsString().
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation
failed and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error
messages returned.
RecordStatuspublic final String statusAsString()
The status of the provisioned product.
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed
and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages
returned.
If the service returns an enum value that is not available in the current SDK version, status will
return RecordStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
statusAsString().
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation
failed and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error
messages returned.
RecordStatuspublic final Instant createdTime()
The UTC time stamp of the creation time.
public final Instant updatedTime()
The time when the record was last updated.
public final String provisionedProductType()
The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET,
TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.
CFN_STACK,
CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and
EXTERNAL.public final String recordType()
The record type.
PROVISION_PRODUCT
UPDATE_PROVISIONED_PRODUCT
TERMINATE_PROVISIONED_PRODUCT
PROVISION_PRODUCT
UPDATE_PROVISIONED_PRODUCT
TERMINATE_PROVISIONED_PRODUCT
public final String provisionedProductId()
The identifier of the provisioned product.
public final String productId()
The product identifier.
public final String provisioningArtifactId()
The identifier of the provisioning artifact.
public final String pathId()
The path identifier.
public final boolean hasRecordErrors()
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.public final List<RecordError> recordErrors()
The errors that occurred.
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 hasRecordErrors() method.
public final boolean hasRecordTags()
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.public final List<RecordTag> recordTags()
One or more tags.
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 hasRecordTags() method.
public final String launchRoleArn()
The ARN of the launch role associated with the provisioned product.
public RecordDetail.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<RecordDetail.Builder,RecordDetail>public static RecordDetail.Builder builder()
public static Class<? extends RecordDetail.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.