RegisterTaskWithMaintenanceWindowRequest (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.0.0-preview-7 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.core.AwsRequest
  - - software.amazon.awssdk.services.ssm.model.SSMRequest
    - - software.amazon.awssdk.services.ssm.model.RegisterTaskWithMaintenanceWindowRequest

All Implemented Interfaces:: software.amazon.awssdk.utils.builder.ToCopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class RegisterTaskWithMaintenanceWindowRequest
extends SSMRequest
implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RegisterTaskWithMaintenanceWindowRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RegisterTaskWithMaintenanceWindowRequest.Builder`	`builder()`
`String`	`clientToken()` User-provided idempotency token.
`String`	`description()` An optional description for the task.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`LoggingInfo`	`loggingInfo()` A structure containing information about an Amazon S3 bucket to write instance-level logs to.
`String`	`maxConcurrency()` The maximum number of targets this task can be run for in parallel.
`String`	`maxErrors()` The maximum number of errors allowed before this task stops being scheduled.
`String`	`name()` An optional name for the task.
`Integer`	`priority()` The priority of the task in the Maintenance Window, the lower the number the higher the priority.
`static Class<? extends RegisterTaskWithMaintenanceWindowRequest.Builder>`	`serializableBuilderClass()`
`String`	`serviceRoleArn()` The role that should be assumed when executing the task.
`List<Target>`	`targets()` The targets (either instances or tags).
`String`	`taskArn()` The ARN of the task to execute
`MaintenanceWindowTaskInvocationParameters`	`taskInvocationParameters()` The parameters that the task should use during execution.
`Map<String,MaintenanceWindowTaskParameterValueExpression>`	`taskParameters()` The parameters that should be passed to the task when it is executed.
`MaintenanceWindowTaskType`	`taskType()` The type of task being registered.
`String`	`taskTypeString()` The type of task being registered.
`RegisterTaskWithMaintenanceWindowRequest.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`windowId()` The id of the Maintenance Window the task should be added to.

Methods inherited from class software.amazon.awssdk.core.AwsRequest
requestOverrideConfig

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 id of the Maintenance Window the task should be added to.
    
    Returns:
    
    The id of the Maintenance Window the task should be added to.
  - targets
```
public List<Target> targets()
```
    The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.
  - taskArn
```
public String taskArn()
```
    The ARN of the task to execute
    
    Returns:
    
    The ARN of the task to execute
  - serviceRoleArn
```
public String serviceRoleArn()
```
    The role that should be assumed when executing the task.
    
    Returns:
    
    The role that should be assumed when executing the task.
  - taskType
```
public MaintenanceWindowTaskType taskType()
```
    The type of task being registered.
    
    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 taskTypeString().
    
    Returns:
    
    The type of task being registered.
    
    See Also:
    
    MaintenanceWindowTaskType
  - taskTypeString
```
public String taskTypeString()
```
    The type of task being registered.
    
    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 taskTypeString().
    
    Returns:
    
    The type of task being registered.
    
    See Also:
    
    MaintenanceWindowTaskType
  - taskParameters
```
public Map<String,MaintenanceWindowTaskParameterValueExpression> taskParameters()
```
    The parameters that should be passed to the task when it is executed.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The parameters that should be passed to the task when it is executed.
  - taskInvocationParameters
```
public MaintenanceWindowTaskInvocationParameters taskInvocationParameters()
```
    The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
    
    Returns:
    
    The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
  - priority
```
public Integer priority()
```
    The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
    
    Returns:
    
    The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
  - maxConcurrency
```
public String maxConcurrency()
```
    The maximum number of targets this task can be run for in parallel.
    
    Returns:
    
    The maximum number of targets this task can be run for in parallel.
  - maxErrors
```
public String maxErrors()
```
    The maximum number of errors allowed before this task stops being scheduled.
    
    Returns:
    
    The maximum number of errors allowed before this task stops being scheduled.
  - loggingInfo
```
public LoggingInfo loggingInfo()
```
    A structure containing information about an Amazon S3 bucket to write instance-level logs to.
    
    Returns:
    
    A structure containing information about an Amazon S3 bucket to write instance-level logs to.
  - name
```
public String name()
```
    An optional name for the task.
    
    Returns:
    
    An optional name for the task.
  - description
```
public String description()
```
    An optional description for the task.
    
    Returns:
    
    An optional description for the task.
  - clientToken
```
public String clientToken()
```
    User-provided idempotency token.
    
    Returns:
    
    User-provided idempotency token.
  - toBuilder
```
public RegisterTaskWithMaintenanceWindowRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<RegisterTaskWithMaintenanceWindowRequest.Builder,RegisterTaskWithMaintenanceWindowRequest>
    
    Specified by:
    
    toBuilder in class SSMRequest
  - builder
```
public static RegisterTaskWithMaintenanceWindowRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegisterTaskWithMaintenanceWindowRequest.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()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest

Class RegisterTaskWithMaintenanceWindowRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

windowId

targets

taskArn

serviceRoleArn

taskType

taskTypeString

taskParameters

taskInvocationParameters

priority

maxConcurrency

maxErrors

loggingInfo

name

description

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField