ShareResult (AWS Java SDK for Amazon WorkDocs 1.12.107 API)

java.lang.Object
- com.amazonaws.services.workdocs.model.ShareResult

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ShareResult
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the share results of a resource.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ShareResult()

Constructors
Constructor and Description
`ShareResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ShareResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getInviteePrincipalId()` The ID of the invited user.
`String`	`getPrincipalId()` The ID of the principal.
`String`	`getRole()` The role.
`String`	`getShareId()` The ID of the resource that was shared.
`String`	`getStatus()` The status.
`String`	`getStatusMessage()` The status message.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setInviteePrincipalId(String inviteePrincipalId)` The ID of the invited user.
`void`	`setPrincipalId(String principalId)` The ID of the principal.
`void`	`setRole(RoleType role)` The role.
`void`	`setRole(String role)` The role.
`void`	`setShareId(String shareId)` The ID of the resource that was shared.
`void`	`setStatus(ShareStatusType status)` The status.
`void`	`setStatus(String status)` The status.
`void`	`setStatusMessage(String statusMessage)` The status message.
`String`	`toString()` Returns a string representation of this object.
`ShareResult`	`withInviteePrincipalId(String inviteePrincipalId)` The ID of the invited user.
`ShareResult`	`withPrincipalId(String principalId)` The ID of the principal.
`ShareResult`	`withRole(RoleType role)` The role.
`ShareResult`	`withRole(String role)` The role.
`ShareResult`	`withShareId(String shareId)` The ID of the resource that was shared.
`ShareResult`	`withStatus(ShareStatusType status)` The status.
`ShareResult`	`withStatus(String status)` The status.
`ShareResult`	`withStatusMessage(String statusMessage)` The status message.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ShareResult
```
public ShareResult()
```
- Method Detail
  - setPrincipalId
```
public void setPrincipalId(String principalId)
```
    The ID of the principal.
    
    Parameters:
    
    principalId - The ID of the principal.
  - getPrincipalId
```
public String getPrincipalId()
```
    The ID of the principal.
    
    Returns:
    
    The ID of the principal.
  - withPrincipalId
```
public ShareResult withPrincipalId(String principalId)
```
    The ID of the principal.
    
    Parameters:
    
    principalId - The ID of the principal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInviteePrincipalId
```
public void setInviteePrincipalId(String inviteePrincipalId)
```
    The ID of the invited user.
    
    Parameters:
    
    inviteePrincipalId - The ID of the invited user.
  - getInviteePrincipalId
```
public String getInviteePrincipalId()
```
    The ID of the invited user.
    
    Returns:
    
    The ID of the invited user.
  - withInviteePrincipalId
```
public ShareResult withInviteePrincipalId(String inviteePrincipalId)
```
    The ID of the invited user.
    
    Parameters:
    
    inviteePrincipalId - The ID of the invited user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRole
```
public void setRole(String role)
```
    The role.
    
    Parameters:
    
    role - The role.
    
    See Also:
    
    RoleType
  - getRole
```
public String getRole()
```
    The role.
    
    Returns:
    
    The role.
    
    See Also:
    
    RoleType
  - withRole
```
public ShareResult withRole(String role)
```
    The role.
    
    Parameters:
    
    role - The role.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RoleType
  - setRole
```
public void setRole(RoleType role)
```
    The role.
    
    Parameters:
    
    role - The role.
    
    See Also:
    
    RoleType
  - withRole
```
public ShareResult withRole(RoleType role)
```
    The role.
    
    Parameters:
    
    role - The role.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RoleType
  - setStatus
```
public void setStatus(String status)
```
    The status.
    
    Parameters:
    
    status - The status.
    
    See Also:
    
    ShareStatusType
  - getStatus
```
public String getStatus()
```
    The status.
    
    Returns:
    
    The status.
    
    See Also:
    
    ShareStatusType
  - withStatus
```
public ShareResult withStatus(String status)
```
    The status.
    
    Parameters:
    
    status - The status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ShareStatusType
  - setStatus
```
public void setStatus(ShareStatusType status)
```
    The status.
    
    Parameters:
    
    status - The status.
    
    See Also:
    
    ShareStatusType
  - withStatus
```
public ShareResult withStatus(ShareStatusType status)
```
    The status.
    
    Parameters:
    
    status - The status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ShareStatusType
  - setShareId
```
public void setShareId(String shareId)
```
    The ID of the resource that was shared.
    
    Parameters:
    
    shareId - The ID of the resource that was shared.
  - getShareId
```
public String getShareId()
```
    The ID of the resource that was shared.
    
    Returns:
    
    The ID of the resource that was shared.
  - withShareId
```
public ShareResult withShareId(String shareId)
```
    The ID of the resource that was shared.
    
    Parameters:
    
    shareId - The ID of the resource that was shared.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    The status message.
    
    Parameters:
    
    statusMessage - The status message.
  - getStatusMessage
```
public String getStatusMessage()
```
    The status message.
    
    Returns:
    
    The status message.
  - withStatusMessage
```
public ShareResult withStatusMessage(String statusMessage)
```
    The status message.
    
    Parameters:
    
    statusMessage - The status message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ShareResult clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class ShareResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShareResult

Method Detail

setPrincipalId

getPrincipalId

withPrincipalId

setInviteePrincipalId

getInviteePrincipalId

withInviteePrincipalId

setRole

getRole

withRole

setRole

withRole

setStatus

getStatus

withStatus

setStatus

withStatus

setShareId

getShareId

withShareId

setStatusMessage

getStatusMessage

withStatusMessage

toString

equals

hashCode

clone

marshall