@Generated(value="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.
Modifier and Type | Class and Description |
---|---|
static interface |
HandshakeResource.Builder |
Modifier and Type | Method and Description |
---|---|
static HandshakeResource.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasResources()
Returns true if the Resources property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
List<HandshakeResource> |
resources()
When needed, contains an additional array of
HandshakeResource objects. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends HandshakeResource.Builder> |
serializableBuilderClass() |
HandshakeResource.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
HandshakeResourceType |
type()
The type of information being passed, specifying how the value is to be interpreted by the other party:
|
String |
typeAsString()
The type of information being passed, specifying how the value is to be interpreted by the other party:
|
String |
value()
The information that is passed to the other party in the handshake.
|
copy
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.
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 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 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()
.
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 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.
HandshakeResourceType
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 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 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()
.
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 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.
HandshakeResourceType
public final boolean hasResources()
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.
You can use hasResources()
to see if a value was sent in this field.
HandshakeResource
objects.public HandshakeResource.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<HandshakeResource.Builder,HandshakeResource>
public static HandshakeResource.Builder builder()
public static Class<? extends HandshakeResource.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.