Class ProvisionProductRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ProvisionProductRequest.Builder,
ProvisionProductRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The language code.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NotificationArns property.final boolean
For responses, this returns true if the service returned a value for the ProvisioningParameters property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Passed to CloudFormation.final String
pathId()
The path identifier of the product.final String
pathName()
The name of the path.final String
The product identifier.final String
The name of the product.final String
A user-friendly name for the provisioned product.final String
The identifier of the provisioning artifact.final String
The name of the provisioning artifact.final List
<ProvisioningParameter> Parameters specified by the administrator that are required for provisioning the product.final ProvisioningPreferences
An object that contains information about the provisioning preferences for a stack set.final String
An idempotency token that uniquely identifies the provisioning request.static Class
<? extends ProvisionProductRequest.Builder> tags()
One or more tags.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
acceptLanguage
The language code.
-
jp
- Japanese -
zh
- Chinese
- Returns:
- The language code.
-
jp
- Japanese -
zh
- Chinese
-
-
-
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
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
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
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
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
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
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
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
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
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
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
An idempotency token that uniquely identifies the provisioning request.
- Returns:
- An idempotency token that uniquely identifies the provisioning request.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ProvisionProductRequest.Builder,
ProvisionProductRequest> - Specified by:
toBuilder
in classServiceCatalogRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-