Package software.amazon.awssdk.services.workdocs.model

Class SharePrincipal

java.lang.Object

software.amazon.awssdk.services.workdocs.model.SharePrincipal

All Implemented Interfaces:

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

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

Describes the recipient type and ID, if available.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SharePrincipal.Builder

Method Summary

Modifier and Type	Method	Description
static SharePrincipal.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The ID of the recipient.
RoleType	role()	The role of the recipient.
String	roleAsString()	The role of the recipient.
List<SdkField<?>>	sdkFields()
static Class<? extends SharePrincipal.Builder>	serializableBuilderClass()
SharePrincipal.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PrincipalType	type()	The type of the recipient.
String	typeAsString()	The type of the recipient.

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

id

public final String id()

The ID of the recipient.

Returns:

The ID of the recipient.

type

public final PrincipalType type()

The type of the recipient.

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

Returns:

The type of the recipient.

See Also:

PrincipalType

typeAsString

public final String typeAsString()

The type of the recipient.

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

Returns:

The type of the recipient.

See Also:

PrincipalType

role

public final RoleType role()

The role of the recipient.

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

Returns:

The role of the recipient.

See Also:

RoleType

roleAsString

public final String roleAsString()

The role of the recipient.

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

Returns:

The role of the recipient.

See Also:

RoleType

toBuilder

public SharePrincipal.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SharePrincipal.Builder,SharePrincipal>

builder

public static SharePrincipal.Builder builder()

serializableBuilderClass

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

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo