Package software.amazon.awssdk.services.opensearch.model

Class AuthorizedPrincipal

java.lang.Object

software.amazon.awssdk.services.opensearch.model.AuthorizedPrincipal

All Implemented Interfaces:

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

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

Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AuthorizedPrincipal.Builder

Method Summary

Modifier and Type	Method	Description
static AuthorizedPrincipal.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	principal()	The IAM principal that is allowed access to the domain.
final PrincipalType	principalType()	The type of principal.
final String	principalTypeAsString()	The type of principal.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends AuthorizedPrincipal.Builder>	serializableBuilderClass()
final ServiceOptions	serviceOptions()	The options for the service, including the supported Regions for the endpoint access.
AuthorizedPrincipal.Builder	toBuilder()
final 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 Details

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 IAM principal that is allowed access to the domain.

Returns:

The IAM principal that is allowed access to the domain.

serviceOptions

public final ServiceOptions serviceOptions()

The options for the service, including the supported Regions for the endpoint access.

Returns:

The options for the service, including the supported Regions for the endpoint access.

toBuilder

public AuthorizedPrincipal.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthorizedPrincipal.Builder,AuthorizedPrincipal>

builder

public static AuthorizedPrincipal.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo