software.amazon.awssdk.services.ssm.model

Class GetOpsSummaryRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetOpsSummaryRequest.Builder,GetOpsSummaryRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetOpsSummaryRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<OpsAggregator>	aggregators() Optional aggregators that return counts of OpsData based on one or more expressions.
static GetOpsSummaryRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<OpsFilter>	filters() Optional filters used to scope down the returned OpsData.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAggregators() For responses, this returns true if the service returned a value for the Aggregators property.
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
boolean	hasResultAttributes() For responses, this returns true if the service returned a value for the ResultAttributes property.
Integer	maxResults() The maximum number of items to return for this call.
String	nextToken() A token to start the list.
List<OpsResultAttribute>	resultAttributes() The OpsData data type to return.
List<SdkField<?>>	sdkFields()
static Class<? extends GetOpsSummaryRequest.Builder>	serializableBuilderClass()
String	syncName() Specify the name of a resource data sync to get.
GetOpsSummaryRequest.Builder	toBuilder()
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

syncName

public final String syncName()

Specify the name of a resource data sync to get.

Returns:

Specify the name of a resource data sync to get.

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

Optional filters used to scope down the returned OpsData.

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:

Optional filters used to scope down the returned OpsData.

hasAggregators

public final boolean hasAggregators()

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

aggregators

public final List<OpsAggregator> aggregators()

Optional aggregators that return counts of OpsData based on one or more expressions.

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

Returns:

Optional aggregators that return counts of OpsData based on one or more expressions.

hasResultAttributes

public final boolean hasResultAttributes()

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

resultAttributes

public final List<OpsResultAttribute> resultAttributes()

The OpsData data type to return.

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

Returns:

The OpsData data type to return.

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.

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.

toBuilder

public GetOpsSummaryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetOpsSummaryRequest.Builder,GetOpsSummaryRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static GetOpsSummaryRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo