software.amazon.awssdk.services.ssm.model

Class GetMaintenanceWindowExecutionResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetMaintenanceWindowExecutionResponse.Builder,GetMaintenanceWindowExecutionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetMaintenanceWindowExecutionResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetMaintenanceWindowExecutionResponse.Builder	builder()
Instant	endTime() The time the maintenance window finished running.
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	hasTaskIds() For responses, this returns true if the service returned a value for the TaskIds property.
List<SdkField<?>>	sdkFields()
static Class<? extends GetMaintenanceWindowExecutionResponse.Builder>	serializableBuilderClass()
Instant	startTime() The time the maintenance window started running.
MaintenanceWindowExecutionStatus	status() The status of the maintenance window execution.
String	statusAsString() The status of the maintenance window execution.
String	statusDetails() The details explaining the status.
List<String>	taskIds() The ID of the task executions from the maintenance window execution.
GetMaintenanceWindowExecutionResponse.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	windowExecutionId() The ID of the maintenance window execution.

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

windowExecutionId

public final String windowExecutionId()

The ID of the maintenance window execution.

Returns:

The ID of the maintenance window execution.

hasTaskIds

public final boolean hasTaskIds()

For responses, this returns true if the service returned a value for the TaskIds property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

taskIds

public final List<String> taskIds()

The ID of the task executions from the maintenance window execution.

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

Returns:

The ID of the task executions from the maintenance window execution.

status

public final MaintenanceWindowExecutionStatus status()

The status of the maintenance window execution.

If the service returns an enum value that is not available in the current SDK version, status will return MaintenanceWindowExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the maintenance window execution.

See Also:

MaintenanceWindowExecutionStatus

statusAsString

public final String statusAsString()

The status of the maintenance window execution.

If the service returns an enum value that is not available in the current SDK version, status will return MaintenanceWindowExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the maintenance window execution.

See Also:

MaintenanceWindowExecutionStatus

statusDetails

public final String statusDetails()

The details explaining the status. Not available for all status values.

Returns:

The details explaining the status. Not available for all status values.

startTime

public final Instant startTime()

The time the maintenance window started running.

Returns:

The time the maintenance window started running.

endTime

public final Instant endTime()

The time the maintenance window finished running.

Returns:

The time the maintenance window finished running.

toBuilder

public GetMaintenanceWindowExecutionResponse.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<GetMaintenanceWindowExecutionResponse.Builder,GetMaintenanceWindowExecutionResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetMaintenanceWindowExecutionResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetMaintenanceWindowExecutionResponse.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.