GetMaintenanceWindowTaskResponse (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.5.8 API)

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.GetMaintenanceWindowTaskResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetMaintenanceWindowTaskResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetMaintenanceWindowTaskResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetMaintenanceWindowTaskResponse.Builder`	`builder()`
`String`	`description()` The retrieved task description.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`LoggingInfo`	`loggingInfo()` The location in 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 executes.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetMaintenanceWindowTaskResponse.Builder>`	`serializableBuilderClass()`
`String`	`serviceRoleArn()` The IAM service role to assume during task execution.
`List<Target>`	`targets()` The targets where the task should execute.
`String`	`taskArn()` The resource that the task used during execution.
`MaintenanceWindowTaskInvocationParameters`	`taskInvocationParameters()` The parameters to pass to the task when it executes.
`Map<String,MaintenanceWindowTaskParameterValueExpression>`	`taskParameters()` The parameters to pass to the task when it executes.
`MaintenanceWindowTaskType`	`taskType()` The type of task to execute.
`String`	`taskTypeAsString()` The type of task to execute.
`GetMaintenanceWindowTaskResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`windowId()` The retrieved Maintenance Window ID.
`String`	`windowTaskId()` The retrieved Maintenance Window task ID.

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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - windowId
```
public String windowId()
```
    The retrieved Maintenance Window ID.
    
    Returns:
    
    The retrieved Maintenance Window ID.
  - windowTaskId
```
public String windowTaskId()
```
    The retrieved Maintenance Window task ID.
    
    Returns:
    
    The retrieved Maintenance Window task ID.
  - targets
```
public List<Target> targets()
```
    The targets where the task should execute.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The targets where the task should execute.
  - taskArn
```
public 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.
    
    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.
  - serviceRoleArn
```
public String serviceRoleArn()
```
    The IAM service role to assume during task execution.
    
    Returns:
    
    The IAM service role to assume during task execution.
  - taskType
```
public MaintenanceWindowTaskType taskType()
```
    The type of task to execute.
    
    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().
    
    Returns:
    
    The type of task to execute.
    
    See Also:
    
    MaintenanceWindowTaskType
  - taskTypeAsString
```
public String taskTypeAsString()
```
    The type of task to execute.
    
    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().
    
    Returns:
    
    The type of task to execute.
    
    See Also:
    
    MaintenanceWindowTaskType
  - taskParameters
```
public Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters()
```
    The parameters to pass to the task when it executes.
    
    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.
    
    Returns:
    
    The parameters to pass to the task when it executes.
    
    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.
  - taskInvocationParameters
```
public MaintenanceWindowTaskInvocationParameters taskInvocationParameters()
```
    The parameters to pass to the task when it executes.
    
    Returns:
    
    The parameters to pass to the task when it executes.
  - priority
```
public Integer priority()
```
    The priority of the task when it executes. 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 executes. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
  - maxConcurrency
```
public String maxConcurrency()
```
    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.
  - maxErrors
```
public String maxErrors()
```
    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.
  - loggingInfo
```
public 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.
    
    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.
  - name
```
public String name()
```
    The retrieved task name.
    
    Returns:
    
    The retrieved task name.
  - description
```
public String description()
```
    The retrieved task description.
    
    Returns:
    
    The retrieved task description.
  - toBuilder
```
public GetMaintenanceWindowTaskResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetMaintenanceWindowTaskResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetMaintenanceWindowTaskResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetMaintenanceWindowTaskResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

windowId

windowTaskId

targets

taskArn

serviceRoleArn

taskType

taskTypeAsString

taskParameters

taskInvocationParameters

priority

maxConcurrency

maxErrors

loggingInfo

name

description

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields