software.amazon.awssdk.services.directory.model

Class ShareDirectoryRequest

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.ShareDirectoryRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ShareDirectoryRequest.Builder,ShareDirectoryRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ShareDirectoryRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ShareDirectoryRequest.Builder	builder()
String	directoryId() Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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()
List<SdkField<?>>	sdkFields()
static Class<? extends ShareDirectoryRequest.Builder>	serializableBuilderClass()
ShareMethod	shareMethod() The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request ( HANDSHAKE).
String	shareMethodAsString() The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request ( HANDSHAKE).
String	shareNotes() A directory share request that is sent by the directory owner to the directory consumer.
ShareTarget	shareTarget() Identifier for the directory consumer account with whom the directory is to be shared.
ShareDirectoryRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

directoryId

public final String directoryId()

Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.

Returns:

Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.

shareNotes

public final String shareNotes()

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

Returns:

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

shareTarget

public final ShareTarget shareTarget()

Identifier for the directory consumer account with whom the directory is to be shared.

Returns:

Identifier for the directory consumer account with whom the directory is to be shared.

shareMethod

public final ShareMethod shareMethod()

The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request ( HANDSHAKE).

If the service returns an enum value that is not available in the current SDK version, shareMethod will return ShareMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareMethodAsString().

Returns:

The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request (HANDSHAKE).

See Also:

ShareMethod

shareMethodAsString

public final String shareMethodAsString()

The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request ( HANDSHAKE).

If the service returns an enum value that is not available in the current SDK version, shareMethod will return ShareMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareMethodAsString().

Returns:

The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request (HANDSHAKE).

See Also:

ShareMethod

toBuilder

public ShareDirectoryRequest.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<ShareDirectoryRequest.Builder,ShareDirectoryRequest>

Specified by:

toBuilder in class DirectoryRequest

Returns:

a builder for type T

builder

public static ShareDirectoryRequest.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

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