software.amazon.awssdk.services.ec2.model

Class AllowedPrincipal

java.lang.Object

software.amazon.awssdk.services.ec2.model.AllowedPrincipal

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AllowedPrincipal.Builder,AllowedPrincipal>

@Generated(value="software.amazon.awssdk:codegen")
public final class AllowedPrincipal
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AllowedPrincipal.Builder,AllowedPrincipal>

Describes a principal.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AllowedPrincipal.Builder

Method Summary

Modifier and Type	Method and Description
static AllowedPrincipal.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	principal() The Amazon Resource Name (ARN) of the principal.
PrincipalType	principalType() The type of principal.
String	principalTypeAsString() The type of principal.
List<SdkField<?>>	sdkFields()
static Class<? extends AllowedPrincipal.Builder>	serializableBuilderClass()
String	serviceId() The ID of the service.
String	servicePermissionId() The ID of the service permission.
List<Tag>	tags() The tags.
AllowedPrincipal.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

principalType

public final PrincipalType principalType()

The type of principal.

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

Returns:

The type of principal.

See Also:

PrincipalType

principalTypeAsString

public final String principalTypeAsString()

The type of principal.

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

Returns:

The type of principal.

See Also:

PrincipalType

principal

public final String principal()

The Amazon Resource Name (ARN) of the principal.

Returns:

The Amazon Resource Name (ARN) of the principal.

servicePermissionId

public final String servicePermissionId()

The ID of the service permission.

Returns:

The ID of the service permission.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

The tags.

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 hasTags() method.

Returns:

The tags.

serviceId

public final String serviceId()

The ID of the service.

Returns:

The ID of the service.

toBuilder

public AllowedPrincipal.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AllowedPrincipal.Builder,AllowedPrincipal>

builder

public static AllowedPrincipal.Builder builder()

serializableBuilderClass

public static Class<? extends AllowedPrincipal.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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