Package software.amazon.awssdk.services.greengrassv2.model

Class CreateDeploymentRequest

    • Method Detail

      • targetArn

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

        Returns:
        The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.

      • deploymentName

        public final String deploymentName()

        The name of the deployment.

        Returns:
        The name of the deployment.

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

      • components

        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.

        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.

      • iotJobConfiguration

        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.

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

      • deploymentPolicies

        public final DeploymentPolicies 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.

      • parentTargetArn

        public final String 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 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()

        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.

      • clientToken

        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.

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

      • 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