software.amazon.awssdk.services.ssm.model

Class MaintenanceWindowExecutionTaskInvocationIdentity

java.lang.Object

software.amazon.awssdk.services.ssm.model.MaintenanceWindowExecutionTaskInvocationIdentity

All Implemented Interfaces:

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

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

Describes the information about a task invocation for a particular target as part of a task execution performed as part of a maintenance window execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MaintenanceWindowExecutionTaskInvocationIdentity.Builder

Method Summary

Modifier and Type	Method and Description
static MaintenanceWindowExecutionTaskInvocationIdentity.Builder	builder()
Instant	endTime() The time the invocation finished.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionId() The ID of the action performed in the service that actually handled the task invocation.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	invocationId() The ID of the task invocation.
String	ownerInformation() User-provided value that was specified when the target was registered with the maintenance window.
String	parameters() The parameters that were provided for the invocation when it was run.
List<SdkField<?>>	sdkFields()
static Class<? extends MaintenanceWindowExecutionTaskInvocationIdentity.Builder>	serializableBuilderClass()
Instant	startTime() The time the invocation started.
MaintenanceWindowExecutionStatus	status() The status of the task invocation.
String	statusAsString() The status of the task invocation.
String	statusDetails() The details explaining the status of the task invocation.
String	taskExecutionId() The ID of the specific task execution in the maintenance window execution.
MaintenanceWindowTaskType	taskType() The task type.
String	taskTypeAsString() The task type.
MaintenanceWindowExecutionTaskInvocationIdentity.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	windowExecutionId() The ID of the maintenance window execution that ran the task.
String	windowTargetId() The ID of the target definition in this maintenance window the invocation was performed for.

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

windowExecutionId

public String windowExecutionId()

The ID of the maintenance window execution that ran the task.

Returns:

The ID of the maintenance window execution that ran the task.

taskExecutionId

public String taskExecutionId()

The ID of the specific task execution in the maintenance window execution.

Returns:

The ID of the specific task execution in the maintenance window execution.

invocationId

public String invocationId()

The ID of the task invocation.

Returns:

The ID of the task invocation.

executionId

public String executionId()

The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.

Returns:

The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.

taskType

public MaintenanceWindowTaskType taskType()

The task type.

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

Returns:

The task type.

See Also:

MaintenanceWindowTaskType

taskTypeAsString

public String taskTypeAsString()

The task type.

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

Returns:

The task type.

See Also:

MaintenanceWindowTaskType

parameters

public String parameters()

The parameters that were provided for the invocation when it was run.

Returns:

The parameters that were provided for the invocation when it was run.

status

public MaintenanceWindowExecutionStatus status()

The status of the task invocation.

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

Returns:

The status of the task invocation.

See Also:

MaintenanceWindowExecutionStatus

statusAsString

public String statusAsString()

The status of the task invocation.

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

Returns:

The status of the task invocation.

See Also:

MaintenanceWindowExecutionStatus

statusDetails

public String statusDetails()

The details explaining the status of the task invocation. Only available for certain Status values.

Returns:

The details explaining the status of the task invocation. Only available for certain Status values.

startTime

public Instant startTime()

The time the invocation started.

Returns:

The time the invocation started.

endTime

public Instant endTime()

The time the invocation finished.

Returns:

The time the invocation finished.

ownerInformation

public String ownerInformation()

User-provided value that was specified when the target was registered with the maintenance window. This was also included in any CloudWatch events raised during the task invocation.

Returns:

User-provided value that was specified when the target was registered with the maintenance window. This was also included in any CloudWatch events raised during the task invocation.

windowTargetId

public String windowTargetId()

The ID of the target definition in this maintenance window the invocation was performed for.

Returns:

The ID of the target definition in this maintenance window the invocation was performed for.

toBuilder

public MaintenanceWindowExecutionTaskInvocationIdentity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MaintenanceWindowExecutionTaskInvocationIdentity.Builder,MaintenanceWindowExecutionTaskInvocationIdentity>

builder

public static MaintenanceWindowExecutionTaskInvocationIdentity.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo