software.amazon.awssdk.services.apigateway.model

Interface PutMethodRequest.Builder

All Superinterfaces:

ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<PutMethodRequest.Builder,PutMethodRequest>, SdkBuilder<PutMethodRequest.Builder,PutMethodRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutMethodRequest

public static interface PutMethodRequest.Builder
extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<PutMethodRequest.Builder,PutMethodRequest>

Method Summary

Modifier and Type	Method and Description
PutMethodRequest.Builder	apiKeyRequired(Boolean apiKeyRequired) Specifies whether the method required a valid ApiKey.
PutMethodRequest.Builder	authorizationScopes(Collection<String> authorizationScopes) A list of authorization scopes configured on the method.
PutMethodRequest.Builder	authorizationScopes(String... authorizationScopes) A list of authorization scopes configured on the method.
PutMethodRequest.Builder	authorizationType(String authorizationType) [Required] The method's authorization type.
PutMethodRequest.Builder	authorizerId(String authorizerId) Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS.
PutMethodRequest.Builder	httpMethod(String httpMethod) [Required] Specifies the method request's HTTP method type.
PutMethodRequest.Builder	operationName(String operationName) A human-friendly operation identifier for the method.
PutMethodRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
PutMethodRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
PutMethodRequest.Builder	requestModels(Map<String,String> requestModels) Specifies the Model resources used for the request's content type.
PutMethodRequest.Builder	requestParameters(Map<String,Boolean> requestParameters) A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
PutMethodRequest.Builder	requestValidatorId(String requestValidatorId) The identifier of a RequestValidator for validating the method request.
PutMethodRequest.Builder	resourceId(String resourceId) [Required] The Resource identifier for the new Method resource.
PutMethodRequest.Builder	restApiId(String restApiId) [Required] The string identifier of the associated RestApi.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

restApiId

PutMethodRequest.Builder restApiId(String restApiId)

[Required] The string identifier of the associated RestApi.

Parameters:

restApiId - [Required] The string identifier of the associated RestApi.

Returns:

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

resourceId

PutMethodRequest.Builder resourceId(String resourceId)

[Required] The Resource identifier for the new Method resource.

Parameters:

resourceId - [Required] The Resource identifier for the new Method resource.

Returns:

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

httpMethod

PutMethodRequest.Builder httpMethod(String httpMethod)

[Required] Specifies the method request's HTTP method type.

Parameters:

httpMethod - [Required] Specifies the method request's HTTP method type.

Returns:

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

authorizationType

PutMethodRequest.Builder authorizationType(String authorizationType)

[Required] 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.

Parameters:

authorizationType - [Required] 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.

Returns:

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

authorizerId

PutMethodRequest.Builder authorizerId(String authorizerId)

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Parameters:

authorizerId - Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Returns:

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

apiKeyRequired

PutMethodRequest.Builder apiKeyRequired(Boolean apiKeyRequired)

Specifies whether the method required a valid ApiKey.

Parameters:

apiKeyRequired - Specifies whether the method required a valid ApiKey.

Returns:

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

operationName

PutMethodRequest.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 PetStore example.

Parameters:

operationName - A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.

Returns:

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

requestParameters

PutMethodRequest.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 defines 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 body-mapping templates.

Parameters:

requestParameters - A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines 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 body-mapping templates.

Returns:

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

requestModels

PutMethodRequest.Builder requestModels(Map<String,String> requestModels)

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Parameters:

requestModels - Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Returns:

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

requestValidatorId

PutMethodRequest.Builder requestValidatorId(String requestValidatorId)

The identifier of a RequestValidator for validating the method request.

Parameters:

requestValidatorId - The identifier of a RequestValidator for validating the method request.

Returns:

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

authorizationScopes

PutMethodRequest.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.

Parameters:

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.

Returns:

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

authorizationScopes

PutMethodRequest.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.

Parameters:

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.

Returns:

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

overrideConfiguration

PutMethodRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

PutMethodRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.