AuthorizerDescription (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.iot.model.AuthorizerDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AuthorizerDescription.Builder,AuthorizerDescription>

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

The authorizer description.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AuthorizerDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AuthorizerDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`authorizerArn()` The authorizer ARN.
`String`	`authorizerFunctionArn()` The authorizer's Lambda function ARN.
`String`	`authorizerName()` The authorizer name.
`static AuthorizerDescription.Builder`	`builder()`
`Instant`	`creationDate()` The UNIX timestamp of when the authorizer was created.
`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.
`Instant`	`lastModifiedDate()` The UNIX timestamp of when the authorizer was last updated.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AuthorizerDescription.Builder>`	`serializableBuilderClass()`
`Boolean`	`signingDisabled()` Specifies whether IoT validates the token signature in an authorization request.
`AuthorizerStatus`	`status()` The status of the authorizer.
`String`	`statusAsString()` The status of the authorizer.
`AuthorizerDescription.Builder`	`toBuilder()`
`String`	`tokenKeyName()` The key used to extract the token from the HTTP headers.
`Map<String,String>`	`tokenSigningPublicKeys()` The public keys used to validate the token signature returned by your custom authentication service.
`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
  - authorizerName
```
public final String authorizerName()
```
    The authorizer name.
    
    Returns:
    
    The authorizer name.
  - authorizerArn
```
public final String authorizerArn()
```
    The authorizer ARN.
    
    Returns:
    
    The authorizer ARN.
  - authorizerFunctionArn
```
public final String authorizerFunctionArn()
```
    The authorizer's Lambda function ARN.
    
    Returns:
    
    The authorizer's Lambda function ARN.
  - 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 validate the token signature returned by your custom authentication service.
    
    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 validate the token signature returned by your custom authentication service.
  - status
```
public final AuthorizerStatus status()
```
    The status of the authorizer.
    
    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 authorizer.
    
    See Also:
    
    AuthorizerStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the authorizer.
    
    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 authorizer.
    
    See Also:
    
    AuthorizerStatus
  - creationDate
```
public final Instant creationDate()
```
    The UNIX timestamp of when the authorizer was created.
    
    Returns:
    
    The UNIX timestamp of when the authorizer was created.
  - lastModifiedDate
```
public final Instant lastModifiedDate()
```
    The UNIX timestamp of when the authorizer was last updated.
    
    Returns:
    
    The UNIX timestamp of when the authorizer was last updated.
  - signingDisabled
```
public final Boolean signingDisabled()
```
    Specifies whether IoT validates the token signature in an authorization request.
    
    Returns:
    
    Specifies whether IoT validates the token signature in an authorization request.
  - 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 AuthorizerDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AuthorizerDescription.Builder,AuthorizerDescription>
  - builder
```
public static AuthorizerDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AuthorizerDescription.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

Class AuthorizerDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

authorizerName

authorizerArn

authorizerFunctionArn

tokenKeyName

hasTokenSigningPublicKeys

tokenSigningPublicKeys

status

statusAsString

creationDate

lastModifiedDate

signingDisabled

enableCachingForHttp

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields