software.amazon.awssdk.services.directory.model

Class DescribeSharedDirectoriesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.directory.model.DirectoryRequest

software.amazon.awssdk.services.directory.model.DescribeSharedDirectoriesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeSharedDirectoriesRequest.Builder,DescribeSharedDirectoriesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeSharedDirectoriesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeSharedDirectoriesRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	limit() The number of shared directories to return in the response object.
String	nextToken() The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories.
String	ownerDirectoryId() Returns the identifier of the directory in the directory owner account.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeSharedDirectoriesRequest.Builder>	serializableBuilderClass()
List<String>	sharedDirectoryIds() A list of identifiers of all shared directories in your account.
DescribeSharedDirectoriesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

ownerDirectoryId

public String ownerDirectoryId()

Returns the identifier of the directory in the directory owner account.

Returns:

Returns the identifier of the directory in the directory owner account.

sharedDirectoryIds

public List<String> sharedDirectoryIds()

A list of identifiers of all shared directories in your account.

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

Returns:

A list of identifiers of all shared directories in your account.

nextToken

public String nextToken()

The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.

Returns:

The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.

limit

public Integer limit()

The number of shared directories to return in the response object.

Returns:

The number of shared directories to return in the response object.

toBuilder

public DescribeSharedDirectoriesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSharedDirectoriesRequest.Builder,DescribeSharedDirectoriesRequest>

Specified by:

toBuilder in class DirectoryRequest

Returns:

a builder for type T

builder

public static DescribeSharedDirectoriesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeSharedDirectoriesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.