software.amazon.awssdk.services.ssm.model

Class GetMaintenanceWindowTaskResponse

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

Method Summary

Modifier and Type	Method and Description
static GetMaintenanceWindowTaskResponse.Builder	builder()
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() Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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).
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 runs.
List<SdkField<?>>	sdkFields()
static Class<? extends GetMaintenanceWindowTaskResponse.Builder>	serializableBuilderClass()
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.
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.

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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

windowId

public final String windowId()

The retrieved maintenance window ID.

Returns:

The retrieved maintenance window ID.

windowTaskId

public final String windowTaskId()

The retrieved maintenance window task ID.

Returns:

The retrieved maintenance window task ID.

hasTargets

public final boolean hasTargets()

Returns true if the Targets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

targets

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.

You can use hasTargets() to see if a value was sent in this field.

Returns:

The targets where the task should run.

taskArn

public final 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_FUNCTIONS 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_FUNCTIONS tasks, the value is the state machine ARN.

serviceRoleArn

public final 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.

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.

taskType

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().

Returns:

The type of task to run.

See Also:

MaintenanceWindowTaskType

taskTypeAsString

public 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().

Returns:

The type of task to run.

See Also:

MaintenanceWindowTaskType

hasTaskParameters

public final 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). For responses returned by the SDK, the sender is the AWS service.

taskParameters

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.

You can use hasTaskParameters() to see if a value was sent in this field.

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.

taskInvocationParameters

public final MaintenanceWindowTaskInvocationParameters taskInvocationParameters()

The parameters to pass to the task when it runs.

Returns:

The parameters to pass to the task when it runs.

priority

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.

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.

maxConcurrency

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 cannot 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 does not affect the running of your task and can be ignored.

Returns:

The maximum number of targets allowed to run this task in parallel.

For maintenance window tasks without a target specified, you cannot 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 does not affect the running of your task and can be ignored.

maxErrors

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 cannot 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 does not affect the running of your task and can be ignored.

Returns:

The maximum number of errors allowed before the task stops being scheduled.

For maintenance window tasks without a target specified, you cannot 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 does not affect the running of your task and can be ignored.

loggingInfo

public final 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 final String name()

The retrieved task name.

Returns:

The retrieved task name.

description

public final String description()

The retrieved task description.

Returns:

The retrieved task description.

toBuilder

public GetMaintenanceWindowTaskResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetMaintenanceWindowTaskResponse.Builder,GetMaintenanceWindowTaskResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetMaintenanceWindowTaskResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetMaintenanceWindowTaskResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.