@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PutMethodResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
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.
Constructor and Description |
---|
PutMethodResult() |
Modifier and Type | Method and Description |
---|---|
PutMethodResult |
addMethodResponsesEntry(String key,
MethodResponse value)
Add a single MethodResponses entry
|
PutMethodResult |
addRequestModelsEntry(String key,
String value)
Add a single RequestModels entry
|
PutMethodResult |
addRequestParametersEntry(String key,
Boolean value)
Add a single RequestParameters entry
|
PutMethodResult |
clearMethodResponsesEntries()
Removes all the entries added into MethodResponses.
|
PutMethodResult |
clearRequestModelsEntries()
Removes all the entries added into RequestModels.
|
PutMethodResult |
clearRequestParametersEntries()
Removes all the entries added into RequestParameters.
|
PutMethodResult |
clone() |
boolean |
equals(Object obj) |
Boolean |
getApiKeyRequired()
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
|
List<String> |
getAuthorizationScopes()
A list of authorization scopes configured on the method.
|
String |
getAuthorizationType()
The method's authorization type.
|
String |
getAuthorizerId()
The identifier of an Authorizer to use on this method.
|
String |
getHttpMethod()
The method's HTTP verb.
|
Integration |
getMethodIntegration()
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> |
getMethodResponses()
Gets a method response associated with a given HTTP status code.
|
String |
getOperationName()
A human-friendly operation identifier for the method.
|
Map<String,String> |
getRequestModels()
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> |
getRequestParameters()
A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
|
String |
getRequestValidatorId()
The identifier of a RequestValidator for request validation.
|
int |
hashCode() |
Boolean |
isApiKeyRequired()
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
|
void |
setApiKeyRequired(Boolean apiKeyRequired)
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
|
void |
setAuthorizationScopes(Collection<String> authorizationScopes)
A list of authorization scopes configured on the method.
|
void |
setAuthorizationType(String authorizationType)
The method's authorization type.
|
void |
setAuthorizerId(String authorizerId)
The identifier of an Authorizer to use on this method.
|
void |
setHttpMethod(String httpMethod)
The method's HTTP verb.
|
void |
setMethodIntegration(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.
|
void |
setMethodResponses(Map<String,MethodResponse> methodResponses)
Gets a method response associated with a given HTTP status code.
|
void |
setOperationName(String operationName)
A human-friendly operation identifier for the method.
|
void |
setRequestModels(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).
|
void |
setRequestParameters(Map<String,Boolean> requestParameters)
A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
|
void |
setRequestValidatorId(String requestValidatorId)
The identifier of a RequestValidator for request validation.
|
String |
toString()
Returns a string representation of this object.
|
PutMethodResult |
withApiKeyRequired(Boolean apiKeyRequired)
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
|
PutMethodResult |
withAuthorizationScopes(Collection<String> authorizationScopes)
A list of authorization scopes configured on the method.
|
PutMethodResult |
withAuthorizationScopes(String... authorizationScopes)
A list of authorization scopes configured on the method.
|
PutMethodResult |
withAuthorizationType(String authorizationType)
The method's authorization type.
|
PutMethodResult |
withAuthorizerId(String authorizerId)
The identifier of an Authorizer to use on this method.
|
PutMethodResult |
withHttpMethod(String httpMethod)
The method's HTTP verb.
|
PutMethodResult |
withMethodIntegration(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.
|
PutMethodResult |
withMethodResponses(Map<String,MethodResponse> methodResponses)
Gets a method response associated with a given HTTP status code.
|
PutMethodResult |
withOperationName(String operationName)
A human-friendly operation identifier for the method.
|
PutMethodResult |
withRequestModels(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).
|
PutMethodResult |
withRequestParameters(Map<String,Boolean> requestParameters)
A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
|
PutMethodResult |
withRequestValidatorId(String requestValidatorId)
The identifier of a RequestValidator for request validation.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setHttpMethod(String httpMethod)
The method's HTTP verb.
httpMethod
- The method's HTTP verb.public String getHttpMethod()
The method's HTTP verb.
public PutMethodResult withHttpMethod(String httpMethod)
The method's HTTP verb.
httpMethod
- The method's HTTP verb.public void setAuthorizationType(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.
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.public String getAuthorizationType()
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 PutMethodResult withAuthorizationType(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.
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.public void setAuthorizerId(String authorizerId)
The identifier of an Authorizer to use on this method. The authorizationType
must be
CUSTOM
.
authorizerId
- The identifier of an Authorizer to use on this method. The authorizationType
must be
CUSTOM
.public String getAuthorizerId()
The identifier of an Authorizer to use on this method. The authorizationType
must be
CUSTOM
.
authorizationType
must be
CUSTOM
.public PutMethodResult withAuthorizerId(String authorizerId)
The identifier of an Authorizer to use on this method. The authorizationType
must be
CUSTOM
.
authorizerId
- The identifier of an Authorizer to use on this method. The authorizationType
must be
CUSTOM
.public void setApiKeyRequired(Boolean apiKeyRequired)
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
apiKeyRequired
- A boolean flag specifying whether a valid ApiKey is required to invoke this method.public Boolean getApiKeyRequired()
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
public PutMethodResult withApiKeyRequired(Boolean apiKeyRequired)
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
apiKeyRequired
- A boolean flag specifying whether a valid ApiKey is required to invoke this method.public Boolean isApiKeyRequired()
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
public void setRequestValidatorId(String requestValidatorId)
The identifier of a RequestValidator for request validation.
requestValidatorId
- The identifier of a RequestValidator for request validation.public String getRequestValidatorId()
The identifier of a RequestValidator for request validation.
public PutMethodResult withRequestValidatorId(String requestValidatorId)
The identifier of a RequestValidator for request validation.
requestValidatorId
- The identifier of a RequestValidator for request validation.public void setOperationName(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
- 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.public String getOperationName()
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 PutMethodResult withOperationName(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
- 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.public Map<String,Boolean> getRequestParameters()
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.
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 void setRequestParameters(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.
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.public PutMethodResult withRequestParameters(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.
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.public PutMethodResult addRequestParametersEntry(String key, Boolean value)
public PutMethodResult clearRequestParametersEntries()
public Map<String,String> getRequestModels()
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).
public void setRequestModels(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).
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).public PutMethodResult withRequestModels(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).
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).public PutMethodResult addRequestModelsEntry(String key, String value)
public PutMethodResult clearRequestModelsEntries()
public Map<String,MethodResponse> getMethodResponses()
Gets a method response associated with a given HTTP status code.
public void setMethodResponses(Map<String,MethodResponse> methodResponses)
Gets a method response associated with a given HTTP status code.
methodResponses
- Gets a method response associated with a given HTTP status code.public PutMethodResult withMethodResponses(Map<String,MethodResponse> methodResponses)
Gets a method response associated with a given HTTP status code.
methodResponses
- Gets a method response associated with a given HTTP status code.public PutMethodResult addMethodResponsesEntry(String key, MethodResponse value)
public PutMethodResult clearMethodResponsesEntries()
public void setMethodIntegration(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.
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 Integration getMethodIntegration()
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 PutMethodResult withMethodIntegration(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.
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 List<String> getAuthorizationScopes()
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.
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 void setAuthorizationScopes(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.
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.public PutMethodResult withAuthorizationScopes(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.
NOTE: This method appends the values to the existing list (if any). Use
setAuthorizationScopes(java.util.Collection)
or withAuthorizationScopes(java.util.Collection)
if you want to override the existing values.
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.public PutMethodResult withAuthorizationScopes(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.
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.public String toString()
toString
in class Object
Object.toString()
public PutMethodResult clone()