Package software.amazon.awssdk.services.opsworks.model

Class CreateDeploymentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opsworks.model.OpsWorksRequest

software.amazon.awssdk.services.opsworks.model.CreateDeploymentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDeploymentRequest
extends OpsWorksRequest
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
String	appId()	The app ID.
static CreateDeploymentRequest.Builder	builder()
DeploymentCommand	command()	A DeploymentCommand object that specifies the deployment command and any associated arguments.
String	comment()	A user-defined comment.
String	customJson()	A string that contains user-defined, custom JSON.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceIds()	For responses, this returns true if the service returned a value for the InstanceIds property.
boolean	hasLayerIds()	For responses, this returns true if the service returned a value for the LayerIds property.
List<String>	instanceIds()	The instance IDs for the deployment targets.
List<String>	layerIds()	The layer IDs for the deployment targets.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDeploymentRequest.Builder>	serializableBuilderClass()
String	stackId()	The stack ID.
CreateDeploymentRequest.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

stackId

public final String stackId()

The stack ID.

Returns:

The stack ID.

appId

public final String appId()

The app ID. This parameter is required for app deployments, but not for other deployment commands.

Returns:

The app ID. This parameter is required for app deployments, but not for other deployment commands.

hasInstanceIds

public final boolean hasInstanceIds()

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

instanceIds

public final List<String> instanceIds()

The instance IDs for the deployment targets.

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

Returns:

The instance IDs for the deployment targets.

hasLayerIds

public final boolean hasLayerIds()

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

layerIds

public final List<String> layerIds()

The layer IDs for the deployment targets.

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

Returns:

The layer IDs for the deployment targets.

command

public final DeploymentCommand command()

A DeploymentCommand object that specifies the deployment command and any associated arguments.

Returns:

A DeploymentCommand object that specifies the deployment command and any associated arguments.

comment

public final String comment()

A user-defined comment.

Returns:

A user-defined comment.

customJson

public final String customJson()

A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.

Returns:

A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.

toBuilder

public CreateDeploymentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

Specified by:

toBuilder in class OpsWorksRequest

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