com.amazonaws.services.organizations.model.Handshake Maven / Gradle / Ivy
Show all versions of aws-java-sdk-organizations Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.organizations.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains information that must be exchanged to securely establish a relationship between two accounts (an
* originator and a recipient). For example, when a management 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, DECLINED, or
* EXPIRED show up in lists for only 30 days after entering that state After that they are deleted.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Handshake implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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 lowercase letters or digits.
*
*/
private String id;
/**
*
* The Amazon Resource Name (ARN) of a handshake.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*/
private String arn;
/**
*
* Information about the two accounts that are participating in the handshake.
*
*/
private java.util.List parties;
/**
*
* 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).
*
*
*
*/
private String state;
/**
*
* The date and time that the handshake request was made.
*
*/
private java.util.Date requestedTimestamp;
/**
*
* 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.
*
*/
private java.util.Date expirationTimestamp;
/**
*
* 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
* management 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 management account to only invited member accounts. Created
* accounts do not receive this because those accounts were created by the organization's management 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 management account
* and signals the master that it can finalize the process to enable all features.
*
*
*
*/
private String action;
/**
*
* Additional information that is needed to process the handshake.
*
*/
private java.util.List resources;
/**
*
* 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 lowercase letters or digits.
*
*
* @param 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 lowercase letters or digits.
*/
public void setId(String id) {
this.id = 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 lowercase letters or digits.
*
*
* @return 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 lowercase letters or digits.
*/
public String getId() {
return this.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 lowercase letters or digits.
*
*
* @param 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 lowercase letters or digits.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Handshake withId(String id) {
setId(id);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of a handshake.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*
* @param arn
* The Amazon Resource Name (ARN) of a handshake.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of a handshake.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*
* @return The Amazon Resource Name (ARN) of a handshake.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of a handshake.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*
* @param arn
* The Amazon Resource Name (ARN) of a handshake.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Handshake withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* Information about the two accounts that are participating in the handshake.
*
*
* @return Information about the two accounts that are participating in the handshake.
*/
public java.util.List getParties() {
return parties;
}
/**
*
* Information about the two accounts that are participating in the handshake.
*
*
* @param parties
* Information about the two accounts that are participating in the handshake.
*/
public void setParties(java.util.Collection parties) {
if (parties == null) {
this.parties = null;
return;
}
this.parties = new java.util.ArrayList(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
* {@link #setParties(java.util.Collection)} or {@link #withParties(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param parties
* Information about the two accounts that are participating in the handshake.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Handshake withParties(HandshakeParty... parties) {
if (this.parties == null) {
setParties(new java.util.ArrayList(parties.length));
}
for (HandshakeParty ele : parties) {
this.parties.add(ele);
}
return this;
}
/**
*
* Information about the two accounts that are participating in the handshake.
*
*
* @param parties
* Information about the two accounts that are participating in the handshake.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Handshake withParties(java.util.Collection parties) {
setParties(parties);
return this;
}
/**
*
* 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).
*
*
*
*
* @param 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 HandshakeState
*/
public void setState(String state) {
this.state = 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).
*
*
*
*
* @return 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 HandshakeState
*/
public String getState() {
return this.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).
*
*
*
*
* @param 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).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see HandshakeState
*/
public Handshake withState(String state) {
setState(state);
return this;
}
/**
*
* 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).
*
*
*
*
* @param 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 HandshakeState
*/
public void setState(HandshakeState state) {
withState(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).
*
*
*
*
* @param 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).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see HandshakeState
*/
public Handshake withState(HandshakeState state) {
this.state = state.toString();
return this;
}
/**
*
* The date and time that the handshake request was made.
*
*
* @param requestedTimestamp
* The date and time that the handshake request was made.
*/
public void setRequestedTimestamp(java.util.Date requestedTimestamp) {
this.requestedTimestamp = requestedTimestamp;
}
/**
*
* The date and time that the handshake request was made.
*
*
* @return The date and time that the handshake request was made.
*/
public java.util.Date getRequestedTimestamp() {
return this.requestedTimestamp;
}
/**
*
* The date and time that the handshake request was made.
*
*
* @param requestedTimestamp
* The date and time that the handshake request was made.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Handshake withRequestedTimestamp(java.util.Date requestedTimestamp) {
setRequestedTimestamp(requestedTimestamp);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setExpirationTimestamp(java.util.Date expirationTimestamp) {
this.expirationTimestamp = 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.
*
*
* @return 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.
*/
public java.util.Date getExpirationTimestamp() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Handshake withExpirationTimestamp(java.util.Date expirationTimestamp) {
setExpirationTimestamp(expirationTimestamp);
return this;
}
/**
*
* 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
* management 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 management account to only invited member accounts. Created
* accounts do not receive this because those accounts were created by the organization's management 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 management account
* and signals the master that it can finalize the process to enable all features.
*
*
*
*
* @param 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 management 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 management account to only invited member accounts.
* Created accounts do not receive this because those accounts were created by the organization's management
* 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 management
* account and signals the master that it can finalize the process to enable all features.
*
*
* @see ActionType
*/
public void setAction(String action) {
this.action = 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
* management 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 management account to only invited member accounts. Created
* accounts do not receive this because those accounts were created by the organization's management 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 management account
* and signals the master that it can finalize the process to enable all features.
*
*
*
*
* @return 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 management 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 management account to only invited member accounts.
* Created accounts do not receive this because those accounts were created by the organization's management
* 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
* management account and signals the master that it can finalize the process to enable all features.
*
*
* @see ActionType
*/
public String getAction() {
return this.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
* management 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 management account to only invited member accounts. Created
* accounts do not receive this because those accounts were created by the organization's management 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 management account
* and signals the master that it can finalize the process to enable all features.
*
*
*
*
* @param 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 management 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 management account to only invited member accounts.
* Created accounts do not receive this because those accounts were created by the organization's management
* 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 management
* account and signals the master that it can finalize the process to enable all features.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionType
*/
public Handshake withAction(String action) {
setAction(action);
return this;
}
/**
*
* 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
* management 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 management account to only invited member accounts. Created
* accounts do not receive this because those accounts were created by the organization's management 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 management account
* and signals the master that it can finalize the process to enable all features.
*
*
*
*
* @param 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 management 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 management account to only invited member accounts.
* Created accounts do not receive this because those accounts were created by the organization's management
* 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 management
* account and signals the master that it can finalize the process to enable all features.
*
*
* @see ActionType
*/
public void setAction(ActionType action) {
withAction(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
* management 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 management account to only invited member accounts. Created
* accounts do not receive this because those accounts were created by the organization's management 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 management account
* and signals the master that it can finalize the process to enable all features.
*
*
*
*
* @param 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 management 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 management account to only invited member accounts.
* Created accounts do not receive this because those accounts were created by the organization's management
* 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 management
* account and signals the master that it can finalize the process to enable all features.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionType
*/
public Handshake withAction(ActionType action) {
this.action = action.toString();
return this;
}
/**
*
* Additional information that is needed to process the handshake.
*
*
* @return Additional information that is needed to process the handshake.
*/
public java.util.List getResources() {
return resources;
}
/**
*
* Additional information that is needed to process the handshake.
*
*
* @param resources
* Additional information that is needed to process the handshake.
*/
public void setResources(java.util.Collection resources) {
if (resources == null) {
this.resources = null;
return;
}
this.resources = new java.util.ArrayList(resources);
}
/**
*
* Additional information that is needed to process the handshake.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setResources(java.util.Collection)} or {@link #withResources(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param resources
* Additional information that is needed to process the handshake.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Handshake withResources(HandshakeResource... resources) {
if (this.resources == null) {
setResources(new java.util.ArrayList(resources.length));
}
for (HandshakeResource ele : resources) {
this.resources.add(ele);
}
return this;
}
/**
*
* Additional information that is needed to process the handshake.
*
*
* @param resources
* Additional information that is needed to process the handshake.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Handshake withResources(java.util.Collection resources) {
setResources(resources);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getParties() != null)
sb.append("Parties: ").append(getParties()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getRequestedTimestamp() != null)
sb.append("RequestedTimestamp: ").append(getRequestedTimestamp()).append(",");
if (getExpirationTimestamp() != null)
sb.append("ExpirationTimestamp: ").append(getExpirationTimestamp()).append(",");
if (getAction() != null)
sb.append("Action: ").append(getAction()).append(",");
if (getResources() != null)
sb.append("Resources: ").append(getResources());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Handshake == false)
return false;
Handshake other = (Handshake) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getParties() == null ^ this.getParties() == null)
return false;
if (other.getParties() != null && other.getParties().equals(this.getParties()) == false)
return false;
if (other.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == false)
return false;
if (other.getRequestedTimestamp() == null ^ this.getRequestedTimestamp() == null)
return false;
if (other.getRequestedTimestamp() != null && other.getRequestedTimestamp().equals(this.getRequestedTimestamp()) == false)
return false;
if (other.getExpirationTimestamp() == null ^ this.getExpirationTimestamp() == null)
return false;
if (other.getExpirationTimestamp() != null && other.getExpirationTimestamp().equals(this.getExpirationTimestamp()) == false)
return false;
if (other.getAction() == null ^ this.getAction() == null)
return false;
if (other.getAction() != null && other.getAction().equals(this.getAction()) == false)
return false;
if (other.getResources() == null ^ this.getResources() == null)
return false;
if (other.getResources() != null && other.getResources().equals(this.getResources()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getParties() == null) ? 0 : getParties().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getRequestedTimestamp() == null) ? 0 : getRequestedTimestamp().hashCode());
hashCode = prime * hashCode + ((getExpirationTimestamp() == null) ? 0 : getExpirationTimestamp().hashCode());
hashCode = prime * hashCode + ((getAction() == null) ? 0 : getAction().hashCode());
hashCode = prime * hashCode + ((getResources() == null) ? 0 : getResources().hashCode());
return hashCode;
}
@Override
public Handshake clone() {
try {
return (Handshake) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.organizations.model.transform.HandshakeMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}