Class TestInvokeAuthorizerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.TestInvokeAuthorizerRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class TestInvokeAuthorizerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Make a request to simulate the execution of an Authorizer.

See Also:

• Serialized Form

Field Summary

Fields inherited from class AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
TestInvokeAuthorizerRequest()

Method Summary

Modifier and Type	Method	Description
TestInvokeAuthorizerRequest	addAdditionalContextEntry(String key, String value)
TestInvokeAuthorizerRequest	addHeadersEntry(String key, String value)
TestInvokeAuthorizerRequest	addStageVariablesEntry(String key, String value)
TestInvokeAuthorizerRequest	clearAdditionalContextEntries()	Removes all the entries added into AdditionalContext.
TestInvokeAuthorizerRequest	clearHeadersEntries()	Removes all the entries added into Headers.
TestInvokeAuthorizerRequest	clearStageVariablesEntries()	Removes all the entries added into StageVariables.
TestInvokeAuthorizerRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
Map<String,String>	getAdditionalContext()	[Optional] A key-value map of additional context variables.
String	getAuthorizerId()	Specifies a test invoke authorizer request's Authorizer ID.
String	getBody()	[Optional] The simulated request body of an incoming invocation request.
Map<String,String>	getHeaders()	[Required] A key-value map of headers to simulate an incoming invocation request.
String	getPathWithQueryString()	[Optional] The URI path, including query string, of the simulated invocation request.
String	getRestApiId()	Specifies a test invoke authorizer request's RestApi identifier.
Map<String,String>	getStageVariables()	A key-value map of stage variables to simulate an invocation on a deployed Stage.
int	hashCode()
void	setAdditionalContext(Map<String,String> additionalContext)	[Optional] A key-value map of additional context variables.
void	setAuthorizerId(String authorizerId)	Specifies a test invoke authorizer request's Authorizer ID.
void	setBody(String body)	[Optional] The simulated request body of an incoming invocation request.
void	setHeaders(Map<String,String> headers)	[Required] A key-value map of headers to simulate an incoming invocation request.
void	setPathWithQueryString(String pathWithQueryString)	[Optional] The URI path, including query string, of the simulated invocation request.
void	setRestApiId(String restApiId)	Specifies a test invoke authorizer request's RestApi identifier.
void	setStageVariables(Map<String,String> stageVariables)	A key-value map of stage variables to simulate an invocation on a deployed Stage.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
TestInvokeAuthorizerRequest	withAdditionalContext(Map<String,String> additionalContext)	[Optional] A key-value map of additional context variables.
TestInvokeAuthorizerRequest	withAuthorizerId(String authorizerId)	Specifies a test invoke authorizer request's Authorizer ID.
TestInvokeAuthorizerRequest	withBody(String body)	[Optional] The simulated request body of an incoming invocation request.
TestInvokeAuthorizerRequest	withHeaders(Map<String,String> headers)	[Required] A key-value map of headers to simulate an incoming invocation request.
TestInvokeAuthorizerRequest	withPathWithQueryString(String pathWithQueryString)	[Optional] The URI path, including query string, of the simulated invocation request.
TestInvokeAuthorizerRequest	withRestApiId(String restApiId)	Specifies a test invoke authorizer request's RestApi identifier.
TestInvokeAuthorizerRequest	withStageVariables(Map<String,String> stageVariables)	A key-value map of stage variables to simulate an invocation on a deployed Stage.

Methods inherited from class AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TestInvokeAuthorizerRequest

public TestInvokeAuthorizerRequest()

Method Details

setRestApiId

public void setRestApiId(String restApiId)

Specifies a test invoke authorizer request's RestApi identifier.

Parameters:

restApiId - Specifies a test invoke authorizer request's RestApi identifier.

getRestApiId

public String getRestApiId()

Specifies a test invoke authorizer request's RestApi identifier.

Returns:

Specifies a test invoke authorizer request's RestApi identifier.

withRestApiId

public TestInvokeAuthorizerRequest withRestApiId(String restApiId)

Specifies a test invoke authorizer request's RestApi identifier.

Parameters:

restApiId - Specifies a test invoke authorizer request's RestApi identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAuthorizerId

public void setAuthorizerId(String authorizerId)

Specifies a test invoke authorizer request's Authorizer ID.

Parameters:

authorizerId - Specifies a test invoke authorizer request's Authorizer ID.

getAuthorizerId

public String getAuthorizerId()

Specifies a test invoke authorizer request's Authorizer ID.

Returns:

Specifies a test invoke authorizer request's Authorizer ID.

withAuthorizerId

public TestInvokeAuthorizerRequest withAuthorizerId(String authorizerId)

Specifies a test invoke authorizer request's Authorizer ID.

Parameters:

authorizerId - Specifies a test invoke authorizer request's Authorizer ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

getHeaders

public Map<String,String> getHeaders()

[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

Returns:

[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

setHeaders

public void setHeaders(Map<String,String> headers)

[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

Parameters:

headers - [Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

withHeaders

public TestInvokeAuthorizerRequest withHeaders(Map<String,String> headers)

[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

Parameters:

headers - [Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

addHeadersEntry

public TestInvokeAuthorizerRequest addHeadersEntry(String key,
 String value)

clearHeadersEntries

public TestInvokeAuthorizerRequest clearHeadersEntries()

Removes all the entries added into Headers. <p> Returns a reference to this object so that method calls can be chained together.

setPathWithQueryString

public void setPathWithQueryString(String pathWithQueryString)

[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

Parameters:

pathWithQueryString - [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

getPathWithQueryString

public String getPathWithQueryString()

[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

Returns:

[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

withPathWithQueryString

public TestInvokeAuthorizerRequest withPathWithQueryString(String pathWithQueryString)

[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

Parameters:

pathWithQueryString - [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBody

public void setBody(String body)

[Optional] The simulated request body of an incoming invocation request.

Parameters:

body - [Optional] The simulated request body of an incoming invocation request.

getBody

public String getBody()

[Optional] The simulated request body of an incoming invocation request.

Returns:

[Optional] The simulated request body of an incoming invocation request.

withBody

public TestInvokeAuthorizerRequest withBody(String body)

[Optional] The simulated request body of an incoming invocation request.

Parameters:

body - [Optional] The simulated request body of an incoming invocation request.

Returns:

Returns a reference to this object so that method calls can be chained together.

getStageVariables

public Map<String,String> getStageVariables()

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Returns:

A key-value map of stage variables to simulate an invocation on a deployed Stage.

setStageVariables

public void setStageVariables(Map<String,String> stageVariables)

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Parameters:

stageVariables - A key-value map of stage variables to simulate an invocation on a deployed Stage.

withStageVariables

public TestInvokeAuthorizerRequest withStageVariables(Map<String,String> stageVariables)

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Parameters:

stageVariables - A key-value map of stage variables to simulate an invocation on a deployed Stage.

Returns:

Returns a reference to this object so that method calls can be chained together.

addStageVariablesEntry

public TestInvokeAuthorizerRequest addStageVariablesEntry(String key,
 String value)

clearStageVariablesEntries

public TestInvokeAuthorizerRequest clearStageVariablesEntries()

Removes all the entries added into StageVariables. <p> Returns a reference to this object so that method calls can be chained together.

getAdditionalContext

public Map<String,String> getAdditionalContext()

[Optional] A key-value map of additional context variables.

Returns:

[Optional] A key-value map of additional context variables.

setAdditionalContext

public void setAdditionalContext(Map<String,String> additionalContext)

[Optional] A key-value map of additional context variables.

Parameters:

additionalContext - [Optional] A key-value map of additional context variables.

withAdditionalContext

public TestInvokeAuthorizerRequest withAdditionalContext(Map<String,String> additionalContext)

[Optional] A key-value map of additional context variables.

Parameters:

additionalContext - [Optional] A key-value map of additional context variables.

Returns:

Returns a reference to this object so that method calls can be chained together.

addAdditionalContextEntry

public TestInvokeAuthorizerRequest addAdditionalContextEntry(String key,
 String value)

clearAdditionalContextEntries

public TestInvokeAuthorizerRequest clearAdditionalContextEntries()

Removes all the entries added into AdditionalContext. <p> 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 TestInvokeAuthorizerRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

• Object.clone()