Handshake (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.organizations.model.Handshake

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Handshake
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, when a master account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.

Note: Handshakes that are CANCELED, ACCEPTED, or DECLINED show up in lists for only 30 days after entering that state After that they are deleted.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Handshake()

Constructors
Constructor and Description
`Handshake()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Handshake`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` The type of handshake, indicating what action occurs when the recipient accepts the handshake.
`String`	`getArn()` The Amazon Resource Name (ARN) of a handshake.
`Date`	`getExpirationTimestamp()` The date and time that the handshake expires.
`String`	`getId()` The unique identifier (ID) of a handshake.
`List<HandshakeParty>`	`getParties()` Information about the two accounts that are participating in the handshake.
`Date`	`getRequestedTimestamp()` The date and time that the handshake request was made.
`List<HandshakeResource>`	`getResources()` Additional information that is needed to process the handshake.
`String`	`getState()` The current state of the handshake.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction(ActionType action)` The type of handshake, indicating what action occurs when the recipient accepts the handshake.
`void`	`setAction(String action)` The type of handshake, indicating what action occurs when the recipient accepts the handshake.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of a handshake.
`void`	`setExpirationTimestamp(Date expirationTimestamp)` The date and time that the handshake expires.
`void`	`setId(String id)` The unique identifier (ID) of a handshake.
`void`	`setParties(Collection<HandshakeParty> parties)` Information about the two accounts that are participating in the handshake.
`void`	`setRequestedTimestamp(Date requestedTimestamp)` The date and time that the handshake request was made.
`void`	`setResources(Collection<HandshakeResource> resources)` Additional information that is needed to process the handshake.
`void`	`setState(HandshakeState state)` The current state of the handshake.
`void`	`setState(String state)` The current state of the handshake.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Handshake`	`withAction(ActionType action)` The type of handshake, indicating what action occurs when the recipient accepts the handshake.
`Handshake`	`withAction(String action)` The type of handshake, indicating what action occurs when the recipient accepts the handshake.
`Handshake`	`withArn(String arn)` The Amazon Resource Name (ARN) of a handshake.
`Handshake`	`withExpirationTimestamp(Date expirationTimestamp)` The date and time that the handshake expires.
`Handshake`	`withId(String id)` The unique identifier (ID) of a handshake.
`Handshake`	`withParties(Collection<HandshakeParty> parties)` Information about the two accounts that are participating in the handshake.
`Handshake`	`withParties(HandshakeParty... parties)` Information about the two accounts that are participating in the handshake.
`Handshake`	`withRequestedTimestamp(Date requestedTimestamp)` The date and time that the handshake request was made.
`Handshake`	`withResources(Collection<HandshakeResource> resources)` Additional information that is needed to process the handshake.
`Handshake`	`withResources(HandshakeResource... resources)` Additional information that is needed to process the handshake.
`Handshake`	`withState(HandshakeState state)` The current state of the handshake.
`Handshake`	`withState(String state)` The current state of the handshake.

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

- Constructor Detail
  - Handshake
```
public Handshake()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.
    
    The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
    
    Parameters:
    
    id - The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.
    
    The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
  - getId
```
public String getId()
```
    The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.
    
    The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
    
    Returns:
    
    The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.
    
    The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
  - withId
```
public Handshake withId(String id)
```
    The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.
    
    The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
    
    Parameters:
    
    id - The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.
    
    The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of a handshake.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of a handshake.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of a handshake.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) of a handshake.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
  - withArn
```
public Handshake withArn(String arn)
```
    The Amazon Resource Name (ARN) of a handshake.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of a handshake.
    
    For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParties
```
public List<HandshakeParty> getParties()
```
    Information about the two accounts that are participating in the handshake.
    
    Returns:
    
    Information about the two accounts that are participating in the handshake.
  - setParties
```
public void setParties(Collection<HandshakeParty> parties)
```
    Information about the two accounts that are participating in the handshake.
    
    Parameters:
    
    parties - Information about the two accounts that are participating in the handshake.
  - withParties
