com.amazonaws.services.greengrassv2.model

Class CreateDeploymentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.greengrassv2.model.CreateDeploymentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDeploymentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDeploymentRequest()

Method Summary

Modifier and Type	Method and Description
CreateDeploymentRequest	addComponentsEntry(String key, ComponentDeploymentSpecification value) Add a single Components entry
CreateDeploymentRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateDeploymentRequest	clearComponentsEntries() Removes all the entries added into Components.
CreateDeploymentRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateDeploymentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Map<String,ComponentDeploymentSpecification>	getComponents() The components to deploy.
String	getDeploymentName() The name of the deployment.
DeploymentPolicies	getDeploymentPolicies() The deployment policies for the deployment.
DeploymentIoTJobConfiguration	getIotJobConfiguration() The job configuration for the deployment configuration.
Map<String,String>	getTags() A list of key-value pairs that contain metadata for the resource.
String	getTargetArn() The ARN of the target AWS IoT thing or thing group.
int	hashCode()
void	setComponents(Map<String,ComponentDeploymentSpecification> components) The components to deploy.
void	setDeploymentName(String deploymentName) The name of the deployment.
void	setDeploymentPolicies(DeploymentPolicies deploymentPolicies) The deployment policies for the deployment.
void	setIotJobConfiguration(DeploymentIoTJobConfiguration iotJobConfiguration) The job configuration for the deployment configuration.
void	setTags(Map<String,String> tags) A list of key-value pairs that contain metadata for the resource.
void	setTargetArn(String targetArn) The ARN of the target AWS IoT thing or thing group.
String	toString() Returns a string representation of this object.
CreateDeploymentRequest	withComponents(Map<String,ComponentDeploymentSpecification> components) The components to deploy.
CreateDeploymentRequest	withDeploymentName(String deploymentName) The name of the deployment.
CreateDeploymentRequest	withDeploymentPolicies(DeploymentPolicies deploymentPolicies) The deployment policies for the deployment.
CreateDeploymentRequest	withIotJobConfiguration(DeploymentIoTJobConfiguration iotJobConfiguration) The job configuration for the deployment configuration.
CreateDeploymentRequest	withTags(Map<String,String> tags) A list of key-value pairs that contain metadata for the resource.
CreateDeploymentRequest	withTargetArn(String targetArn) The ARN of the target AWS IoT thing or thing group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDeploymentRequest

public CreateDeploymentRequest()

Method Detail

setTargetArn

public void setTargetArn(String targetArn)

The ARN of the target AWS IoT thing or thing group.

Parameters:

targetArn - The ARN of the target AWS IoT thing or thing group.

getTargetArn

public String getTargetArn()

The ARN of the target AWS IoT thing or thing group.

Returns:

The ARN of the target AWS IoT thing or thing group.

withTargetArn

public CreateDeploymentRequest withTargetArn(String targetArn)

The ARN of the target AWS IoT thing or thing group.

Parameters:

targetArn - The ARN of the target AWS IoT thing or thing group.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeploymentName

public void setDeploymentName(String deploymentName)

The name of the deployment.

You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.

Parameters:

deploymentName - The name of the deployment.

You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.

getDeploymentName

public String getDeploymentName()

The name of the deployment.

You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.

Returns:

The name of the deployment.

You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.

withDeploymentName

public CreateDeploymentRequest withDeploymentName(String deploymentName)

The name of the deployment.

You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.

Parameters:

deploymentName - The name of the deployment.

You can create deployments without names. If you create a deployment without a name, the AWS IoT Greengrass V2 console shows the deployment name as <targetType>:<targetName>, where targetType and targetName are the type and name of the deployment target.

Returns:

Returns a reference to this object so that method calls can be chained together.

getComponents

public Map<String,ComponentDeploymentSpecification> getComponents()

The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

Returns:

The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

setComponents

public void setComponents(Map<String,ComponentDeploymentSpecification> components)

The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

Parameters:

components - The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

withComponents

public CreateDeploymentRequest withComponents(Map<String,ComponentDeploymentSpecification> components)

The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

Parameters:

components - The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.

Returns:

Returns a reference to this object so that method calls can be chained together.

addComponentsEntry

public CreateDeploymentRequest addComponentsEntry(String key,
                                                  ComponentDeploymentSpecification value)

Add a single Components entry

See Also:

withComponents(java.util.Map<java.lang.String, com.amazonaws.services.greengrassv2.model.ComponentDeploymentSpecification>)

clearComponentsEntries

public CreateDeploymentRequest clearComponentsEntries()

Removes all the entries added into Components.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIotJobConfiguration

public void setIotJobConfiguration(DeploymentIoTJobConfiguration iotJobConfiguration)

The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

Parameters:

iotJobConfiguration - The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

getIotJobConfiguration

public DeploymentIoTJobConfiguration getIotJobConfiguration()

The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

Returns:

The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

withIotJobConfiguration

public CreateDeploymentRequest withIotJobConfiguration(DeploymentIoTJobConfiguration iotJobConfiguration)

The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

Parameters:

iotJobConfiguration - The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeploymentPolicies

public void setDeploymentPolicies(DeploymentPolicies deploymentPolicies)

The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

Parameters:

deploymentPolicies - The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

getDeploymentPolicies

public DeploymentPolicies getDeploymentPolicies()

The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

Returns:

The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

withDeploymentPolicies

public CreateDeploymentRequest withDeploymentPolicies(DeploymentPolicies deploymentPolicies)

The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

Parameters:

deploymentPolicies - The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.

Returns:

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.

setTags

public void setTags(Map<String,String> tags)

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.

Parameters:

tags - A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.

withTags

public CreateDeploymentRequest withTags(Map<String,String> tags)

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.

Parameters:

tags - A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateDeploymentRequest addTagsEntry(String key,
                                            String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateDeploymentRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateDeploymentRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()