Class RecordDetail
- java.lang.Object
-
- software.amazon.awssdk.services.servicecatalog.model.RecordDetail
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RecordDetail.Builder,RecordDetail>
@Generated("software.amazon.awssdk:codegen") public final class RecordDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RecordDetail.Builder,RecordDetail>
Information about a request operation.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRecordDetail.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RecordDetail.Builderbuilder()InstantcreatedTime()The UTC time stamp of the creation time.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasRecordErrors()For responses, this returns true if the service returned a value for the RecordErrors property.booleanhasRecordTags()For responses, this returns true if the service returned a value for the RecordTags property.StringlaunchRoleArn()The ARN of the launch role associated with the provisioned product.StringpathId()The path identifier.StringproductId()The product identifier.StringprovisionedProductId()The identifier of the provisioned product.StringprovisionedProductName()The user-friendly name of the provisioned product.StringprovisionedProductType()The type of provisioned product.StringprovisioningArtifactId()The identifier of the provisioning artifact.List<RecordError>recordErrors()The errors that occurred.StringrecordId()The identifier of the record.List<RecordTag>recordTags()One or more tags.StringrecordType()The record type.List<SdkField<?>>sdkFields()static Class<? extends RecordDetail.Builder>serializableBuilderClass()RecordStatusstatus()The status of the provisioned product.StringstatusAsString()The status of the provisioned product.RecordDetail.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedTime()The time when the record was last updated.-
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
-
recordId
public final String recordId()
The identifier of the record.
- Returns:
- The identifier of the record.
-
provisionedProductName
public final String provisionedProductName()
The user-friendly name of the provisioned product.
- Returns:
- The user-friendly name of the provisioned product.
-
status
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,
statuswill returnRecordStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- 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.
-
- See Also:
RecordStatus
-
-
statusAsString
public 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,
statuswill returnRecordStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- 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.
-
- See Also:
RecordStatus
-
-
createdTime
public final Instant createdTime()
The UTC time stamp of the creation time.
- Returns:
- The UTC time stamp of the creation time.
-
updatedTime
public final Instant updatedTime()
The time when the record was last updated.
- Returns:
- The time when the record was last updated.
-
provisionedProductType
public final String provisionedProductType()
The type of provisioned product. The supported values are
CFN_STACK,CFN_STACKSET,TERRAFORM_OPEN_SOURCE,TERRAFORM_CLOUD, andEXTERNAL.- Returns:
- The type of provisioned product. The supported values are
CFN_STACK,CFN_STACKSET,TERRAFORM_OPEN_SOURCE,TERRAFORM_CLOUD, andEXTERNAL.
-
recordType
public final String recordType()
The record type.
-
PROVISION_PRODUCT -
UPDATE_PROVISIONED_PRODUCT -
TERMINATE_PROVISIONED_PRODUCT
- Returns:
- The record type.
-
PROVISION_PRODUCT -
UPDATE_PROVISIONED_PRODUCT -
TERMINATE_PROVISIONED_PRODUCT
-
-
-
provisionedProductId
public final String provisionedProductId()
The identifier of the provisioned product.
- Returns:
- The identifier of the provisioned product.
-
productId
public final String productId()
The product identifier.
- Returns:
- The product identifier.
-
provisioningArtifactId
public final String provisioningArtifactId()
The identifier of the provisioning artifact.
- Returns:
- The identifier of the provisioning artifact.
-
pathId
public final String pathId()
The path identifier.
- Returns:
- The path identifier.
-
hasRecordErrors
public final boolean hasRecordErrors()
For responses, this returns true if the service returned a value for the RecordErrors 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.
-
recordErrors
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.- Returns:
- The errors that occurred.
-
hasRecordTags
public final boolean hasRecordTags()
For responses, this returns true if the service returned a value for the RecordTags 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.
-
recordTags
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.- Returns:
- One or more tags.
-
launchRoleArn
public final String launchRoleArn()
The ARN of the launch role associated with the provisioned product.
- Returns:
- The ARN of the launch role associated with the provisioned product.
-
toBuilder
public RecordDetail.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RecordDetail.Builder,RecordDetail>
-
builder
public static RecordDetail.Builder builder()
-
serializableBuilderClass
public static Class<? extends RecordDetail.Builder> serializableBuilderClass()
-
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.
-
-