software.amazon.awssdk.services.ssm.model

Class GetMaintenanceWindowExecutionTaskResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ssm.model.SsmResponse

software.amazon.awssdk.services.ssm.model.GetMaintenanceWindowExecutionTaskResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetMaintenanceWindowExecutionTaskResponse.Builder,GetMaintenanceWindowExecutionTaskResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetMaintenanceWindowExecutionTaskResponse
extends SsmResponse
implements ToCopyableBuilder<GetMaintenanceWindowExecutionTaskResponse.Builder,GetMaintenanceWindowExecutionTaskResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetMaintenanceWindowExecutionTaskResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetMaintenanceWindowExecutionTaskResponse.Builder	builder()
Instant	endTime() The time the task execution completed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
boolean	hasTaskParameters() Returns true if the TaskParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	maxConcurrency() The defined maximum number of task executions that could be run in parallel.
String	maxErrors() The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.
Integer	priority() The priority of the task.
List<SdkField<?>>	sdkFields()
static Class<? extends GetMaintenanceWindowExecutionTaskResponse.Builder>	serializableBuilderClass()
String	serviceRole() The role that was assumed when running the task.
Instant	startTime() The time the task execution started.
MaintenanceWindowExecutionStatus	status() The status of the task.
String	statusAsString() The status of the task.
String	statusDetails() The details explaining the Status.
String	taskArn() The ARN of the task that ran.
String	taskExecutionId() The ID of the specific task execution in the maintenance window task that was retrieved.
List<Map<String,MaintenanceWindowTaskParameterValueExpression>>	taskParameters() The parameters passed to the task when it was run.
GetMaintenanceWindowExecutionTaskResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
MaintenanceWindowTaskType	type() The type of task that was run.
String	typeAsString() The type of task that was run.
String	windowExecutionId() The ID of the maintenance window execution that includes the task.

Methods inherited from class software.amazon.awssdk.services.ssm.model.SsmResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

windowExecutionId

public final String windowExecutionId()

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

Returns:

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

taskExecutionId

public final String taskExecutionId()

The ID of the specific task execution in the maintenance window task that was retrieved.

Returns:

The ID of the specific task execution in the maintenance window task that was retrieved.

taskArn

public final String taskArn()

The ARN of the task that ran.

Returns:

The ARN of the task that ran.

serviceRole

public final String serviceRole()

The role that was assumed when running the task.

Returns:

The role that was assumed when running the task.

type

public final MaintenanceWindowTaskType type()

The type of task that was run.

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

Returns:

The type of task that was run.

See Also:

MaintenanceWindowTaskType

typeAsString

public final String typeAsString()

The type of task that was run.

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

Returns:

The type of task that was run.

See Also:

MaintenanceWindowTaskType

hasTaskParameters

public final boolean hasTaskParameters()

Returns true if the TaskParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

taskParameters

public final List<Map<String,MaintenanceWindowTaskParameterValueExpression>> taskParameters()

The parameters passed to the task when it was run.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTaskParameters() to see if a value was sent in this field.

Returns:

The parameters passed to the task when it was run.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

Key: string, between 1 and 255 characters

Value: an array of strings, each string is between 1 and 255 characters

priority

public final Integer priority()

The priority of the task.

Returns:

The priority of the task.

maxConcurrency

public final String maxConcurrency()

The defined maximum number of task executions that could be run in parallel.

Returns:

The defined maximum number of task executions that could be run in parallel.

maxErrors

public final String maxErrors()

The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

Returns:

The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

status

public final MaintenanceWindowExecutionStatus status()

The status of the task.

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.

See Also:

MaintenanceWindowExecutionStatus

statusAsString

public final String statusAsString()

The status of the task.

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.

See Also:

MaintenanceWindowExecutionStatus

statusDetails

public final String statusDetails()

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

Returns:

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

startTime

public final Instant startTime()

The time the task execution started.

Returns:

The time the task execution started.

endTime

public final Instant endTime()

The time the task execution completed.

Returns:

The time the task execution completed.

toBuilder

public GetMaintenanceWindowExecutionTaskResponse.Builder 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 interface ToCopyableBuilder<GetMaintenanceWindowExecutionTaskResponse.Builder,GetMaintenanceWindowExecutionTaskResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetMaintenanceWindowExecutionTaskResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.