Interface GetMethodResponse.Builder
- All Superinterfaces:
ApiGatewayResponse.Builder
,AwsResponse.Builder
,Buildable
,CopyableBuilder<GetMethodResponse.Builder,
,GetMethodResponse> SdkBuilder<GetMethodResponse.Builder,
,GetMethodResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetMethodResponse
-
Method Summary
Modifier and TypeMethodDescriptionapiKeyRequired
(Boolean apiKeyRequired) A boolean flag specifying whether a valid ApiKey is required to invoke this method.authorizationScopes
(String... authorizationScopes) A list of authorization scopes configured on the method.authorizationScopes
(Collection<String> authorizationScopes) A list of authorization scopes configured on the method.authorizationType
(String authorizationType) The method's authorization type.authorizerId
(String authorizerId) The identifier of an Authorizer to use on this method.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.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.methodResponses
(Map<String, MethodResponse> methodResponses) Gets a method response associated with a given HTTP status code.operationName
(String operationName) A human-friendly operation identifier for the method.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).requestParameters
(Map<String, Boolean> requestParameters) A key-value map defining required or optional method request parameters that can be accepted by API Gateway.requestValidatorId
(String requestValidatorId) The identifier of a RequestValidator for request validation.Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
httpMethod
The method's HTTP verb.
- Parameters:
httpMethod
- The method's HTTP verb.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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, orCOGNITO_USER_POOLS
for using a Cognito user pool.- Parameters:
authorizationType
- The method's authorization type. Valid values areNONE
for open access,AWS_IAM
for using AWS IAM permissions,CUSTOM
for using a custom authorizer, orCOGNITO_USER_POOLS
for using a Cognito user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authorizerId
The identifier of an Authorizer to use on this method. The
authorizationType
must beCUSTOM
.- Parameters:
authorizerId
- The identifier of an Authorizer to use on this method. TheauthorizationType
must beCUSTOM
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
apiKeyRequired
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
- Parameters:
apiKeyRequired
- A boolean flag specifying whether a valid ApiKey is required to invoke this method.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestValidatorId
The identifier of a RequestValidator for request validation.
- Parameters:
requestValidatorId
- The identifier of a RequestValidator for request validation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operationName
A human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example.- Parameters:
operationName
- A human-friendly operation identifier for the method. For example, you can assign theoperationName
ofListPets
for theGET /pets
method in thePetStore
example.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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}
, wherelocation
isquerystring
,path
, orheader
andname
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.- Parameters:
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 ofmethod.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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).
- Parameters:
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).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
methodResponses
Gets a method response associated with a given HTTP status code.
- Parameters:
methodResponses
- Gets a method response associated with a given HTTP status code.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
methodIntegration
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 viaIntegration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomethodIntegration(Integration)
.- Parameters:
methodIntegration
- a consumer that will call methods onIntegration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
authorizationScopes
- A list of authorization scopes configured on the method. The scopes are used with aCOGNITO_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
authorizationScopes
- A list of authorization scopes configured on the method. The scopes are used with aCOGNITO_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-