Package software.amazon.awssdk.services.greengrass.model

Class BulkDeploymentResult

java.lang.Object

software.amazon.awssdk.services.greengrass.model.BulkDeploymentResult

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BulkDeploymentResult.Builder,BulkDeploymentResult>

@Generated("software.amazon.awssdk:codegen")
public final class BulkDeploymentResult
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BulkDeploymentResult.Builder,BulkDeploymentResult>

Information about an individual group deployment in a bulk deployment operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BulkDeploymentResult.Builder

Method Summary

Modifier and Type	Method	Description
static BulkDeploymentResult.Builder	builder()
String	createdAt()	The time, in ISO format, when the deployment was created.
String	deploymentArn()	The ARN of the group deployment.
String	deploymentId()	The ID of the group deployment.
String	deploymentStatus()	The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.
DeploymentType	deploymentType()	The type of the deployment.
String	deploymentTypeAsString()	The type of the deployment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ErrorDetail>	errorDetails()	Details about the error.
String	errorMessage()	The error message for a failed deployment
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupArn()	The ARN of the Greengrass group.
boolean	hasErrorDetails()	For responses, this returns true if the service returned a value for the ErrorDetails property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends BulkDeploymentResult.Builder>	serializableBuilderClass()
BulkDeploymentResult.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

createdAt

public final String createdAt()

The time, in ISO format, when the deployment was created.

Returns:

The time, in ISO format, when the deployment was created.

deploymentArn

public final String deploymentArn()

The ARN of the group deployment.

Returns:

The ARN of the group deployment.

deploymentId

public final String deploymentId()

The ID of the group deployment.

Returns:

The ID of the group deployment.

deploymentStatus

public final String deploymentStatus()

The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.

Returns:

The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.

deploymentType

public final DeploymentType deploymentType()

The type of the deployment.

If the service returns an enum value that is not available in the current SDK version, deploymentType will return DeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

Returns:

The type of the deployment.

See Also:

DeploymentType

deploymentTypeAsString

public final String deploymentTypeAsString()

The type of the deployment.

If the service returns an enum value that is not available in the current SDK version, deploymentType will return DeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

Returns:

The type of the deployment.

See Also:

DeploymentType

hasErrorDetails

public final boolean hasErrorDetails()

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

errorDetails

public final List<ErrorDetail> errorDetails()

Details about the error.

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

Returns:

Details about the error.

errorMessage

public final String errorMessage()

The error message for a failed deployment

Returns:

The error message for a failed deployment

groupArn

public final String groupArn()

The ARN of the Greengrass group.

Returns:

The ARN of the Greengrass group.

toBuilder

public BulkDeploymentResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BulkDeploymentResult.Builder,BulkDeploymentResult>

builder

public static BulkDeploymentResult.Builder builder()

serializableBuilderClass

public static Class<? extends BulkDeploymentResult.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo