Package 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("software.amazon.awssdk:codegen")
public final class DescribeSharedDirectoriesRequest
extends DirectoryRequest
implements ToCopyableBuilder<DescribeSharedDirectoriesRequest.Builder,DescribeSharedDirectoriesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeSharedDirectoriesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeSharedDirectoriesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSharedDirectoryIds()	For responses, this returns true if the service returned a value for the SharedDirectoryIds property.
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()
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

ownerDirectoryId

public final 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.

hasSharedDirectoryIds

public final boolean hasSharedDirectoryIds()

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

sharedDirectoryIds

public final 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.

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

Returns:

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

nextToken

public final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSharedDirectoriesRequest.Builder,DescribeSharedDirectoriesRequest>

Specified by:

toBuilder in class DirectoryRequest

builder

public static DescribeSharedDirectoriesRequest.Builder builder()

serializableBuilderClass

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