PutMethodRequest (AWS SDK for Java

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

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

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

Request to add a method to an existing Resource resource.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutMethodRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`apiKeyRequired()` Specifies whether the method required a valid ApiKey.
`List<String>`	`authorizationScopes()` A list of authorization scopes configured on the method.
`String`	`authorizationType()` [Required] The method's authorization type.
`String`	`authorizerId()` Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS.
`static PutMethodRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`httpMethod()` [Required] Specifies the method request's HTTP method type.
`String`	`operationName()` A human-friendly operation identifier for the method.
`Map<String,String>`	`requestModels()` Specifies the Model resources used for the request's content type.
`Map<String,Boolean>`	`requestParameters()` A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
`String`	`requestValidatorId()` The identifier of a RequestValidator for validating the method request.
`String`	`resourceId()` [Required] The Resource identifier for the new Method resource.
`String`	`restApiId()` [Required] The string identifier of the associated RestApi.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutMethodRequest.Builder>`	`serializableBuilderClass()`
`PutMethodRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - restApiId
```
public String restApiId()
```
    [Required] The string identifier of the associated RestApi.
    
    Returns:
    
    [Required] The string identifier of the associated RestApi.
  - resourceId
```
public String resourceId()
```
    [Required] The Resource identifier for the new Method resource.
    
    Returns:
    
    [Required] The Resource identifier for the new Method resource.
  - httpMethod
```
public String httpMethod()
```
    [Required] Specifies the method request's HTTP method type.
    
    Returns:
    
    [Required] Specifies the method request's HTTP method type.
  - authorizationType
```
public 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.
    
    Returns:
    
    [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.
  - authorizerId
```
public 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.
    
    Returns:
    
    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.
  - apiKeyRequired
```
public Boolean apiKeyRequired()
```
    Specifies whether the method required a valid ApiKey.
    
    Returns:
    
    Specifies whether the method required a valid ApiKey.
  - operationName
```
public 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.
    
    Returns:
    
    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.
  - requestParameters
```
public 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - requestModels
```
public 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - requestValidatorId
```
public String requestValidatorId()
```
    The identifier of a RequestValidator for validating the method request.
    
    Returns:
    
    The identifier of a RequestValidator for validating the method request.
  - authorizationScopes
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - toBuilder
```
public PutMethodRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutMethodRequest.Builder,PutMethodRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static PutMethodRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutMethodRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class PutMethodRequest

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

resourceId

httpMethod

authorizationType

authorizerId

apiKeyRequired

operationName

requestParameters

requestModels

requestValidatorId

authorizationScopes

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields