@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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
PutMethodRequest.Builder |
| 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()
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) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAuthorizationScopes()
For responses, this returns true if the service returned a value for the AuthorizationScopes property.
|
int |
hashCode() |
boolean |
hasRequestModels()
For responses, this returns true if the service returned a value for the RequestModels property.
|
boolean |
hasRequestParameters()
For responses, this returns true if the service returned a value for the RequestParameters property.
|
String |
httpMethod()
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()
The Resource identifier for the new Method resource.
|
String |
restApiId()
The string identifier of the associated RestApi.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutMethodRequest.Builder> |
serializableBuilderClass() |
PutMethodRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String restApiId()
The string identifier of the associated RestApi.
public final String resourceId()
The Resource identifier for the new Method resource.
public final String httpMethod()
Specifies the method request's HTTP method type.
public final 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.
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.public final 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.
public final Boolean apiKeyRequired()
Specifies whether the method required a valid ApiKey.
public final 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 of ListPets for the GET /pets method in the
PetStore example.public final boolean hasRequestParameters()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasRequestParameters() method.
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.public final boolean hasRequestModels()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasRequestModels() method.
public final String requestValidatorId()
The identifier of a RequestValidator for validating the method request.
public final boolean hasAuthorizationScopes()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAuthorizationScopes() method.
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.public PutMethodRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<PutMethodRequest.Builder,PutMethodRequest>toBuilder in class ApiGatewayRequestpublic static PutMethodRequest.Builder builder()
public static Class<? extends PutMethodRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.