Class TestInvokeAuthorizerResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<TestInvokeAuthorizerResponse.Builder,
TestInvokeAuthorizerResponse>
Represents the response of the test invoke request for a custom Authorizer
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe authorization response.builder()
claims()
The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.final Integer
The HTTP status code that the client would have received.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the Authorization property.final boolean
For responses, this returns true if the service returned a value for the Claims property.final int
hashCode()
final Long
latency()
The execution latency, in ms, of the test authorizer request.final String
log()
The API Gateway execution log for the test authorizer request.final String
policy()
The JSON policy document returned by the Authorizerfinal String
The principal identity returned by the Authorizerstatic Class
<? extends TestInvokeAuthorizerResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The API Gateway execution log for the test authorizer request.
- Returns:
- The API Gateway execution log for the test authorizer request.
-
latency
The execution latency, in ms, of the test authorizer request.
- Returns:
- The execution latency, in ms, of the test authorizer request.
-
principalId
The principal identity returned by the Authorizer
- Returns:
- The principal identity returned by the Authorizer
-
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TestInvokeAuthorizerResponse.Builder,
TestInvokeAuthorizerResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-