software.amazon.awssdk.services.directory.model

Class SharedDirectory

java.lang.Object

software.amazon.awssdk.services.directory.model.SharedDirectory

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SharedDirectory.Builder,SharedDirectory>

@Generated(value="software.amazon.awssdk:codegen")
public final class SharedDirectory
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SharedDirectory.Builder,SharedDirectory>

Details about the shared directory in the directory owner account for which the share request in the directory consumer account has been accepted.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SharedDirectory.Builder

Method Summary

Modifier and Type	Method and Description
static SharedDirectory.Builder	builder()
Instant	createdDateTime() The date and time that the shared directory was created.
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)
int	hashCode()
Instant	lastUpdatedDateTime() The date and time that the shared directory was last updated.
String	ownerAccountId() Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.
String	ownerDirectoryId() Identifier of the directory in the directory owner account.
List<SdkField<?>>	sdkFields()
static Class<? extends SharedDirectory.Builder>	serializableBuilderClass()
String	sharedAccountId() Identifier of the directory consumer account that has access to the shared directory ( OwnerDirectoryId) in the directory owner account.
String	sharedDirectoryId() Identifier of the shared directory in the directory consumer account.
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 shared directory 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 shared directory request ( HANDSHAKE).
String	shareNotes() A directory share request that is sent by the directory owner to the directory consumer.
ShareStatus	shareStatus() Current directory status of the shared AWS Managed Microsoft AD directory.
String	shareStatusAsString() Current directory status of the shared AWS Managed Microsoft AD directory.
SharedDirectory.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

ownerAccountId

public final String ownerAccountId()

Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.

Returns:

Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.

ownerDirectoryId

public final String ownerDirectoryId()

Identifier of the directory in the directory owner account.

Returns:

Identifier of the directory in the directory owner account.

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 shared directory 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 shared directory 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 shared directory 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 shared directory request (HANDSHAKE).

See Also:

ShareMethod

sharedAccountId

public final String sharedAccountId()

Identifier of the directory consumer account that has access to the shared directory ( OwnerDirectoryId) in the directory owner account.

Returns:

Identifier of the directory consumer account that has access to the shared directory ( OwnerDirectoryId) in the directory owner account.

sharedDirectoryId

public final String sharedDirectoryId()

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

Returns:

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

shareStatus

public final ShareStatus shareStatus()

Current directory status of the shared AWS Managed Microsoft AD directory.

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

Returns:

Current directory status of the shared AWS Managed Microsoft AD directory.

See Also:

ShareStatus

shareStatusAsString

public final String shareStatusAsString()

Current directory status of the shared AWS Managed Microsoft AD directory.

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

Returns:

Current directory status of the shared AWS Managed Microsoft AD directory.

See Also:

ShareStatus

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.

createdDateTime

public final Instant createdDateTime()

The date and time that the shared directory was created.

Returns:

The date and time that the shared directory was created.

lastUpdatedDateTime

public final Instant lastUpdatedDateTime()

The date and time that the shared directory was last updated.

Returns:

The date and time that the shared directory was last updated.

toBuilder

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

Returns:

a builder for type T

builder

public static SharedDirectory.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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.