public static interface GetMethodResponse.Builder extends ApiGatewayResponse.Builder, SdkPojo, CopyableBuilder<GetMethodResponse.Builder,GetMethodResponse>
| Modifier and Type | Method and Description |
|---|---|
GetMethodResponse.Builder |
apiKeyRequired(Boolean apiKeyRequired)
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
|
GetMethodResponse.Builder |
authorizationScopes(Collection<String> authorizationScopes)
A list of authorization scopes configured on the method.
|
GetMethodResponse.Builder |
authorizationScopes(String... authorizationScopes)
A list of authorization scopes configured on the method.
|
GetMethodResponse.Builder |
authorizationType(String authorizationType)
The method's authorization type.
|
GetMethodResponse.Builder |
authorizerId(String authorizerId)
The identifier of an Authorizer to use on this method.
|
GetMethodResponse.Builder |
httpMethod(String httpMethod)
The method's HTTP verb.
|
default GetMethodResponse.Builder |
methodIntegration(Consumer<Integration.Builder> methodIntegration)
Gets the method's integration responsible for passing the client-submitted request to the back end and
performing necessary transformations to make the request compliant with the back end.
|
GetMethodResponse.Builder |
methodIntegration(Integration methodIntegration)
Gets the method's integration responsible for passing the client-submitted request to the back end and
performing necessary transformations to make the request compliant with the back end.
|
GetMethodResponse.Builder |
methodResponses(Map<String,MethodResponse> methodResponses)
Gets a method response associated with a given HTTP status code.
|
GetMethodResponse.Builder |
operationName(String operationName)
A human-friendly operation identifier for the method.
|
GetMethodResponse.Builder |
requestModels(Map<String,String> requestModels)
A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request
payloads of given content types (as the mapping key).
|
GetMethodResponse.Builder |
requestParameters(Map<String,Boolean> requestParameters)
A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
|
GetMethodResponse.Builder |
requestValidatorId(String requestValidatorId)
The identifier of a RequestValidator for request validation.
|
build, responseMetadata, responseMetadatasdkHttpResponse, sdkHttpResponseequalsBySdkFields, sdkFieldscopyapplyMutation, buildGetMethodResponse.Builder httpMethod(String httpMethod)
The method's HTTP verb.
httpMethod - The method's HTTP verb.GetMethodResponse.Builder authorizationType(String authorizationType)
The method's authorization type. Valid values are NONE for open access, AWS_IAM for
using AWS IAM permissions, CUSTOM for using a custom authorizer, or
COGNITO_USER_POOLS for using a Cognito user pool.
authorizationType - The method's authorization type. Valid values are NONE for open access,
AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer,
or COGNITO_USER_POOLS for using a Cognito user pool.GetMethodResponse.Builder authorizerId(String authorizerId)
The identifier of an Authorizer to use on this method. The authorizationType must be
CUSTOM.
authorizerId - The identifier of an Authorizer to use on this method. The authorizationType must be
CUSTOM.GetMethodResponse.Builder apiKeyRequired(Boolean apiKeyRequired)
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
apiKeyRequired - A boolean flag specifying whether a valid ApiKey is required to invoke this method.GetMethodResponse.Builder requestValidatorId(String requestValidatorId)
The identifier of a RequestValidator for request validation.
requestValidatorId - The identifier of a RequestValidator for request validation.GetMethodResponse.Builder operationName(String operationName)
A human-friendly operation identifier for the method. For example, you can assign the
operationName of ListPets for the GET /pets method in the
PetStore example.
operationName - A human-friendly operation identifier for the method. For example, you can assign the
operationName of ListPets for the GET /pets method in the
PetStore example.GetMethodResponse.Builder requestParameters(Map<String,Boolean> requestParameters)
A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
A key is a method request parameter name matching the pattern of
method.request.{location}.{name}, where location is querystring,
path, or header and name is a valid and unique parameter name. The
value associated with the key is a Boolean flag indicating whether the parameter is required (
true) or optional (false). The method request parameter names defined here are
available in Integration to be mapped to integration request parameters or templates.
requestParameters - A key-value map defining required or optional method request parameters that can be accepted by API
Gateway. A key is a method request parameter name matching the pattern of
method.request.{location}.{name}, where location is querystring
, path, or header and name is a valid and unique parameter
name. The value associated with the key is a Boolean flag indicating whether the parameter is required
(true) or optional (false). The method request parameter names defined here
are available in Integration to be mapped to integration request parameters or templates.GetMethodResponse.Builder requestModels(Map<String,String> requestModels)
A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
requestModels - A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the
request payloads of given content types (as the mapping key).GetMethodResponse.Builder methodResponses(Map<String,MethodResponse> methodResponses)
Gets a method response associated with a given HTTP status code.
methodResponses - Gets a method response associated with a given HTTP status code.GetMethodResponse.Builder methodIntegration(Integration methodIntegration)
Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
methodIntegration - Gets the method's integration responsible for passing the client-submitted request to the back end and
performing necessary transformations to make the request compliant with the back end.default GetMethodResponse.Builder methodIntegration(Consumer<Integration.Builder> methodIntegration)
Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
This is a convenience method that creates an instance of theIntegration.Builder avoiding the need to
create one manually via Integration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to methodIntegration(Integration).
methodIntegration - a consumer that will call methods on Integration.BuildermethodIntegration(Integration)GetMethodResponse.Builder authorizationScopes(Collection<String> authorizationScopes)
A list of authorization scopes configured on the method. The scopes are used with a
COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by
matching the method scopes against the scopes parsed from the access token in the incoming request. The
method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise,
the invocation is not authorized. When the method scope is configured, the client must provide an access
token instead of an identity token for authorization purposes.
authorizationScopes - A list of authorization scopes configured on the method. The scopes are used with a
COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works
by matching the method scopes against the scopes parsed from the access token in the incoming request.
The method invocation is authorized if any method scopes matches a claimed scope in the access token.
Otherwise, the invocation is not authorized. When the method scope is configured, the client must
provide an access token instead of an identity token for authorization purposes.GetMethodResponse.Builder authorizationScopes(String... authorizationScopes)
A list of authorization scopes configured on the method. The scopes are used with a
COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by
matching the method scopes against the scopes parsed from the access token in the incoming request. The
method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise,
the invocation is not authorized. When the method scope is configured, the client must provide an access
token instead of an identity token for authorization purposes.
authorizationScopes - A list of authorization scopes configured on the method. The scopes are used with a
COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works
by matching the method scopes against the scopes parsed from the access token in the incoming request.
The method invocation is authorized if any method scopes matches a claimed scope in the access token.
Otherwise, the invocation is not authorized. When the method scope is configured, the client must
provide an access token instead of an identity token for authorization purposes.Copyright © 2023. All rights reserved.