```
public Handshake withParties(HandshakeParty... parties)
```
    Information about the two accounts that are participating in the handshake.
    
    NOTE: This method appends the values to the existing list (if any). Use setParties(java.util.Collection) or withParties(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    parties - Information about the two accounts that are participating in the handshake.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withParties
```
public Handshake withParties(Collection<HandshakeParty> parties)
```
    Information about the two accounts that are participating in the handshake.
    
    Parameters:
    
    parties - Information about the two accounts that are participating in the handshake.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
    - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    - CANCELED: This handshake is no longer active because it was canceled by the originating account.
    - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    - DECLINED: This handshake is no longer active because it was declined by the recipient account.
    - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    Parameters:
    state - The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
    
    REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    
    OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    
    CANCELED: This handshake is no longer active because it was canceled by the originating account.
    
    ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    
    DECLINED: This handshake is no longer active because it was declined by the recipient account.
    
    EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    See Also:
    
    HandshakeState
  - getState
```
public String getState()
```
    The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
    - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    - CANCELED: This handshake is no longer active because it was canceled by the originating account.
    - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    - DECLINED: This handshake is no longer active because it was declined by the recipient account.
    - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    Returns:
    The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
    
    REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    
    OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    
    CANCELED: This handshake is no longer active because it was canceled by the originating account.
    
    ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    
    DECLINED: This handshake is no longer active because it was declined by the recipient account.
    
    EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    See Also:
    
    HandshakeState
  - withState
```
public Handshake withState(String state)
```
    The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
    - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    - CANCELED: This handshake is no longer active because it was canceled by the originating account.
    - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    - DECLINED: This handshake is no longer active because it was declined by the recipient account.
    - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    Parameters:
    state - The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
    
    REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    
    OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    
    CANCELED: This handshake is no longer active because it was canceled by the originating account.
    
    ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    
    DECLINED: This handshake is no longer active because it was declined by the recipient account.
    
    EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HandshakeState
  - setState
```
public void setState(HandshakeState state)
```
    The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
    - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    - CANCELED: This handshake is no longer active because it was canceled by the originating account.
    - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    - DECLINED: This handshake is no longer active because it was declined by the recipient account.
    - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    Parameters:
    state - The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
    
    REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    
    OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    
    CANCELED: This handshake is no longer active because it was canceled by the originating account.
    
    ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    
    DECLINED: This handshake is no longer active because it was declined by the recipient account.
    
    EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    See Also:
    
    HandshakeState
  - withState
```
public Handshake withState(HandshakeState state)
```
    The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
    - REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    - OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    - CANCELED: This handshake is no longer active because it was canceled by the originating account.
    - ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    - DECLINED: This handshake is no longer active because it was declined by the recipient account.
    - EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    Parameters:
    state - The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
    
    REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
    
    OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
    
    CANCELED: This handshake is no longer active because it was canceled by the originating account.
    
    ACCEPTED: This handshake is complete because it has been accepted by the recipient.
    
    DECLINED: This handshake is no longer active because it was declined by the recipient account.
    
    EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HandshakeState
  - setRequestedTimestamp
```
public void setRequestedTimestamp(Date requestedTimestamp)
```
    The date and time that the handshake request was made.
    
    Parameters:
    
    requestedTimestamp - The date and time that the handshake request was made.
  - getRequestedTimestamp
```
public Date getRequestedTimestamp()
```
    The date and time that the handshake request was made.
    
    Returns:
    
    The date and time that the handshake request was made.
  - withRequestedTimestamp
```
public Handshake withRequestedTimestamp(Date requestedTimestamp)
```
    The date and time that the handshake request was made.
    
    Parameters:
    
    requestedTimestamp - The date and time that the handshake request was made.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpirationTimestamp
```
public void setExpirationTimestamp(Date expirationTimestamp)
```
    The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.
    
    Parameters:
    
    expirationTimestamp - The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.
  - getExpirationTimestamp
```
public Date getExpirationTimestamp()
```
    The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.
    
    Returns:
    
    The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.
  - withExpirationTimestamp
```
public Handshake withExpirationTimestamp(Date expirationTimestamp)
```
    The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.
    
    Parameters:
    
    expirationTimestamp - The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAction
```
public void setAction(String action)
```
    The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
    - INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
    - ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
    - APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.
    Parameters:
    action - The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
    
    INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
    
    ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
    
    APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.
    See Also:
    
    ActionType
  - getAction
```
public String getAction()
```
    The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
    - INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
    - ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
    - APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.
    Returns:
    The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
    
    INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
    
    ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
    
    APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.
    See Also:
    
    ActionType
  - withAction
```
public Handshake withAction(String action)
```
    The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
    - INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
    - ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
    - APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.
    Parameters:
    action - The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
    
    INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
    
    ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
    
    APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionType
  - setAction
```
public void setAction(ActionType action)
```
    The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
    - INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
    - ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
    - APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.
    Parameters:
    action - The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
    
    INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
    
    ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
    
    APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.
    See Also:
    
    ActionType
  - withAction
```
public Handshake withAction(ActionType action)
```
    The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
    - INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
    - ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
    - APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.
    Parameters:
    action - The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
    
    INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
    
    ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
    
    APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionType
  - getResources
```
public List<HandshakeResource> getResources()
```
    Additional information that is needed to process the handshake.
    
    Returns:
    
    Additional information that is needed to process the handshake.
  - setResources
```
public void setResources(Collection<HandshakeResource> resources)
```
    Additional information that is needed to process the handshake.
    
    Parameters:
    
    resources - Additional information that is needed to process the handshake.
  - withResources
```
public Handshake withResources(HandshakeResource... resources)
```
    Additional information that is needed to process the handshake.
    
    NOTE: This method appends the values to the existing list (if any). Use setResources(java.util.Collection) or withResources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    resources - Additional information that is needed to process the handshake.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResources
```
public Handshake withResources(Collection<HandshakeResource> resources)
```
    Additional information that is needed to process the handshake.
    
    Parameters:
    
    resources - Additional information that is needed to process the handshake.
    
    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; useful for testing and debugging.
    
    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 Handshake clone()
```
    Overrides:
    
    clone in class Object
  - 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.

Did this page help you?

Class Handshake

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Handshake

Method Detail

setId

getId

withId

setArn

getArn

withArn

getParties

setParties

withParties

withParties

setState

getState

withState

setState

withState

setRequestedTimestamp

getRequestedTimestamp

withRequestedTimestamp

setExpirationTimestamp

getExpirationTimestamp

withExpirationTimestamp

setAction

getAction

withAction

setAction

withAction

getResources

setResources

withResources

withResources

toString

equals

hashCode

clone

marshall