/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.apigateway.model; import java.io.Serializable; import javax.annotation.Generated; /** *
* 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetMethodResult extends com.amazonaws.AmazonWebServiceResult* The method's HTTP verb. *
*/ private String httpMethod; /** *
* 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.
*
* The identifier of an Authorizer to use on this method. The authorizationType
must be
* CUSTOM
.
*
* A boolean flag specifying whether a valid ApiKey is required to invoke this method. *
*/ private Boolean apiKeyRequired; /** ** The identifier of a RequestValidator for request validation. *
*/ private String requestValidatorId; /** *
* 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.
*
* 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.
*
* 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). *
*/ private java.util.Map* Gets a method response associated with a given HTTP status code. *
*/ private java.util.Map* 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. *
*/ private Integration methodIntegration; /** *
* 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.
*
* The method's HTTP verb. *
* * @param httpMethod * The method's HTTP verb. */ public void setHttpMethod(String httpMethod) { this.httpMethod = httpMethod; } /** ** The method's HTTP verb. *
* * @return The method's HTTP verb. */ public String getHttpMethod() { return this.httpMethod; } /** ** The method's HTTP verb. *
* * @param httpMethod * The method's HTTP verb. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMethodResult withHttpMethod(String httpMethod) { setHttpMethod(httpMethod); return this; } /** *
* 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 void setAuthorizationType(String authorizationType) {
this.authorizationType = 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 String getAuthorizationType() {
return this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetMethodResult withAuthorizationType(String authorizationType) {
setAuthorizationType(authorizationType);
return this;
}
/**
*
* The identifier of an Authorizer to use on this method. The authorizationType
must be
* CUSTOM
.
*
authorizationType
must be
* CUSTOM
.
*/
public void setAuthorizerId(String authorizerId) {
this.authorizerId = authorizerId;
}
/**
*
* The identifier of an Authorizer to use on this method. The authorizationType
must be
* CUSTOM
.
*
authorizationType
must be
* CUSTOM
.
*/
public String getAuthorizerId() {
return this.authorizerId;
}
/**
*
* The identifier of an Authorizer to use on this method. The authorizationType
must be
* CUSTOM
.
*
authorizationType
must be
* CUSTOM
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetMethodResult withAuthorizerId(String authorizerId) {
setAuthorizerId(authorizerId);
return this;
}
/**
* * A boolean flag specifying whether a valid ApiKey is required to invoke this method. *
* * @param apiKeyRequired * A boolean flag specifying whether a valid ApiKey is required to invoke this method. */ public void setApiKeyRequired(Boolean apiKeyRequired) { this.apiKeyRequired = apiKeyRequired; } /** ** A boolean flag specifying whether a valid ApiKey is required to invoke this method. *
* * @return A boolean flag specifying whether a valid ApiKey is required to invoke this method. */ public Boolean getApiKeyRequired() { return this.apiKeyRequired; } /** ** A boolean flag specifying whether a valid ApiKey is required to invoke this method. *
* * @param apiKeyRequired * A boolean flag specifying whether a valid ApiKey is required to invoke this method. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMethodResult withApiKeyRequired(Boolean apiKeyRequired) { setApiKeyRequired(apiKeyRequired); return this; } /** ** A boolean flag specifying whether a valid ApiKey is required to invoke this method. *
* * @return A boolean flag specifying whether a valid ApiKey is required to invoke this method. */ public Boolean isApiKeyRequired() { return this.apiKeyRequired; } /** ** The identifier of a RequestValidator for request validation. *
* * @param requestValidatorId * The identifier of a RequestValidator for request validation. */ public void setRequestValidatorId(String requestValidatorId) { this.requestValidatorId = requestValidatorId; } /** ** The identifier of a RequestValidator for request validation. *
* * @return The identifier of a RequestValidator for request validation. */ public String getRequestValidatorId() { return this.requestValidatorId; } /** ** The identifier of a RequestValidator for request validation. *
* * @param requestValidatorId * The identifier of a RequestValidator for request validation. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMethodResult withRequestValidatorId(String requestValidatorId) { setRequestValidatorId(requestValidatorId); return this; } /** *
* 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 void setOperationName(String operationName) {
this.operationName = 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 String getOperationName() {
return this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetMethodResult withOperationName(String operationName) {
setOperationName(operationName);
return this;
}
/**
*
* 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 java.util.Map
* 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(java.util.Map
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetMethodResult withRequestParameters(java.util.Map* 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). *
* * @return 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 java.util.Map* 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). *
* * @param 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 void setRequestModels(java.util.Map* 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). *
* * @param 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). * @return Returns a reference to this object so that method calls can be chained together. */ public GetMethodResult withRequestModels(java.util.Map* Gets a method response associated with a given HTTP status code. *
* * @return Gets a method response associated with a given HTTP status code. */ public java.util.Map* Gets a method response associated with a given HTTP status code. *
* * @param methodResponses * Gets a method response associated with a given HTTP status code. */ public void setMethodResponses(java.util.Map* Gets a method response associated with a given HTTP status code. *
* * @param methodResponses * Gets a method response associated with a given HTTP status code. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMethodResult withMethodResponses(java.util.Map* 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. *
* * @param 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 void setMethodIntegration(Integration methodIntegration) { this.methodIntegration = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMethodResult withMethodIntegration(Integration methodIntegration) { setMethodIntegration(methodIntegration); return this; } /** *
* 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 java.util.List
* 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(java.util.Collection
* 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 * {@link #setAuthorizationScopes(java.util.Collection)} or {@link #withAuthorizationScopes(java.util.Collection)} * if you want to override the existing values. *
* * @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetMethodResult withAuthorizationScopes(String... authorizationScopes) {
if (this.authorizationScopes == null) {
setAuthorizationScopes(new java.util.ArrayList
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetMethodResult withAuthorizationScopes(java.util.Collection