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:
  • Method Details

    • 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:
    • 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:
    • 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:
    • 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:
    • 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()
      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 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.