TestInvokeAuthorizerResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.apigateway.model.TestInvokeAuthorizerResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TestInvokeAuthorizerResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

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

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

TestInvokeAuthorizerResult()

Constructors
Constructor and Description
`TestInvokeAuthorizerResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TestInvokeAuthorizerResult`	`addAuthorizationEntry(String key, List<String> value)`
`TestInvokeAuthorizerResult`	`addClaimsEntry(String key, String value)`
`TestInvokeAuthorizerResult`	`clearAuthorizationEntries()` Removes all the entries added into Authorization.
`TestInvokeAuthorizerResult`	`clearClaimsEntries()` Removes all the entries added into Claims.
`TestInvokeAuthorizerResult`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,List<String>>`	`getAuthorization()`
`Map<String,String>`	`getClaims()` The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
`Integer`	`getClientStatus()` The HTTP status code that the client would have received.
`Long`	`getLatency()` The execution latency of the test authorizer request.
`String`	`getLog()` The Amazon API Gateway execution log for the test authorizer request.
`String`	`getPolicy()` The JSON policy document returned by the Authorizer
`String`	`getPrincipalId()` The principal identity returned by the Authorizer
`int`	`hashCode()`
`void`	`setAuthorization(Map<String,List<String>> authorization)`
`void`	`setClaims(Map<String,String> claims)` The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
`void`	`setClientStatus(Integer clientStatus)` The HTTP status code that the client would have received.
`void`	`setLatency(Long latency)` The execution latency of the test authorizer request.
`void`	`setLog(String log)` The Amazon API Gateway execution log for the test authorizer request.
`void`	`setPolicy(String policy)` The JSON policy document returned by the Authorizer
`void`	`setPrincipalId(String principalId)` The principal identity returned by the Authorizer
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TestInvokeAuthorizerResult`	`withAuthorization(Map<String,List<String>> authorization)`
`TestInvokeAuthorizerResult`	`withClaims(Map<String,String> claims)` The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
`TestInvokeAuthorizerResult`	`withClientStatus(Integer clientStatus)` The HTTP status code that the client would have received.
`TestInvokeAuthorizerResult`	`withLatency(Long latency)` The execution latency of the test authorizer request.
`TestInvokeAuthorizerResult`	`withLog(String log)` The Amazon API Gateway execution log for the test authorizer request.
`TestInvokeAuthorizerResult`	`withPolicy(String policy)` The JSON policy document returned by the Authorizer
`TestInvokeAuthorizerResult`	`withPrincipalId(String principalId)` The principal identity returned by the Authorizer

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TestInvokeAuthorizerResult
```
public TestInvokeAuthorizerResult()
```
- Method Detail
  - setClientStatus
```
public void setClientStatus(Integer clientStatus)
```
    The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
    
    Parameters:
    
    clientStatus - The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
  - getClientStatus
```
public Integer getClientStatus()
```
    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.
  - withClientStatus
```
public TestInvokeAuthorizerResult withClientStatus(Integer clientStatus)
```
    The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
    
    Parameters:
    
    clientStatus - The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLog
```
public void setLog(String log)
```
    The Amazon API Gateway execution log for the test authorizer request.
    
    Parameters:
    
    log - The Amazon API Gateway execution log for the test authorizer request.
  - getLog
```
public String getLog()
```
    The Amazon API Gateway execution log for the test authorizer request.
    
    Returns:
    
    The Amazon API Gateway execution log for the test authorizer request.
  - withLog
```
public TestInvokeAuthorizerResult withLog(String log)
```
    The Amazon API Gateway execution log for the test authorizer request.
    
    Parameters:
    
    log - The Amazon API Gateway execution log for the test authorizer request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLatency
```
public void setLatency(Long latency)
```
    The execution latency of the test authorizer request.
    
    Parameters:
    
    latency - The execution latency of the test authorizer request.
  - getLatency
```
public Long getLatency()
```
    The execution latency of the test authorizer request.
    
    Returns:
    
    The execution latency of the test authorizer request.
  - withLatency
```
public TestInvokeAuthorizerResult withLatency(Long latency)
```
    The execution latency of the test authorizer request.
    
    Parameters:
    
    latency - The execution latency of the test authorizer request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrincipalId
```
public void setPrincipalId(String principalId)
```
    The principal identity returned by the Authorizer
    
    Parameters:
    
    principalId - The principal identity returned by the Authorizer
  - getPrincipalId
```
public String getPrincipalId()
```
    The principal identity returned by the Authorizer
    
    Returns:
    
    The principal identity returned by the Authorizer
  - withPrincipalId
```
public TestInvokeAuthorizerResult withPrincipalId(String principalId)
```
    The principal identity returned by the Authorizer
    
    Parameters:
    
    principalId - The principal identity returned by the Authorizer
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicy
```
public void setPolicy(String policy)
```
    The JSON policy document returned by the Authorizer
    
    Parameters:
    
    policy - The JSON policy document returned by the Authorizer
  - getPolicy
```
public String getPolicy()
```
    The JSON policy document returned by the Authorizer
    
    Returns:
    
    The JSON policy document returned by the Authorizer
  - withPolicy
```
public TestInvokeAuthorizerResult withPolicy(String policy)
```
    The JSON policy document returned by the Authorizer
    
    Parameters:
    
    policy - The JSON policy document returned by the Authorizer
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAuthorization
```
public Map<String,List<String>> getAuthorization()
```
    Returns:
  - setAuthorization
```
public void setAuthorization(Map<String,List<String>> authorization)
```
    Parameters:
    
    authorization -
  - withAuthorization
```
public TestInvokeAuthorizerResult withAuthorization(Map<String,List<String>> authorization)
```
    Parameters:
    
    authorization -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAuthorizationEntry
```
public TestInvokeAuthorizerResult addAuthorizationEntry(String key,
                                                        List<String> value)
```
  - clearAuthorizationEntries
```
public TestInvokeAuthorizerResult clearAuthorizationEntries()
```
    Removes all the entries added into Authorization.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getClaims
```
public Map<String,String> getClaims()
```
    The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
    
    Returns:
    
    The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
  - setClaims
```
public void setClaims(Map<String,String> claims)
```
    The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
    
    Parameters:
    
    claims - The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
  - withClaims
```
public TestInvokeAuthorizerResult withClaims(Map<String,String> claims)
```
    The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
    
    Parameters:
    
    claims - The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addClaimsEntry
```
public TestInvokeAuthorizerResult addClaimsEntry(String key,
                                                 String value)
```
  - clearClaimsEntries
```
public TestInvokeAuthorizerResult clearClaimsEntries()
```
    Removes all the entries added into Claims.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TestInvokeAuthorizerResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class TestInvokeAuthorizerResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

TestInvokeAuthorizerResult

Method Detail

setClientStatus

getClientStatus

withClientStatus

setLog

getLog

withLog

setLatency

getLatency

withLatency

setPrincipalId

getPrincipalId

withPrincipalId

setPolicy

getPolicy

withPolicy

getAuthorization

setAuthorization

withAuthorization

addAuthorizationEntry

clearAuthorizationEntries

getClaims

setClaims

withClaims

addClaimsEntry

clearClaimsEntries

toString

equals

hashCode

clone