software.amazon.awssdk.services.ssm.model

Class DescribeOpsItemsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeOpsItemsRequest.Builder,DescribeOpsItemsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeOpsItemsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeOpsItemsRequest.Builder	builder()
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 SdkRequest.
int	hashCode()
boolean	hasOpsItemFilters() For responses, this returns true if the service returned a value for the OpsItemFilters property.
Integer	maxResults() The maximum number of items to return for this call.
String	nextToken() A token to start the list.
List<OpsItemFilter>	opsItemFilters() One or more filters to limit the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeOpsItemsRequest.Builder>	serializableBuilderClass()
DescribeOpsItemsRequest.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.

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

hasOpsItemFilters

public final boolean hasOpsItemFilters()

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

opsItemFilters

public final List<OpsItemFilter> opsItemFilters()

One or more filters to limit the response.

• Key: CreatedTime

  Operations: GreaterThan, LessThan

• Key: LastModifiedBy

  Operations: Contains, Equals

• Key: LastModifiedTime

  Operations: GreaterThan, LessThan

• Key: Priority

  Operations: Equals

• Key: Source

  Operations: Contains, Equals

• Key: Status

  Operations: Equals

• Key: Title*

  Operations: Equals,Contains

• Key: OperationalData**

  Operations: Equals

• Key: OperationalDataKey

  Operations: Equals

• Key: OperationalDataValue

  Operations: Equals, Contains

• Key: OpsItemId

  Operations: Equals

• Key: ResourceId

  Operations: Contains

• Key: AutomationId

  Operations: Equals

*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

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

Returns:

One or more filters to limit the response.

• Key: CreatedTime

  Operations: GreaterThan, LessThan

• Key: LastModifiedBy

  Operations: Contains, Equals

• Key: LastModifiedTime

  Operations: GreaterThan, LessThan

• Key: Priority

  Operations: Equals

• Key: Source

  Operations: Contains, Equals

• Key: Status

  Operations: Equals

• Key: Title*

  Operations: Equals,Contains

• Key: OperationalData**

  Operations: Equals

• Key: OperationalDataKey

  Operations: Equals

• Key: OperationalDataValue

  Operations: Equals, Contains

• Key: OpsItemId

  Operations: Equals

• Key: ResourceId

  Operations: Contains

• Key: AutomationId

  Operations: Equals

*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}

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

A token to start the list. Use this token to get the next set of results.

Returns:

A token to start the list. Use this token to get the next set of results.

toBuilder

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

Specified by:

toBuilder in class SsmRequest

Returns:

a builder for type T

builder

public static DescribeOpsItemsRequest.Builder builder()

serializableBuilderClass

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