HandshakeResource (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HandshakeResource
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains additional data that is needed to process a handshake.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HandshakeResource()

Constructors
Constructor and Description
`HandshakeResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HandshakeResource`	`clone()`
`boolean`	`equals(Object obj)`
`List<HandshakeResource>`	`getResources()` When needed, contains an additional array of `HandshakeResource` objects.
`String`	`getType()` The type of information being passed, specifying how the value is to be interpreted by the other party:
`String`	`getValue()` The information that is passed to the other party in the handshake.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setResources(Collection<HandshakeResource> resources)` When needed, contains an additional array of `HandshakeResource` objects.
`void`	`setType(HandshakeResourceType type)` The type of information being passed, specifying how the value is to be interpreted by the other party:
`void`	`setType(String type)` The type of information being passed, specifying how the value is to be interpreted by the other party:
`void`	`setValue(String value)` The information that is passed to the other party in the handshake.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`HandshakeResource`	`withResources(Collection<HandshakeResource> resources)` When needed, contains an additional array of `HandshakeResource` objects.
`HandshakeResource`	`withResources(HandshakeResource... resources)` When needed, contains an additional array of `HandshakeResource` objects.
`HandshakeResource`	`withType(HandshakeResourceType type)` The type of information being passed, specifying how the value is to be interpreted by the other party:
`HandshakeResource`	`withType(String type)` The type of information being passed, specifying how the value is to be interpreted by the other party:
`HandshakeResource`	`withValue(String value)` The information that is passed to the other party in the handshake.

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

- Constructor Detail
  - HandshakeResource
```
public HandshakeResource()
```
- Method Detail
  - setValue
```
public void setValue(String value)
```
    The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.
    
    Parameters:
    
    value - The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.
  - getValue
```
public String getValue()
```
    The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.
    
    Returns:
    
    The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.
  - withValue
```
public HandshakeResource withValue(String value)
```
    The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.
    
    Parameters:
    
    value - The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of information being passed, specifying how the value is to be interpreted by the other party:
    - ACCOUNT - Specifies an AWS account ID number.
    - ORGANIZATION - Specifies an organization ID number.
    - EMAIL - Specifies the email address that is associated with the account that receives the handshake.
    - OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
    - OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
    - NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
    Parameters:
    type - The type of information being passed, specifying how the value is to be interpreted by the other party:
    
    ACCOUNT - Specifies an AWS account ID number.
    
    ORGANIZATION - Specifies an organization ID number.
    
    EMAIL - Specifies the email address that is associated with the account that receives the handshake.
    
    OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
    
    OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
    
    NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
    See Also:
    
    HandshakeResourceType
  - getType
```
public String getType()
```
    The type of information being passed, specifying how the value is to be interpreted by the other party:
    - ACCOUNT - Specifies an AWS account ID number.
    - ORGANIZATION - Specifies an organization ID number.
    - EMAIL - Specifies the email address that is associated with the account that receives the handshake.
    - OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
    - OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
    - NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
    Returns:
    The type of information being passed, specifying how the value is to be interpreted by the other party:
    
    ACCOUNT - Specifies an AWS account ID number.
    
    ORGANIZATION - Specifies an organization ID number.
    
    EMAIL - Specifies the email address that is associated with the account that receives the handshake.
    
    OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
    
    OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
    
    NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
    See Also:
    
    HandshakeResourceType
  - withType
```
public HandshakeResource withType(String type)
```
    The type of information being passed, specifying how the value is to be interpreted by the other party:
    - ACCOUNT - Specifies an AWS account ID number.
    - ORGANIZATION - Specifies an organization ID number.
    - EMAIL - Specifies the email address that is associated with the account that receives the handshake.
    - OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
    - OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
    - NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
    Parameters:
    type - The type of information being passed, specifying how the value is to be interpreted by the other party:
    
    ACCOUNT - Specifies an AWS account ID number.
    
    ORGANIZATION - Specifies an organization ID number.
    
    EMAIL - Specifies the email address that is associated with the account that receives the handshake.
    
    OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
    
    OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
    
    NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HandshakeResourceType
  - setType
```
public void setType(HandshakeResourceType type)
```
    The type of information being passed, specifying how the value is to be interpreted by the other party:
    - ACCOUNT - Specifies an AWS account ID number.
    - ORGANIZATION - Specifies an organization ID number.
    - EMAIL - Specifies the email address that is associated with the account that receives the handshake.
    - OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
    - OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
    - NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
    Parameters:
    type - The type of information being passed, specifying how the value is to be interpreted by the other party:
    
    ACCOUNT - Specifies an AWS account ID number.
    
    ORGANIZATION - Specifies an organization ID number.
    
    EMAIL - Specifies the email address that is associated with the account that receives the handshake.
    
    OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
    
    OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
    
    NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
    See Also:
    
    HandshakeResourceType
  - withType
```
public HandshakeResource withType(HandshakeResourceType type)
```
    The type of information being passed, specifying how the value is to be interpreted by the other party:
    - ACCOUNT - Specifies an AWS account ID number.
    - ORGANIZATION - Specifies an organization ID number.
    - EMAIL - Specifies the email address that is associated with the account that receives the handshake.
    - OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
    - OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
    - NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
    Parameters:
    type - The type of information being passed, specifying how the value is to be interpreted by the other party:
    
    ACCOUNT - Specifies an AWS account ID number.
    
    ORGANIZATION - Specifies an organization ID number.
    
    EMAIL - Specifies the email address that is associated with the account that receives the handshake.
    
    OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.
    
    OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.
    
    NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HandshakeResourceType
  - getResources
```
public List<HandshakeResource> getResources()
```
    When needed, contains an additional array of HandshakeResource objects.
    
    Returns:
    
    When needed, contains an additional array of HandshakeResource objects.
  - setResources
```
public void setResources(Collection<HandshakeResource> resources)
```
    When needed, contains an additional array of HandshakeResource objects.
    
    Parameters:
    
    resources - When needed, contains an additional array of HandshakeResource objects.
  - withResources
```
public HandshakeResource withResources(HandshakeResource... resources)
```
    When needed, contains an additional array of HandshakeResource objects.
    
    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 - When needed, contains an additional array of HandshakeResource objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResources
```
public HandshakeResource withResources(Collection<HandshakeResource> resources)
```
    When needed, contains an additional array of HandshakeResource objects.
    
    Parameters:
    
    resources - When needed, contains an additional array of HandshakeResource objects.
    
    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 HandshakeResource 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 HandshakeResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HandshakeResource

Method Detail

setValue

getValue

withValue

setType

getType

withType

setType

withType

getResources

setResources

withResources

withResources

toString

equals

hashCode

clone

marshall