software.amazon.awssdk.services.servicecatalog.model

Class ProvisioningArtifactDetail

java.lang.Object

software.amazon.awssdk.services.servicecatalog.model.ProvisioningArtifactDetail

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ProvisioningArtifactDetail.Builder,ProvisioningArtifactDetail>

@Generated(value="software.amazon.awssdk:codegen")
public final class ProvisioningArtifactDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ProvisioningArtifactDetail.Builder,ProvisioningArtifactDetail>

Information about a provisioning artifact (also known as a version) for a product.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProvisioningArtifactDetail.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	active() Indicates whether the product version is active.
static ProvisioningArtifactDetail.Builder	builder()
Instant	createdTime() The UTC time stamp of the creation time.
String	description() The description of the provisioning artifact.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
ProvisioningArtifactGuidance	guidance() Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
String	guidanceAsString() Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
int	hashCode()
String	id() The identifier of the provisioning artifact.
String	name() The name of the provisioning artifact.
List<SdkField<?>>	sdkFields()
static Class<? extends ProvisioningArtifactDetail.Builder>	serializableBuilderClass()
String	sourceRevision() Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact.
ProvisioningArtifactDetail.Builder	toBuilder()
String	toString() Returns a string representation of this object.
ProvisioningArtifactType	type() The type of provisioning artifact.
String	typeAsString() The type of provisioning artifact.

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

id

public final String id()

The identifier of the provisioning artifact.

Returns:

The identifier of the provisioning artifact.

name

public final String name()

The name of the provisioning artifact.

Returns:

The name of the provisioning artifact.

description

public final String description()

The description of the provisioning artifact.

Returns:

The description of the provisioning artifact.

type

public final ProvisioningArtifactType type()

The type of provisioning artifact.

• CLOUD_FORMATION_TEMPLATE - CloudFormation template

• MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

• MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources

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

Returns:

The type of provisioning artifact.

• CLOUD_FORMATION_TEMPLATE - CloudFormation template

• MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

• MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources

See Also:

ProvisioningArtifactType

typeAsString

public final String typeAsString()

The type of provisioning artifact.

• CLOUD_FORMATION_TEMPLATE - CloudFormation template

• MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

• MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources

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

Returns:

The type of provisioning artifact.

• CLOUD_FORMATION_TEMPLATE - CloudFormation template

• MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

• MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources

See Also:

ProvisioningArtifactType

createdTime

public final Instant createdTime()

The UTC time stamp of the creation time.

Returns:

The UTC time stamp of the creation time.

active

public final Boolean active()

Indicates whether the product version is active.

Returns:

Indicates whether the product version is active.

guidance

public final ProvisioningArtifactGuidance guidance()

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

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

Returns:

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

See Also:

ProvisioningArtifactGuidance

guidanceAsString

public final String guidanceAsString()

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

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

Returns:

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

See Also:

ProvisioningArtifactGuidance

sourceRevision

public final String sourceRevision()

Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

This field only exists for Repo-Synced products.

Returns:

Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

This field only exists for Repo-Synced products.

toBuilder

public ProvisioningArtifactDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProvisioningArtifactDetail.Builder,ProvisioningArtifactDetail>

builder

public static ProvisioningArtifactDetail.Builder builder()

serializableBuilderClass

public static Class<? extends ProvisioningArtifactDetail.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo