@Generated(value="software.amazon.awssdk:codegen") public final class GetMaintenanceWindowTaskResponse extends SsmResponse implements ToCopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetMaintenanceWindowTaskResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GetMaintenanceWindowTaskResponse.Builder |
builder() |
MaintenanceWindowTaskCutoffBehavior |
cutoffBehavior()
The action to take on tasks when the maintenance window cutoff time is reached.
|
String |
cutoffBehaviorAsString()
The action to take on tasks when the maintenance window cutoff time is reached.
|
String |
description()
The retrieved task description.
|
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 |
hasTargets()
For responses, this returns true if the service returned a value for the Targets property.
|
boolean |
hasTaskParameters()
For responses, this returns true if the service returned a value for the TaskParameters property.
|
LoggingInfo |
loggingInfo()
The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.
|
String |
maxConcurrency()
The maximum number of targets allowed to run this task in parallel.
|
String |
maxErrors()
The maximum number of errors allowed before the task stops being scheduled.
|
String |
name()
The retrieved task name.
|
Integer |
priority()
The priority of the task when it runs.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetMaintenanceWindowTaskResponse.Builder> |
serializableBuilderClass() |
String |
serviceRoleArn()
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon
Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
|
List<Target> |
targets()
The targets where the task should run.
|
String |
taskArn()
The resource that the task used during execution.
|
MaintenanceWindowTaskInvocationParameters |
taskInvocationParameters()
The parameters to pass to the task when it runs.
|
Map<String,MaintenanceWindowTaskParameterValueExpression> |
taskParameters()
The parameters to pass to the task when it runs.
|
MaintenanceWindowTaskType |
taskType()
The type of task to run.
|
String |
taskTypeAsString()
The type of task to run.
|
GetMaintenanceWindowTaskResponse.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.
|
String |
windowId()
The retrieved maintenance window ID.
|
String |
windowTaskId()
The retrieved maintenance window task ID.
|
responseMetadatasdkHttpResponsecopypublic final String windowId()
The retrieved maintenance window ID.
public final String windowTaskId()
The retrieved maintenance window task ID.
public final boolean hasTargets()
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<Target> targets()
The targets where the task should run.
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 hasTargets() method.
public final String taskArn()
The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task
types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value
is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.
RUN_COMMAND and
AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For
LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the
value is the state machine ARN.public final String serviceRoleArn()
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
public final MaintenanceWindowTaskType taskType()
The type of task to run.
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().
MaintenanceWindowTaskTypepublic final String taskTypeAsString()
The type of task to run.
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().
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 Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters()
The parameters to pass to the task when it runs.
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.
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.
public final MaintenanceWindowTaskInvocationParameters taskInvocationParameters()
The parameters to pass to the task when it runs.
public final Integer priority()
The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
public final String maxConcurrency()
The maximum number of targets allowed to run this task in parallel.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the
system inserts a placeholder value of 1, which may be reported in the response to this command. This
value doesn't affect the running of your task and can be ignored.
For maintenance window tasks without a target specified, you can't supply a value for this option.
Instead, the system inserts a placeholder value of 1, which may be reported in the response
to this command. This value doesn't affect the running of your task and can be ignored.
public final String maxErrors()
The maximum number of errors allowed before the task stops being scheduled.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the
system inserts a placeholder value of 1, which may be reported in the response to this command. This
value doesn't affect the running of your task and can be ignored.
For maintenance window tasks without a target specified, you can't supply a value for this option.
Instead, the system inserts a placeholder value of 1, which may be reported in the response
to this command. This value doesn't affect the running of your task and can be ignored.
public final LoggingInfo loggingInfo()
The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to
contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the
TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager
handles these options for the supported maintenance window task types, see
MaintenanceWindowTaskInvocationParameters.
LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3)
bucket to contain logs, instead use the OutputS3BucketName and
OutputS3KeyPrefix options in the TaskInvocationParameters structure. For
information about how Amazon Web Services Systems Manager handles these options for the supported
maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
public final String name()
The retrieved task name.
public final String description()
The retrieved task description.
public final MaintenanceWindowTaskCutoffBehavior cutoffBehavior()
The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means
that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that
currently running task invocations continue, but no new task invocations are started. For Run Command tasks,
CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand
operation.
If the service returns an enum value that is not available in the current SDK version, cutoffBehavior
will return MaintenanceWindowTaskCutoffBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the
service is available from cutoffBehaviorAsString().
CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions
tasks, CANCEL_TASK means that currently running task invocations continue, but no new task
invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to
stop the task by sending a CancelCommand operation.MaintenanceWindowTaskCutoffBehaviorpublic final String cutoffBehaviorAsString()
The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means
that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that
currently running task invocations continue, but no new task invocations are started. For Run Command tasks,
CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand
operation.
If the service returns an enum value that is not available in the current SDK version, cutoffBehavior
will return MaintenanceWindowTaskCutoffBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the
service is available from cutoffBehaviorAsString().
CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions
tasks, CANCEL_TASK means that currently running task invocations continue, but no new task
invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to
stop the task by sending a CancelCommand operation.MaintenanceWindowTaskCutoffBehaviorpublic GetMaintenanceWindowTaskResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>toBuilder in class AwsResponsepublic static GetMaintenanceWindowTaskResponse.Builder builder()
public static Class<? extends GetMaintenanceWindowTaskResponse.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.