@Generated(value="software.amazon.awssdk:codegen") public final class GetMaintenanceWindowExecutionTaskResponse extends SsmResponse implements ToCopyableBuilder<GetMaintenanceWindowExecutionTaskResponse.Builder,GetMaintenanceWindowExecutionTaskResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetMaintenanceWindowExecutionTaskResponse.Builder |
| 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()
For responses, this returns true if the service returned a value for the TaskParameters property.
|
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 Amazon Resource Name (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.
|
responseMetadatasdkHttpResponsecopypublic final String windowExecutionId()
The ID of the maintenance window execution that includes the task.
public final String taskExecutionId()
The ID of the specific task execution in the maintenance window task that was retrieved.
public final String taskArn()
The Amazon Resource Name (ARN) of the task that ran.
public final String serviceRole()
The role that was assumed when running the task.
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().
MaintenanceWindowTaskTypepublic 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().
MaintenanceWindowTaskTypepublic final boolean hasTaskParameters()
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.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 between 1 and 255 characters
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 hasTaskParameters() method.
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 between 1 and 255 characters
public final Integer priority()
The priority of the task.
public final String maxConcurrency()
The defined maximum number of task executions that could be run in parallel.
public final String maxErrors()
The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.
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().
MaintenanceWindowExecutionStatuspublic 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().
MaintenanceWindowExecutionStatuspublic final String statusDetails()
The details explaining the status. Not available for all status values.
public final Instant startTime()
The time the task execution started.
public final Instant endTime()
The time the task execution completed.
public GetMaintenanceWindowExecutionTaskResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<GetMaintenanceWindowExecutionTaskResponse.Builder,GetMaintenanceWindowExecutionTaskResponse>toBuilder in class AwsResponsepublic static GetMaintenanceWindowExecutionTaskResponse.Builder builder()
public static Class<? extends GetMaintenanceWindowExecutionTaskResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. 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.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.