@Generated(value="software.amazon.awssdk:codegen") public final class CreateDeploymentRequest extends GreengrassV2Request implements ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateDeploymentRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateDeploymentRequest.Builder |
builder() |
String |
clientToken()
A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent.
|
Map<String,ComponentDeploymentSpecification> |
components()
The components to deploy.
|
String |
deploymentName()
The name of the deployment.
|
DeploymentPolicies |
deploymentPolicies()
The deployment policies for the deployment.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasComponents()
For responses, this returns true if the service returned a value for the Components property.
|
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
DeploymentIoTJobConfiguration |
iotJobConfiguration()
The job configuration for the deployment configuration.
|
String |
parentTargetArn()
The parent deployment's target ARN within a subdeployment.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateDeploymentRequest.Builder> |
serializableBuilderClass() |
Map<String,String> |
tags()
A list of key-value pairs that contain metadata for the resource.
|
String |
targetArn()
The ARN of the target
IoT thing or thing group.
|
CreateDeploymentRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String targetArn()
The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.
public final String deploymentName()
The name of the deployment.
public final boolean hasComponents()
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.public final 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.
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 hasComponents() method.
public final DeploymentIoTJobConfiguration iotJobConfiguration()
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
public final DeploymentPolicies deploymentPolicies()
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
public final String parentTargetArn()
The parent deployment's target ARN within a subdeployment.
public final boolean hasTags()
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.public final 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 IoT Greengrass V2 Developer Guide.
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.
public final String clientToken()
A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
public CreateDeploymentRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>toBuilder in class GreengrassV2Requestpublic static CreateDeploymentRequest.Builder builder()
public static Class<? extends CreateDeploymentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.