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

Class ShareResult

java.lang.Object

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

All Implemented Interfaces:

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

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

Describes the share results of a resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShareResult.Builder

Method Summary

Modifier and Type	Method	Description
static ShareResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	inviteePrincipalId()	The ID of the invited user.
String	principalId()	The ID of the principal.
RoleType	role()	The role.
String	roleAsString()	The role.
List<SdkField<?>>	sdkFields()
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()
String	toString()	Returns a string representation of this object.

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

principalId

public final String principalId()

The ID of the principal.

Returns:

The ID of the principal.

inviteePrincipalId

public final String inviteePrincipalId()

The ID of the invited user.

Returns:

The ID of the invited user.

role

public final 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 final 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 final 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 final 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 final String shareId()

The ID of the resource that was shared.

Returns:

The ID of the resource that was shared.

statusMessage

public final String statusMessage()

The status message.

Returns:

The status message.

toBuilder

public ShareResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ShareResult.Builder,ShareResult>

builder

public static ShareResult.Builder builder()

serializableBuilderClass

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