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("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 Description static interfaceTestInvokeAuthorizerResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,List<String>>authorization()The authorization response.static TestInvokeAuthorizerResponse.Builderbuilder()Map<String,String>claims()The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.IntegerclientStatus()The HTTP status code that the client would have received.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAuthorization()For responses, this returns true if the service returned a value for the Authorization property.booleanhasClaims()For responses, this returns true if the service returned a value for the Claims property.inthashCode()Longlatency()The execution latency, in ms, of the test authorizer request.Stringlog()The API Gateway execution log for the test authorizer request.Stringpolicy()The JSON policy document returned by the AuthorizerStringprincipalId()The principal identity returned by the AuthorizerMap<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends TestInvokeAuthorizerResponse.Builder>serializableBuilderClass()TestInvokeAuthorizerResponse.BuildertoBuilder()StringtoString()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, in ms, of the test authorizer request.
- Returns:
- The execution latency, in ms, 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()
For responses, this returns true if the service returned a value for the Authorization property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
authorization
public final Map<String,List<String>> authorization()
The authorization response.
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
hasAuthorization()method.- Returns:
- The authorization response.
-
hasClaims
public final boolean hasClaims()
For responses, this returns true if the service returned a value for the Claims property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
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.
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
hasClaims()method.- 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:
toBuilderin interfaceToCopyableBuilder<TestInvokeAuthorizerResponse.Builder,TestInvokeAuthorizerResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static TestInvokeAuthorizerResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends TestInvokeAuthorizerResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-