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

Class UpdateAuthorizerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.UpdateAuthorizerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAuthorizerRequest.Builder,UpdateAuthorizerRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateAuthorizerRequest
extends IotRequest
implements ToCopyableBuilder<UpdateAuthorizerRequest.Builder,UpdateAuthorizerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateAuthorizerRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	authorizerFunctionArn()	The ARN of the authorizer's Lambda function.
String	authorizerName()	The authorizer name.
static UpdateAuthorizerRequest.Builder	builder()
Boolean	enableCachingForHttp()	When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTokenSigningPublicKeys()	For responses, this returns true if the service returned a value for the TokenSigningPublicKeys property.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAuthorizerRequest.Builder>	serializableBuilderClass()
AuthorizerStatus	status()	The status of the update authorizer request.
String	statusAsString()	The status of the update authorizer request.
UpdateAuthorizerRequest.Builder	toBuilder()
String	tokenKeyName()	The key used to extract the token from the HTTP headers.
Map<String,String>	tokenSigningPublicKeys()	The public keys used to verify the token signature.
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

authorizerName

public final String authorizerName()

The authorizer name.

Returns:

The authorizer name.

authorizerFunctionArn

public final String authorizerFunctionArn()

The ARN of the authorizer's Lambda function.

Returns:

The ARN of the authorizer's Lambda function.

tokenKeyName

public final String tokenKeyName()

The key used to extract the token from the HTTP headers.

Returns:

The key used to extract the token from the HTTP headers.

hasTokenSigningPublicKeys

public final boolean hasTokenSigningPublicKeys()

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

tokenSigningPublicKeys

public final Map<String,String> tokenSigningPublicKeys()

The public keys used to verify the token signature.

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

Returns:

The public keys used to verify the token signature.

status

public final AuthorizerStatus status()

The status of the update authorizer request.

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

Returns:

The status of the update authorizer request.

See Also:

AuthorizerStatus

statusAsString

public final String statusAsString()

The status of the update authorizer request.

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

Returns:

The status of the update authorizer request.

See Also:

AuthorizerStatus

enableCachingForHttp

public final Boolean enableCachingForHttp()

When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.

Returns:

When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.

toBuilder

public UpdateAuthorizerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateAuthorizerRequest.Builder,UpdateAuthorizerRequest>

Specified by:

toBuilder in class IotRequest

builder

public static UpdateAuthorizerRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo