Package software.amazon.awssdk.services.launchwizard.model

Class CreateDeploymentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.launchwizard.model.LaunchWizardRequest

software.amazon.awssdk.services.launchwizard.model.CreateDeploymentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDeploymentRequest
extends LaunchWizardRequest
implements ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDeploymentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateDeploymentRequest.Builder	builder()
String	deploymentPatternName()	The name of the deployment pattern supported by a given workload.
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSpecifications()	For responses, this returns true if the service returned a value for the Specifications property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	The name of the deployment.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDeploymentRequest.Builder>	serializableBuilderClass()
Map<String,String>	specifications()	The settings specified for the deployment.
Map<String,String>	tags()	The tags to add to the deployment.
CreateDeploymentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workloadName()	The name of the workload.

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

deploymentPatternName

public final String deploymentPatternName()

The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.

Returns:

The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.

dryRun

public final Boolean dryRun()

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

name

public final String name()

The name of the deployment.

Returns:

The name of the deployment.

hasSpecifications

public final boolean hasSpecifications()

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

specifications

public final Map<String,String> specifications()

The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.

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

Returns:

The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.

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 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.

tags

public final Map<String,String> tags()

The tags to add to the deployment.

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:

The tags to add to the deployment.

workloadName

public final String workloadName()

The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.

Returns:

The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.

toBuilder

public CreateDeploymentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

Specified by:

toBuilder in class LaunchWizardRequest

builder

public static CreateDeploymentRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo