Package software.amazon.awssdk.services.iot.model

Class AuthInfo

java.lang.Object

software.amazon.awssdk.services.iot.model.AuthInfo

All Implemented Interfaces:

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

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

A collection of authorization information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AuthInfo.Builder

Method Summary

Modifier and Type	Method	Description
ActionType	actionType()	The type of action for which the principal is being authorized.
String	actionTypeAsString()	The type of action for which the principal is being authorized.
static AuthInfo.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResources()	For responses, this returns true if the service returned a value for the Resources property.
List<String>	resources()	The resources for which the principal is being authorized to perform the specified action.
List<SdkField<?>>	sdkFields()
static Class<? extends AuthInfo.Builder>	serializableBuilderClass()
AuthInfo.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

actionType

public final ActionType actionType()

The type of action for which the principal is being authorized.

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

Returns:

The type of action for which the principal is being authorized.

See Also:

ActionType

actionTypeAsString

public final String actionTypeAsString()

The type of action for which the principal is being authorized.

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

Returns:

The type of action for which the principal is being authorized.

See Also:

ActionType

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<String> resources()

The resources for which the principal is being authorized to perform the specified action.

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:

The resources for which the principal is being authorized to perform the specified action.

toBuilder

public AuthInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthInfo.Builder,AuthInfo>

builder

public static AuthInfo.Builder builder()

serializableBuilderClass

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