GetMaintenanceWindowTaskResult (AWS Java SDK for the AWS Simple Systems Management (SSM) Service 1.11.563 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.simplesystemsmanagement.model.GetMaintenanceWindowTaskResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetMaintenanceWindowTaskResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetMaintenanceWindowTaskResult()

Constructors
Constructor and Description
`GetMaintenanceWindowTaskResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetMaintenanceWindowTaskResult`	`addTaskParametersEntry(String key, MaintenanceWindowTaskParameterValueExpression value)`
`GetMaintenanceWindowTaskResult`	`clearTaskParametersEntries()` Removes all the entries added into TaskParameters.
`GetMaintenanceWindowTaskResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` The retrieved task description.
`LoggingInfo`	`getLoggingInfo()` The location in Amazon S3 where the task results are logged.
`String`	`getMaxConcurrency()` The maximum number of targets allowed to run this task in parallel.
`String`	`getMaxErrors()` The maximum number of errors allowed before the task stops being scheduled.
`String`	`getName()` The retrieved task name.
`Integer`	`getPriority()` The priority of the task when it runs.
`String`	`getServiceRoleArn()` The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
`List<Target>`	`getTargets()` The targets where the task should run.
`String`	`getTaskArn()` The resource that the task used during execution.
`MaintenanceWindowTaskInvocationParameters`	`getTaskInvocationParameters()` The parameters to pass to the task when it runs.
`Map<String,MaintenanceWindowTaskParameterValueExpression>`	`getTaskParameters()` The parameters to pass to the task when it runs.
`String`	`getTaskType()` The type of task to run.
`String`	`getWindowId()` The retrieved maintenance window ID.
`String`	`getWindowTaskId()` The retrieved maintenance window task ID.
`int`	`hashCode()`
`void`	`setDescription(String description)` The retrieved task description.
`void`	`setLoggingInfo(LoggingInfo loggingInfo)` The location in Amazon S3 where the task results are logged.
`void`	`setMaxConcurrency(String maxConcurrency)` The maximum number of targets allowed to run this task in parallel.
`void`	`setMaxErrors(String maxErrors)` The maximum number of errors allowed before the task stops being scheduled.
`void`	`setName(String name)` The retrieved task name.
`void`	`setPriority(Integer priority)` The priority of the task when it runs.
`void`	`setServiceRoleArn(String serviceRoleArn)` The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
`void`	`setTargets(Collection<Target> targets)` The targets where the task should run.
`void`	`setTaskArn(String taskArn)` The resource that the task used during execution.
`void`	`setTaskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)` The parameters to pass to the task when it runs.
`void`	`setTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)` The parameters to pass to the task when it runs.
`void`	`setTaskType(String taskType)` The type of task to run.
`void`	`setWindowId(String windowId)` The retrieved maintenance window ID.
`void`	`setWindowTaskId(String windowTaskId)` The retrieved maintenance window task ID.
`String`	`toString()` Returns a string representation of this object.
`GetMaintenanceWindowTaskResult`	`withDescription(String description)` The retrieved task description.
`GetMaintenanceWindowTaskResult`	`withLoggingInfo(LoggingInfo loggingInfo)` The location in Amazon S3 where the task results are logged.
`GetMaintenanceWindowTaskResult`	`withMaxConcurrency(String maxConcurrency)` The maximum number of targets allowed to run this task in parallel.
`GetMaintenanceWindowTaskResult`	`withMaxErrors(String maxErrors)` The maximum number of errors allowed before the task stops being scheduled.
`GetMaintenanceWindowTaskResult`	`withName(String name)` The retrieved task name.
`GetMaintenanceWindowTaskResult`	`withPriority(Integer priority)` The priority of the task when it runs.
`GetMaintenanceWindowTaskResult`	`withServiceRoleArn(String serviceRoleArn)` The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
`GetMaintenanceWindowTaskResult`	`withTargets(Collection<Target> targets)` The targets where the task should run.
`GetMaintenanceWindowTaskResult`	`withTargets(Target... targets)` The targets where the task should run.
`GetMaintenanceWindowTaskResult`	`withTaskArn(String taskArn)` The resource that the task used during execution.
`GetMaintenanceWindowTaskResult`	`withTaskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)` The parameters to pass to the task when it runs.
`GetMaintenanceWindowTaskResult`	`withTaskParameters(Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters)` The parameters to pass to the task when it runs.
`GetMaintenanceWindowTaskResult`	`withTaskType(MaintenanceWindowTaskType taskType)` The type of task to run.
`GetMaintenanceWindowTaskResult`	`withTaskType(String taskType)` The type of task to run.
`GetMaintenanceWindowTaskResult`	`withWindowId(String windowId)` The retrieved maintenance window ID.
`GetMaintenanceWindowTaskResult`	`withWindowTaskId(String windowTaskId)` The retrieved maintenance window task ID.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetMaintenanceWindowTaskResult
```
public GetMaintenanceWindowTaskResult()
```
- Method Detail
  - setWindowId
```
public void setWindowId(String windowId)
```
    The retrieved maintenance window ID.
    
    Parameters:
    
    windowId - The retrieved maintenance window ID.
  - getWindowId
```
public String getWindowId()
```
    The retrieved maintenance window ID.
    
    Returns:
    
    The retrieved maintenance window ID.
  - withWindowId
```
public GetMaintenanceWindowTaskResult withWindowId(String windowId)
```
    The retrieved maintenance window ID.
    
    Parameters:
    
    windowId - The retrieved maintenance window ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWindowTaskId
```
public void setWindowTaskId(String windowTaskId)
```
    The retrieved maintenance window task ID.
    
    Parameters:
    
    windowTaskId - The retrieved maintenance window task ID.
  - getWindowTaskId
```
public String getWindowTaskId()
```
    The retrieved maintenance window task ID.
    
    Returns:
    
    The retrieved maintenance window task ID.
  - withWindowTaskId
```
public GetMaintenanceWindowTaskResult withWindowTaskId(String windowTaskId)
```
    The retrieved maintenance window task ID.
    
    Parameters:
    
    windowTaskId - The retrieved maintenance window task ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTargets
```
public List<Target> getTargets()
```
    The targets where the task should run.
    
    Returns:
    
    The targets where the task should run.
  - setTargets
```
public void setTargets(Collection<Target> targets)
```
    The targets where the task should run.
    
    Parameters:
    
    targets - The targets where the task should run.
  - withTargets
```
public GetMaintenanceWindowTaskResult withTargets(Target... targets)
```
    The targets where the task should run.
    
    NOTE: This method appends the values to the existing list (if any). Use setTargets(java.util.Collection) or withTargets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    targets - The targets where the task should run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargets
```
public GetMaintenanceWindowTaskResult withTargets(Collection<Target> targets)
```
    The targets where the task should run.
    
    Parameters:
    
    targets - The targets where the task should run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskArn
```
public void setTaskArn(String taskArn)
```
    The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTION tasks, the value is the state machine ARN.
    
    Parameters:
    
    taskArn - The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTION tasks, the value is the state machine ARN.
  - getTaskArn
```
public String getTaskArn()
```
    The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTION tasks, the value is the state machine ARN.
    
    Returns:
    
    The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTION tasks, the value is the state machine ARN.
  - withTaskArn
```
public GetMaintenanceWindowTaskResult withTaskArn(String taskArn)
```
    The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTION tasks, the value is the state machine ARN.
    
    Parameters:
    
    taskArn - The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTION tasks, the value is the state machine ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceRoleArn
```
public void setServiceRoleArn(String serviceRoleArn)
```
    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
    
    Parameters:
    
    serviceRoleArn - The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
  - getServiceRoleArn
```
public String getServiceRoleArn()
```
    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
    
    Returns:
    
    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
  - withServiceRoleArn
```
public GetMaintenanceWindowTaskResult withServiceRoleArn(String serviceRoleArn)
```
    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
    
    Parameters:
    
    serviceRoleArn - The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskType
```
public void setTaskType(String taskType)
```
    The type of task to run.
    
    Parameters:
    
    taskType - The type of task to run.
    
    See Also:
    
    MaintenanceWindowTaskType
  - getTaskType
```
public String getTaskType()
```
    The type of task to run.
    
    Returns:
    
    The type of task to run.
    
    See Also:
    
    MaintenanceWindowTaskType
  - withTaskType
```
public GetMaintenanceWindowTaskResult withTaskType(String taskType)
```
    The type of task to run.
    
    Parameters:
    
    taskType - The type of task to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaintenanceWindowTaskType
  - withTaskType
```
public GetMaintenanceWindowTaskResult withTaskType(MaintenanceWindowTaskType taskType)
```
    The type of task to run.
    
    Parameters:
    
    taskType - The type of task to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MaintenanceWindowTaskType
  - getTaskParameters
```
public Map<String,MaintenanceWindowTaskParameterValueExpression> getTaskParameters()
```
    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.
    
    Returns:
    
    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.
  - setTaskParameters
```
public void setTaskParameters(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.
    
    Parameters:
    
    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.
  - withTaskParameters
```
public GetMaintenanceWindowTaskResult withTaskParameters(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTaskParametersEntry
```
public GetMaintenanceWindowTaskResult addTaskParametersEntry(String key,
                                                             MaintenanceWindowTaskParameterValueExpression value)
```
  - clearTaskParametersEntries
```
public GetMaintenanceWindowTaskResult clearTaskParametersEntries()
```
    Removes all the entries added into TaskParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskInvocationParameters
```
public void setTaskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)
```
    The parameters to pass to the task when it runs.
    
    Parameters:
    
    taskInvocationParameters - The parameters to pass to the task when it runs.
  - getTaskInvocationParameters
```
public MaintenanceWindowTaskInvocationParameters getTaskInvocationParameters()
```
    The parameters to pass to the task when it runs.
    
    Returns:
    
    The parameters to pass to the task when it runs.
  - withTaskInvocationParameters
```
public GetMaintenanceWindowTaskResult withTaskInvocationParameters(MaintenanceWindowTaskInvocationParameters taskInvocationParameters)
```
    The parameters to pass to the task when it runs.
    
    Parameters:
    
    taskInvocationParameters - The parameters to pass to the task when it runs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(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.
    
    Parameters:
    
    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.
  - getPriority
```
public Integer getPriority()
```
    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.
    
    Returns:
    
    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.
  - withPriority
```
public GetMaintenanceWindowTaskResult withPriority(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxConcurrency
```
public void setMaxConcurrency(String maxConcurrency)
```
    The maximum number of targets allowed to run this task in parallel.
    
    Parameters:
    
    maxConcurrency - The maximum number of targets allowed to run this task in parallel.
  - getMaxConcurrency
```
public String getMaxConcurrency()
```
    The maximum number of targets allowed to run this task in parallel.
    
    Returns:
    
    The maximum number of targets allowed to run this task in parallel.
  - withMaxConcurrency
```
public GetMaintenanceWindowTaskResult withMaxConcurrency(String maxConcurrency)
```
    The maximum number of targets allowed to run this task in parallel.
    
    Parameters:
    
    maxConcurrency - The maximum number of targets allowed to run this task in parallel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxErrors
```
public void setMaxErrors(String maxErrors)
```
    The maximum number of errors allowed before the task stops being scheduled.
    
    Parameters:
    
    maxErrors - The maximum number of errors allowed before the task stops being scheduled.
  - getMaxErrors
```
public String getMaxErrors()
```
    The maximum number of errors allowed before the task stops being scheduled.
    
    Returns:
    
    The maximum number of errors allowed before the task stops being scheduled.
  - withMaxErrors
```
public GetMaintenanceWindowTaskResult withMaxErrors(String maxErrors)
```
    The maximum number of errors allowed before the task stops being scheduled.
    
    Parameters:
    
    maxErrors - The maximum number of errors allowed before the task stops being scheduled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLoggingInfo
```
public void setLoggingInfo(LoggingInfo loggingInfo)
```
    The location in Amazon S3 where the task results are logged.
    
    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
    
    Parameters:
    
    loggingInfo - The location in Amazon S3 where the task results are logged.
    
    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
  - getLoggingInfo
```
public LoggingInfo getLoggingInfo()
```
    The location in Amazon S3 where the task results are logged.
    
    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
    
    Returns:
    
    The location in Amazon S3 where the task results are logged.
    
    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
  - withLoggingInfo
```
public GetMaintenanceWindowTaskResult withLoggingInfo(LoggingInfo loggingInfo)
```
    The location in Amazon S3 where the task results are logged.
    
    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
    
    Parameters:
    
    loggingInfo - The location in Amazon S3 where the task results are logged.
    
    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The retrieved task name.
    
    Parameters:
    
    name - The retrieved task name.
  - getName
```
public String getName()
```
    The retrieved task name.
    
    Returns:
    
    The retrieved task name.
  - withName
```
public GetMaintenanceWindowTaskResult withName(String name)
```
    The retrieved task name.
    
    Parameters:
    
    name - The retrieved task name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The retrieved task description.
    
    Parameters:
    
    description - The retrieved task description.
  - getDescription
```
public String getDescription()
```
    The retrieved task description.
    
    Returns:
    
    The retrieved task description.
  - withDescription
```
public GetMaintenanceWindowTaskResult withDescription(String description)
```
    The retrieved task description.
    
    Parameters:
    
    description - The retrieved task description.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetMaintenanceWindowTaskResult clone()
```
    Overrides:
    
    clone in class Object

Class GetMaintenanceWindowTaskResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetMaintenanceWindowTaskResult

Method Detail

setWindowId

getWindowId

withWindowId

setWindowTaskId

getWindowTaskId

withWindowTaskId

getTargets

setTargets

withTargets

withTargets

setTaskArn

getTaskArn

withTaskArn

setServiceRoleArn

getServiceRoleArn

withServiceRoleArn

setTaskType

getTaskType

withTaskType

withTaskType

getTaskParameters

setTaskParameters

withTaskParameters

addTaskParametersEntry

clearTaskParametersEntries

setTaskInvocationParameters

getTaskInvocationParameters

withTaskInvocationParameters

setPriority

getPriority

withPriority

setMaxConcurrency

getMaxConcurrency

withMaxConcurrency

setMaxErrors

getMaxErrors

withMaxErrors

setLoggingInfo

getLoggingInfo

withLoggingInfo

setName

getName

withName

setDescription

getDescription

withDescription

toString

equals

hashCode

clone