software.amazon.awssdk.services.servicecatalog.model

Class CreateProvisionedProductPlanRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogRequest

software.amazon.awssdk.services.servicecatalog.model.CreateProvisionedProductPlanRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateProvisionedProductPlanRequest.Builder,CreateProvisionedProductPlanRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateProvisionedProductPlanRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	acceptLanguage() The language code.
static CreateProvisionedProductPlanRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNotificationArns() Returns true if the NotificationArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasProvisioningParameters() Returns true if the ProvisioningParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	idempotencyToken() A unique identifier that you provide to ensure idempotency.
List<String>	notificationArns() Passed to CloudFormation.
String	pathId() The path identifier of the product.
String	planName() The name of the plan.
ProvisionedProductPlanType	planType() The plan type.
String	planTypeAsString() The plan type.
String	productId() The product identifier.
String	provisionedProductName() A user-friendly name for the provisioned product.
String	provisioningArtifactId() The identifier of the provisioning artifact.
List<UpdateProvisioningParameter>	provisioningParameters() Parameters specified by the administrator that are required for provisioning the product.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateProvisionedProductPlanRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() One or more tags.
CreateProvisionedProductPlanRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

acceptLanguage

public final String acceptLanguage()

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

Returns:

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

planName

public final String planName()

The name of the plan.

Returns:

The name of the plan.

planType

public final ProvisionedProductPlanType planType()

The plan type.

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

Returns:

The plan type.

See Also:

ProvisionedProductPlanType

planTypeAsString

public final String planTypeAsString()

The plan type.

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

Returns:

The plan type.

See Also:

ProvisionedProductPlanType

hasNotificationArns

public final boolean hasNotificationArns()

Returns true if the NotificationArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

notificationArns

public final List<String> notificationArns()

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasNotificationArns() to see if a value was sent in this field.

Returns:

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

pathId

public final String pathId()

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

Returns:

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

productId

public final String productId()

The product identifier.

Returns:

The product identifier.

provisionedProductName

public final String provisionedProductName()

A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

Returns:

A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

provisioningArtifactId

public final String provisioningArtifactId()

The identifier of the provisioning artifact.

Returns:

The identifier of the provisioning artifact.

hasProvisioningParameters

public final boolean hasProvisioningParameters()

Returns true if the ProvisioningParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

provisioningParameters

public final List<UpdateProvisioningParameter> provisioningParameters()

Parameters specified by the administrator that are required for provisioning the product.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasProvisioningParameters() to see if a value was sent in this field.

Returns:

Parameters specified by the administrator that are required for provisioning the product.

idempotencyToken

public final String idempotencyToken()

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

Returns:

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

One or more tags.

If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

One or more tags.

If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

toBuilder

public CreateProvisionedProductPlanRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateProvisionedProductPlanRequest.Builder,CreateProvisionedProductPlanRequest>

Specified by:

toBuilder in class ServiceCatalogRequest

builder

public static CreateProvisionedProductPlanRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo