Package software.amazon.awssdk.services.workmail.model

Class ListGroupsForEntityRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workmail.model.WorkMailRequest

software.amazon.awssdk.services.workmail.model.ListGroupsForEntityRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListGroupsForEntityRequest.Builder,ListGroupsForEntityRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListGroupsForEntityRequest
extends WorkMailRequest
implements ToCopyableBuilder<ListGroupsForEntityRequest.Builder,ListGroupsForEntityRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListGroupsForEntityRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListGroupsForEntityRequest.Builder	builder()
String	entityId()	The identifier for the entity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ListGroupsForEntityFilters	filters()	Limit the search results based on the filter criteria.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results to return in a single call.
String	nextToken()	The token to use to retrieve the next page of results.
String	organizationId()	The identifier for the organization under which the entity exists.
List<SdkField<?>>	sdkFields()
static Class<? extends ListGroupsForEntityRequest.Builder>	serializableBuilderClass()
ListGroupsForEntityRequest.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

organizationId

public final String organizationId()

The identifier for the organization under which the entity exists.

Returns:

The identifier for the organization under which the entity exists.

entityId

public final String entityId()

The identifier for the entity.

The entity ID can accept UserId or GroupID, Username or Groupname, or email.

• Entity ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: entity@domain.tld

• Entity name: entity

Returns:

The identifier for the entity.

The entity ID can accept UserId or GroupID, Username or Groupname, or email.

• Entity ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: entity@domain.tld

• Entity name: entity

filters

public final ListGroupsForEntityFilters filters()

Limit the search results based on the filter criteria.

Returns:

Limit the search results based on the filter criteria.

nextToken

public final String nextToken()

The token to use to retrieve the next page of results. The first call does not contain any tokens.

Returns:

The token to use to retrieve the next page of results. The first call does not contain any tokens.

maxResults

public final Integer maxResults()

The maximum number of results to return in a single call.

Returns:

The maximum number of results to return in a single call.

toBuilder

public ListGroupsForEntityRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListGroupsForEntityRequest.Builder,ListGroupsForEntityRequest>

Specified by:

toBuilder in class WorkMailRequest

builder

public static ListGroupsForEntityRequest.Builder builder()

serializableBuilderClass

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