software.amazon.awssdk.services.iam.model

Class ListGroupsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iam.model.IamResponse

software.amazon.awssdk.services.iam.model.ListGroupsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListGroupsResponse.Builder,ListGroupsResponse>

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

Contains the response to a successful ListGroups request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListGroupsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ListGroupsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<Group>	groups() A list of groups.
boolean	hasGroups() For responses, this returns true if the service returned a value for the Groups property.
int	hashCode()
Boolean	isTruncated() A flag that indicates whether there are more items to return.
String	marker() When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
List<SdkField<?>>	sdkFields()
static Class<? extends ListGroupsResponse.Builder>	serializableBuilderClass()
ListGroupsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iam.model.IamResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasGroups

public final boolean hasGroups()

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

groups

public final List<Group> groups()

A list of groups.

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

Returns:

A list of groups.

isTruncated

public final Boolean isTruncated()

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

Returns:

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

marker

public final String marker()

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Returns:

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

toBuilder

public ListGroupsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListGroupsResponse.Builder,ListGroupsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static ListGroupsResponse.Builder builder()

serializableBuilderClass

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

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo