software.amazon.awssdk.services.resourcegroups.model

Class ListGroupsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.resourcegroups.model.ResourceGroupsRequest

software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListGroupsRequest.Builder,ListGroupsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListGroupsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListGroupsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<GroupFilter>	filters() Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Integer	maxResults() The total number of results that you want included on each page of the response.
String	nextToken() The parameter for receiving additional results if you receive a NextToken response in a previous request.
List<SdkField<?>>	sdkFields()
static Class<? extends ListGroupsRequest.Builder>	serializableBuilderClass()
ListGroupsRequest.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

hasFilters

public final boolean hasFilters()

Returns true if the Filters 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.

filters

public final List<GroupFilter> filters()

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.

• configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

  • AWS:EC2::CapacityReservationPool

  • AWS:EC2::HostManagement

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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

Returns:

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.

• configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

  • AWS:EC2::CapacityReservationPool

  • AWS:EC2::HostManagement

maxResults

public final Integer maxResults()

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

nextToken

public final String nextToken()

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Returns:

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

toBuilder

public ListGroupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListGroupsRequest.Builder,ListGroupsRequest>

Specified by:

toBuilder in class ResourceGroupsRequest

builder

public static ListGroupsRequest.Builder builder()

serializableBuilderClass

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