software.amazon.awssdk.services.servicecatalog.model

Class DescribeProvisioningParametersResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogResponse

software.amazon.awssdk.services.servicecatalog.model.DescribeProvisioningParametersResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeProvisioningParametersResponse.Builder,DescribeProvisioningParametersResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeProvisioningParametersResponse
extends ServiceCatalogResponse
implements ToCopyableBuilder<DescribeProvisioningParametersResponse.Builder,DescribeProvisioningParametersResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeProvisioningParametersResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeProvisioningParametersResponse.Builder	builder()
List<ConstraintSummary>	constraintSummaries() Information about the constraints used to provision the product.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConstraintSummaries() For responses, this returns true if the service returned a value for the ConstraintSummaries property.
int	hashCode()
boolean	hasProvisioningArtifactOutputKeys() For responses, this returns true if the service returned a value for the ProvisioningArtifactOutputKeys property.
boolean	hasProvisioningArtifactOutputs() Deprecated. This property is deprecated and returns the Id and Description of the Provisioning Artifact. Use ProvisioningArtifactOutputKeys instead to get the Keys and Descriptions of the outputs.
boolean	hasProvisioningArtifactParameters() For responses, this returns true if the service returned a value for the ProvisioningArtifactParameters property.
boolean	hasTagOptions() For responses, this returns true if the service returned a value for the TagOptions property.
boolean	hasUsageInstructions() For responses, this returns true if the service returned a value for the UsageInstructions property.
List<ProvisioningArtifactOutput>	provisioningArtifactOutputKeys() A list of the keys and descriptions of the outputs.
List<ProvisioningArtifactOutput>	provisioningArtifactOutputs() Deprecated. This property is deprecated and returns the Id and Description of the Provisioning Artifact. Use ProvisioningArtifactOutputKeys instead to get the Keys and Descriptions of the outputs.
List<ProvisioningArtifactParameter>	provisioningArtifactParameters() Information about the parameters used to provision the product.
ProvisioningArtifactPreferences	provisioningArtifactPreferences() An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeProvisioningParametersResponse.Builder>	serializableBuilderClass()
List<TagOptionSummary>	tagOptions() Information about the TagOptions associated with the resource.
DescribeProvisioningParametersResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<UsageInstruction>	usageInstructions() Any additional metadata specifically related to the provisioning of the product.

Methods inherited from class software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogResponse

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

hasProvisioningArtifactParameters

public final boolean hasProvisioningArtifactParameters()

For responses, this returns true if the service returned a value for the ProvisioningArtifactParameters 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.

provisioningArtifactParameters

public final List<ProvisioningArtifactParameter> provisioningArtifactParameters()

Information about the parameters used to provision the product.

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 hasProvisioningArtifactParameters() method.

Returns:

Information about the parameters used to provision the product.

hasConstraintSummaries

public final boolean hasConstraintSummaries()

For responses, this returns true if the service returned a value for the ConstraintSummaries 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.

constraintSummaries

public final List<ConstraintSummary> constraintSummaries()

Information about the constraints used to provision the product.

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 hasConstraintSummaries() method.

Returns:

Information about the constraints used to provision the product.

hasUsageInstructions

public final boolean hasUsageInstructions()

For responses, this returns true if the service returned a value for the UsageInstructions 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.

usageInstructions

public final List<UsageInstruction> usageInstructions()

Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

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 hasUsageInstructions() method.

Returns:

Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

hasTagOptions

public final boolean hasTagOptions()

For responses, this returns true if the service returned a value for the TagOptions 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.

tagOptions

public final List<TagOptionSummary> tagOptions()

Information about the TagOptions associated with the resource.

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 hasTagOptions() method.

Returns:

Information about the TagOptions associated with the resource.

provisioningArtifactPreferences

public final ProvisioningArtifactPreferences provisioningArtifactPreferences()

An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

Returns:

An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

hasProvisioningArtifactOutputs

@Deprecated
public final boolean hasProvisioningArtifactOutputs()

Deprecated. This property is deprecated and returns the Id and Description of the Provisioning Artifact. Use ProvisioningArtifactOutputKeys instead to get the Keys and Descriptions of the outputs.

For responses, this returns true if the service returned a value for the ProvisioningArtifactOutputs 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.

provisioningArtifactOutputs

@Deprecated
public final List<ProvisioningArtifactOutput> provisioningArtifactOutputs()

Deprecated. This property is deprecated and returns the Id and Description of the Provisioning Artifact. Use ProvisioningArtifactOutputKeys instead to get the Keys and Descriptions of the outputs.

The output of the provisioning artifact.

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 hasProvisioningArtifactOutputs() method.

Returns:

The output of the provisioning artifact.

hasProvisioningArtifactOutputKeys

public final boolean hasProvisioningArtifactOutputKeys()

For responses, this returns true if the service returned a value for the ProvisioningArtifactOutputKeys 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.

provisioningArtifactOutputKeys

public final List<ProvisioningArtifactOutput> provisioningArtifactOutputKeys()

A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

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 hasProvisioningArtifactOutputKeys() method.

Returns:

A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

toBuilder

public DescribeProvisioningParametersResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeProvisioningParametersResponse.Builder,DescribeProvisioningParametersResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeProvisioningParametersResponse.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo