software.amazon.awssdk.services.workdocs.model

Class ShareResult

java.lang.Object

software.amazon.awssdk.services.workdocs.model.ShareResult

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<ShareResult.Builder,ShareResult>

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

Describes the share results of a resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ShareResult.Builder

Method Summary

Modifier and Type	Method and Description
static ShareResult.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	principalId() The ID of the principal.
RoleType	role() The role.
String	roleAsString() The role.
static Class<? extends ShareResult.Builder>	serializableBuilderClass()
String	shareId() The ID of the resource that was shared.
ShareStatusType	status() The status.
String	statusAsString() The status.
String	statusMessage() The status message.
ShareResult.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

principalId

public String principalId()

The ID of the principal.

Returns:

The ID of the principal.

role

public RoleType role()

The role.

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.

See Also:

RoleType

roleAsString

public String roleAsString()

The role.

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.

See Also:

RoleType

status

public ShareStatusType status()

The status.

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

Returns:

The status.

See Also:

ShareStatusType

statusAsString

public String statusAsString()

The status.

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

Returns:

The status.

See Also:

ShareStatusType

shareId

public String shareId()

The ID of the resource that was shared.

Returns:

The ID of the resource that was shared.

statusMessage

public String statusMessage()

The status message.

Returns:

The status message.

toBuilder

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

Returns:

a builder for type T

builder

public static ShareResult.Builder builder()

serializableBuilderClass

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