@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()
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.
|
responseMetadata
sdkHttpResponse
copy
public 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 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()
.
MaintenanceWindowTaskType
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()
.
MaintenanceWindowTaskType
public final boolean hasTaskParameters()
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.
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
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()
.
MaintenanceWindowExecutionStatus
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()
.
MaintenanceWindowExecutionStatus
public final String statusDetails()
The details explaining the Status. Only available for certain 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()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetMaintenanceWindowExecutionTaskResponse.Builder,GetMaintenanceWindowExecutionTaskResponse>
toBuilder
in class AwsResponse
public static GetMaintenanceWindowExecutionTaskResponse.Builder builder()
public static Class<? extends GetMaintenanceWindowExecutionTaskResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
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.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.