software.amazon.awssdk.services.workdocs.model

Class SharePrincipal

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<SharePrincipal.Builder,SharePrincipal>

@Generated(value="software.amazon.awssdk:codegen")
public class SharePrincipal
extends Object
implements StructuredPojo, ToCopyableBuilder<SharePrincipal.Builder,SharePrincipal>

Describes the recipient type and ID, if available.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SharePrincipal.Builder

Method Summary

Modifier and Type	Method and Description
static SharePrincipal.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The ID of the recipient.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
RoleType	role() The role of the recipient.
String	roleAsString() The role of the recipient.
static Class<? extends SharePrincipal.Builder>	serializableBuilderClass()
SharePrincipal.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
PrincipalType	type() The type of the recipient.
String	typeAsString() The type of the recipient.

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

id

public String id()

The ID of the recipient.

Returns:

The ID of the recipient.

type

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

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<SharePrincipal.Builder,SharePrincipal>

Returns:

a builder for type T

builder

public static SharePrincipal.Builder builder()

serializableBuilderClass

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.