software.amazon.awssdk.services.ssm.model

Class DescribeMaintenanceWindowScheduleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.DescribeMaintenanceWindowScheduleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeMaintenanceWindowScheduleRequest.Builder,DescribeMaintenanceWindowScheduleRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeMaintenanceWindowScheduleRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeMaintenanceWindowScheduleRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
List<PatchOrchestratorFilter>	filters() Filters used to limit the range of results.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
boolean	hasTargets() For responses, this returns true if the service returned a value for the Targets property.
Integer	maxResults() The maximum number of items to return for this call.
String	nextToken() The token for the next set of items to return.
MaintenanceWindowResourceType	resourceType() The type of resource you want to retrieve information about.
String	resourceTypeAsString() The type of resource you want to retrieve information about.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeMaintenanceWindowScheduleRequest.Builder>	serializableBuilderClass()
List<Target>	targets() The instance ID or key-value pair to retrieve information about.
DescribeMaintenanceWindowScheduleRequest.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 ID of the maintenance window to retrieve information about.

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

overrideConfiguration

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 ID of the maintenance window to retrieve information about.

Returns:

The ID of the maintenance window to retrieve information about.

hasTargets

public final boolean hasTargets()

For responses, this returns true if the service returned a value for the Targets 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.

targets

public final List<Target> targets()

The instance ID or key-value pair to retrieve information about.

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

Returns:

The instance ID or key-value pair to retrieve information about.

resourceType

public final MaintenanceWindowResourceType resourceType()

The type of resource you want to retrieve information about. For example, INSTANCE.

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

Returns:

The type of resource you want to retrieve information about. For example, INSTANCE.

See Also:

MaintenanceWindowResourceType

resourceTypeAsString

public final String resourceTypeAsString()

The type of resource you want to retrieve information about. For example, INSTANCE.

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

Returns:

The type of resource you want to retrieve information about. For example, INSTANCE.

See Also:

MaintenanceWindowResourceType

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters 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.

filters

public final List<PatchOrchestratorFilter> filters()

Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.

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

Returns:

Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.

maxResults

public final Integer maxResults()

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

nextToken

public final String nextToken()

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

The token for the next set of items to return. (You received this token from a previous call.)

toBuilder

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

Specified by:

toBuilder in class SsmRequest

Returns:

a builder for type T

builder

public static DescribeMaintenanceWindowScheduleRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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.