Class HandshakeResource

java.lang.Object
software.amazon.awssdk.services.organizations.model.HandshakeResource
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HandshakeResource.Builder,HandshakeResource>
@Generated("software.amazon.awssdk:codegen") public final class HandshakeResource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HandshakeResource.Builder,HandshakeResource>

Contains additional data that is needed to process a handshake.

See Also:

  • Method Details

    • value

      public final 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.

      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.

    • type

      public final HandshakeResourceType type()

      The type of information being passed, specifying how the value is to be interpreted by the other party:

      • ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.

      • OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.

      • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

      If the service returns an enum value that is not available in the current SDK version, type will return HandshakeResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of information being passed, specifying how the value is to be interpreted by the other party:

      • ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.

      • OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.

      • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of information being passed, specifying how the value is to be interpreted by the other party:

      • ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.

      • OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.

      • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

      If the service returns an enum value that is not available in the current SDK version, type will return HandshakeResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of information being passed, specifying how the value is to be interpreted by the other party:

      • ACCOUNT - Specifies an Amazon Web Services 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 management account. Included as information about an organization.

      • OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.

      • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

      See Also:

    • hasResources

      public final boolean hasResources()
      For responses, this returns true if the service returned a value for the Resources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • resources

      public final List<HandshakeResource> resources()

      When needed, contains an additional array of HandshakeResource objects.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResources() method.

      Returns:
      When needed, contains an additional array of HandshakeResource objects.

    • toBuilder

      public HandshakeResource.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HandshakeResource.Builder,HandshakeResource>
      Returns:
      a builder for type T

    • builder

      public static HandshakeResource.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HandshakeResource.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.