software.amazon.awssdk.services.apigateway.model

Class TestInvokeAuthorizerResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

software.amazon.awssdk.services.apigateway.model.TestInvokeAuthorizerResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<TestInvokeAuthorizerResponse.Builder,TestInvokeAuthorizerResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class TestInvokeAuthorizerResponse
extends ApiGatewayResponse
implements ToCopyableBuilder<TestInvokeAuthorizerResponse.Builder,TestInvokeAuthorizerResponse>

Represents the response of the test invoke request for a custom Authorizer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TestInvokeAuthorizerResponse.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,List<String>>	authorization() Returns the value of the Authorization property for this object.
static TestInvokeAuthorizerResponse.Builder	builder()
Map<String,String>	claims() The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
Integer	clientStatus() The HTTP status code that the client would have received.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAuthorization() Returns true if the Authorization property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasClaims() Returns true if the Claims property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Long	latency() The execution latency of the test authorizer request.
String	log() The API Gateway execution log for the test authorizer request.
String	policy() The JSON policy document returned by the Authorizer
String	principalId() The principal identity returned by the Authorizer
List<SdkField<?>>	sdkFields()
static Class<? extends TestInvokeAuthorizerResponse.Builder>	serializableBuilderClass()
TestInvokeAuthorizerResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

clientStatus

public final Integer clientStatus()

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

Returns:

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

log

public final String log()

The API Gateway execution log for the test authorizer request.

Returns:

The API Gateway execution log for the test authorizer request.

latency

public final Long latency()

The execution latency of the test authorizer request.

Returns:

The execution latency of the test authorizer request.

principalId

public final String principalId()

The principal identity returned by the Authorizer

Returns:

The principal identity returned by the Authorizer

policy

public final String policy()

The JSON policy document returned by the Authorizer

Returns:

The JSON policy document returned by the Authorizer

hasAuthorization

public final boolean hasAuthorization()

Returns true if the Authorization property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

authorization

public final Map<String,List<String>> authorization()

Returns the value of the Authorization property for this object.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAuthorization() to see if a value was sent in this field.

Returns:

The value of the Authorization property for this object.

hasClaims

public final boolean hasClaims()

Returns true if the Claims property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

claims

public final Map<String,String> claims()

The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasClaims() to see if a value was sent in this field.

Returns:

The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

toBuilder

public TestInvokeAuthorizerResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TestInvokeAuthorizerResponse.Builder,TestInvokeAuthorizerResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static TestInvokeAuthorizerResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo