TestInvokeAuthorizerRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest
    - - software.amazon.awssdk.services.apigateway.model.TestInvokeAuthorizerRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<TestInvokeAuthorizerRequest.Builder,TestInvokeAuthorizerRequest>

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

Make a request to simulate the execution of an Authorizer.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TestInvokeAuthorizerRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TestInvokeAuthorizerRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`additionalContext()` [Optional] A key-value map of additional context variables.
`String`	`authorizerId()` [Required] Specifies a test invoke authorizer request's Authorizer ID.
`String`	`body()` [Optional] The simulated request body of an incoming invocation request.
`static TestInvokeAuthorizerRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalContext()` Returns true if the AdditionalContext 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()`
`boolean`	`hasHeaders()` Returns true if the Headers 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`	`hasMultiValueHeaders()` Returns true if the MultiValueHeaders 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`	`hasStageVariables()` Returns true if the StageVariables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Map<String,String>`	`headers()` [Required] A key-value map of headers to simulate an incoming invocation request.
`Map<String,List<String>>`	`multiValueHeaders()` [Optional] The headers as a map from string to list of values to simulate an incoming invocation request.
`String`	`pathWithQueryString()` [Optional] The URI path, including query string, of the simulated invocation request.
`String`	`restApiId()` [Required] The string identifier of the associated RestApi.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TestInvokeAuthorizerRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`stageVariables()` A key-value map of stage variables to simulate an invocation on a deployed Stage.
`TestInvokeAuthorizerRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - restApiId
```
public final String restApiId()
```
    [Required] The string identifier of the associated RestApi.
    
    Returns:
    
    [Required] The string identifier of the associated RestApi.
  - authorizerId
```
public final String authorizerId()
```
    [Required] Specifies a test invoke authorizer request's Authorizer ID.
    
    Returns:
    
    [Required] Specifies a test invoke authorizer request's Authorizer ID.
  - hasHeaders
```
public final boolean hasHeaders()
```
    Returns true if the Headers 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.
  - headers
```
public final 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasHeaders() to see if a value was sent in this field.
    
    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.
  - hasMultiValueHeaders
```
public final boolean hasMultiValueHeaders()
```
    Returns true if the MultiValueHeaders 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.
  - multiValueHeaders
```
public final Map<String,List<String>> multiValueHeaders()
```
    [Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasMultiValueHeaders() to see if a value was sent in this field.
    
    Returns:
    
    [Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
  - pathWithQueryString
```
public final String pathWithQueryString()
```
    [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.
  - body
```
public final String body()
```
    [Optional] The simulated request body of an incoming invocation request.
    
    Returns:
    
    [Optional] The simulated request body of an incoming invocation request.
  - hasStageVariables
```
public final boolean hasStageVariables()
```
    Returns true if the StageVariables 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.
  - stageVariables
```
public final Map<String,String> stageVariables()
```
    A key-value map of stage variables to simulate an invocation on a deployed Stage.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasStageVariables() to see if a value was sent in this field.
    
    Returns:
    
    A key-value map of stage variables to simulate an invocation on a deployed Stage.
  - hasAdditionalContext
```
public final boolean hasAdditionalContext()
```
    Returns true if the AdditionalContext 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.
  - additionalContext
```
public final Map<String,String> additionalContext()
```
    [Optional] A key-value map of additional context variables.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAdditionalContext() to see if a value was sent in this field.
    
    Returns:
    
    [Optional] A key-value map of additional context variables.
  - toBuilder
```
public TestInvokeAuthorizerRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TestInvokeAuthorizerRequest.Builder,TestInvokeAuthorizerRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayRequest
  - builder
```
public static TestInvokeAuthorizerRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TestInvokeAuthorizerRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class TestInvokeAuthorizerRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

restApiId

authorizerId

hasHeaders

headers

hasMultiValueHeaders

multiValueHeaders

pathWithQueryString

body

hasStageVariables

stageVariables

hasAdditionalContext

additionalContext

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields