Class GetDeploymentResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetDeploymentResponse.Builder,
GetDeploymentResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The components to deploy.final Instant
The time at which the deployment was created, expressed in ISO 8601 format.final String
The ID of the deployment.final String
The name of the deployment.final DeploymentPolicies
The deployment policies for the deployment.final DeploymentStatus
The status of the deployment.final String
The status of the deployment.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 extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the Components property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The ARN of the IoT job that applies the deployment to target devices.The job configuration for the deployment configuration.final String
iotJobId()
The ID of the IoT job that applies the deployment to target devices.final Boolean
Whether or not the deployment is the latest revision for its target.final String
The parent deployment's target ARN within a subdeployment.final String
The revision number of the deployment.static Class
<? extends GetDeploymentResponse.Builder> tags()
A list of key-value pairs that contain metadata for the resource.final String
The ARN of the target IoT thing or thing group.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.services.greengrassv2.model.GreengrassV2Response
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
targetArn
The ARN of the target IoT thing or thing group.
- Returns:
- The ARN of the target IoT thing or thing group.
-
revisionId
The revision number of the deployment.
- Returns:
- The revision number of the deployment.
-
deploymentId
The ID of the deployment.
- Returns:
- The ID of the deployment.
-
deploymentName
The name of the deployment.
- Returns:
- The name of the deployment.
-
deploymentStatus
The status of the deployment.
If the service returns an enum value that is not available in the current SDK version,
deploymentStatus
will returnDeploymentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentStatusAsString()
.- Returns:
- The status of the deployment.
- See Also:
-
deploymentStatusAsString
The status of the deployment.
If the service returns an enum value that is not available in the current SDK version,
deploymentStatus
will returnDeploymentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentStatusAsString()
.- Returns:
- The status of the deployment.
- See Also:
-
iotJobId
The ID of the IoT job that applies the deployment to target devices.
- Returns:
- The ID of the IoT job that applies the deployment to target devices.
-
iotJobArn
The ARN of the IoT job that applies the deployment to target devices.
- Returns:
- The ARN of the IoT job that applies the deployment to target devices.
-
hasComponents
public final boolean hasComponents()For responses, this returns true if the service returned a value for the Components 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. -
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.- 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.
-
deploymentPolicies
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.
-
iotJobConfiguration
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.
-
creationTimestamp
The time at which the deployment was created, expressed in ISO 8601 format.
- Returns:
- The time at which the deployment was created, expressed in ISO 8601 format.
-
isLatestForTarget
Whether or not the deployment is the latest revision for its target.
- Returns:
- Whether or not the deployment is the latest revision for its target.
-
parentTargetArn
The parent deployment's target ARN within a subdeployment.
- Returns:
- The parent deployment's target ARN within a subdeployment.
-
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
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.- Returns:
- 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.
-
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<GetDeploymentResponse.Builder,
GetDeploymentResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-