software.amazon.awssdk.services.workdocs.model

Class DescribeGroupsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workdocs.model.WorkDocsRequest

software.amazon.awssdk.services.workdocs.model.DescribeGroupsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeGroupsRequest.Builder,DescribeGroupsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeGroupsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	authenticationToken() Amazon WorkDocs authentication token.
static DescribeGroupsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit() The maximum number of items to return with this call.
String	marker() The marker for the next set of results.
String	organizationId() The ID of the organization.
List<SdkField<?>>	sdkFields()
String	searchQuery() A query to describe groups by group name.
static Class<? extends DescribeGroupsRequest.Builder>	serializableBuilderClass()
DescribeGroupsRequest.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

authenticationToken

public final String authenticationToken()

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Returns:

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

searchQuery

public final String searchQuery()

A query to describe groups by group name.

Returns:

A query to describe groups by group name.

organizationId

public final String organizationId()

The ID of the organization.

Returns:

The ID of the organization.

marker

public final String marker()

The marker for the next set of results. (You received this marker from a previous call.)

Returns:

The marker for the next set of results. (You received this marker from a previous call.)

limit

public final Integer limit()

The maximum number of items to return with this call.

Returns:

The maximum number of items to return with this call.

toBuilder

public DescribeGroupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeGroupsRequest.Builder,DescribeGroupsRequest>

Specified by:

toBuilder in class WorkDocsRequest

builder

public static DescribeGroupsRequest.Builder builder()

serializableBuilderClass

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