Class ProvisionProductRequest
- 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.ProvisionProductRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ProvisionProductRequest.Builder,ProvisionProductRequest>
@Generated("software.amazon.awssdk:codegen") public final class ProvisionProductRequest extends ServiceCatalogRequest implements ToCopyableBuilder<ProvisionProductRequest.Builder,ProvisionProductRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceProvisionProductRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringacceptLanguage()The language code.static ProvisionProductRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasNotificationArns()For responses, this returns true if the service returned a value for the NotificationArns property.booleanhasProvisioningParameters()For responses, this returns true if the service returned a value for the ProvisioningParameters property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.List<String>notificationArns()Passed to CloudFormation.StringpathId()The path identifier of the product.StringpathName()The name of the path.StringproductId()The product identifier.StringproductName()The name of the product.StringprovisionedProductName()A user-friendly name for the provisioned product.StringprovisioningArtifactId()The identifier of the provisioning artifact.StringprovisioningArtifactName()The name of the provisioning artifact.List<ProvisioningParameter>provisioningParameters()Parameters specified by the administrator that are required for provisioning the product.ProvisioningPreferencesprovisioningPreferences()An object that contains information about the provisioning preferences for a stack set.StringprovisionToken()An idempotency token that uniquely identifies the provisioning request.List<SdkField<?>>sdkFields()static Class<? extends ProvisionProductRequest.Builder>serializableBuilderClass()List<Tag>tags()One or more tags.ProvisionProductRequest.BuildertoBuilder()StringtoString()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.
-
jp- Japanese -
zh- Chinese
- Returns:
- The language code.
-
jp- Japanese -
zh- Chinese
-
-
-
productId
public final String productId()
The product identifier. You must provide the name or ID, but not both.
- Returns:
- The product identifier. You must provide the name or ID, but not both.
-
productName
public final String productName()
The name of the product. You must provide the name or ID, but not both.
- Returns:
- The name of the product. You must provide the name or ID, but not both.
-
provisioningArtifactId
public final String provisioningArtifactId()
The identifier of the provisioning artifact. You must provide the name or ID, but not both.
- Returns:
- The identifier of the provisioning artifact. You must provide the name or ID, but not both.
-
provisioningArtifactName
public final String provisioningArtifactName()
The name of the provisioning artifact. You must provide the name or ID, but not both.
- Returns:
- The name of the provisioning artifact. You must provide the name or ID, but not both.
-
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. You must provide the name or ID, but not both.
- 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. You must provide the name or ID, but not both.
-
pathName
public final String pathName()
The name of the path. You must provide the name or ID, but not both.
- Returns:
- The name of the path. You must provide the name or ID, but not both.
-
provisionedProductName
public final String provisionedProductName()
A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services 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 Amazon Web Services account and cannot be updated after the product is provisioned.
-
hasProvisioningParameters
public final boolean hasProvisioningParameters()
For responses, this returns true if the service returned a value for the ProvisioningParameters 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.
-
provisioningParameters
public final List<ProvisioningParameter> 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.
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
hasProvisioningParameters()method.- Returns:
- Parameters specified by the administrator that are required for provisioning the product.
-
provisioningPreferences
public final ProvisioningPreferences provisioningPreferences()
An object that contains information about the provisioning preferences for a stack set.
- Returns:
- An object that contains information about the provisioning preferences for a stack set.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final List<Tag> tags()
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
hasTags()method.- Returns:
- One or more tags.
-
hasNotificationArns
public final boolean hasNotificationArns()
For responses, this returns true if the service returned a value for the NotificationArns 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.
-
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.
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
hasNotificationArns()method.- Returns:
- Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
-
provisionToken
public final String provisionToken()
An idempotency token that uniquely identifies the provisioning request.
- Returns:
- An idempotency token that uniquely identifies the provisioning request.
-
toBuilder
public ProvisionProductRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ProvisionProductRequest.Builder,ProvisionProductRequest>- Specified by:
toBuilderin classServiceCatalogRequest
-
builder
public static ProvisionProductRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ProvisionProductRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-