@Generated(value="software.amazon.awssdk:codegen") public final class PutMethodResponse extends ApiGatewayResponse implements ToCopyableBuilder<PutMethodResponse.Builder,PutMethodResponse>
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
| Modifier and Type | Class and Description |
|---|---|
static interface |
PutMethodResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
Boolean |
apiKeyRequired()
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
|
List<String> |
authorizationScopes()
A list of authorization scopes configured on the method.
|
String |
authorizationType()
The method's authorization type.
|
String |
authorizerId()
The identifier of an Authorizer to use on this method.
|
static PutMethodResponse.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 |
hasMethodResponses()
For responses, this returns true if the service returned a value for the MethodResponses property.
|
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()
The method's HTTP verb.
|
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.
|
Map<String,MethodResponse> |
methodResponses()
Gets a method response associated with a given HTTP status code.
|
String |
operationName()
A human-friendly operation identifier for the method.
|
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).
|
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 request validation.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutMethodResponse.Builder> |
serializableBuilderClass() |
PutMethodResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String httpMethod()
The method's HTTP verb.
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()
The identifier of an Authorizer to use on this method. The authorizationType must be
CUSTOM.
authorizationType must be
CUSTOM.public final Boolean apiKeyRequired()
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
public final String requestValidatorId()
The identifier of a RequestValidator for request validation.
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 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.
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 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()
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).
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 boolean hasMethodResponses()
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,MethodResponse> methodResponses()
Gets a method response associated with a given HTTP status code.
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 hasMethodResponses() method.
public final 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.
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 PutMethodResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<PutMethodResponse.Builder,PutMethodResponse>toBuilder in class AwsResponsepublic static PutMethodResponse.Builder builder()
public static Class<? extends PutMethodResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic 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 SdkResponseCopyright © 2023. All rights reserved.