JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.apigateway.model

Class PutMethodResult

  • All Implemented Interfaces:
    Serializable, Cloneable


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

    See Also:
    Serialized Form
    • Constructor Detail

      • PutMethodResult

        public PutMethodResult()
    • Method Detail

      • setHttpMethod

        public void setHttpMethod(String httpMethod)

        The method's HTTP verb.

        Parameters:
        httpMethod - The method's HTTP verb.
      • getHttpMethod

        public String getHttpMethod()

        The method's HTTP verb.

        Returns:
        The method's HTTP verb.
      • withHttpMethod

        public PutMethodResult withHttpMethod(String httpMethod)

        The method's HTTP verb.

        Parameters:
        httpMethod - The method's HTTP verb.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setAuthorizationType

        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.

        Parameters:
        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.
      • getAuthorizationType

        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.

        Returns:
        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.
      • withAuthorizationType

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setAuthorizerId

        public void setAuthorizerId(String authorizerId)

        The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

        Parameters:
        authorizerId - The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.
      • getAuthorizerId

        public String getAuthorizerId()

        The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

        Returns:
        The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.
      • withAuthorizerId

        public PutMethodResult withAuthorizerId(String authorizerId)

        The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

        Parameters:
        authorizerId - The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setApiKeyRequired

        public void setApiKeyRequired(Boolean apiKeyRequired)

        A boolean flag specifying whether a valid ApiKey is required to invoke this method.

        Parameters:
        apiKeyRequired - A boolean flag specifying whether a valid ApiKey is required to invoke this method.
      • getApiKeyRequired

        public Boolean getApiKeyRequired()

        A boolean flag specifying whether a valid ApiKey is required to invoke this method.

        Returns:
        A boolean flag specifying whether a valid ApiKey is required to invoke this method.
      • withApiKeyRequired

        public PutMethodResult withApiKeyRequired(Boolean apiKeyRequired)

        A boolean flag specifying whether a valid ApiKey is required to invoke this method.

        Parameters:
        apiKeyRequired - A boolean flag specifying whether a valid ApiKey is required to invoke this method.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isApiKeyRequired

        public Boolean isApiKeyRequired()

        A boolean flag specifying whether a valid ApiKey is required to invoke this method.

        Returns:
        A boolean flag specifying whether a valid ApiKey is required to invoke this method.
      • setRequestValidatorId

        public void setRequestValidatorId(String requestValidatorId)

        The identifier of a RequestValidator for request validation.

        Parameters:
        requestValidatorId - The identifier of a RequestValidator for request validation.
      • getRequestValidatorId

        public String getRequestValidatorId()

        The identifier of a RequestValidator for request validation.

        Returns:
        The identifier of a RequestValidator for request validation.
      • withRequestValidatorId

        public PutMethodResult withRequestValidatorId(String requestValidatorId)

        The identifier of a RequestValidator for request validation.

        Parameters:
        requestValidatorId - The identifier of a RequestValidator for request validation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setOperationName

        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.

        Parameters:
        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.
      • getOperationName

        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.

        Returns:
        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.
      • withOperationName

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getRequestParameters

        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.

        Returns:
        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.
      • setRequestParameters

        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.

        Parameters:
        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.
      • withRequestParameters

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clearRequestParametersEntries

        public PutMethodResult clearRequestParametersEntries()
        Removes all the entries added into RequestParameters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getRequestModels

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

        Returns:
        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).
      • setRequestModels

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

        Parameters:
        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).
      • withRequestModels

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

        Parameters:
        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).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clearRequestModelsEntries

        public PutMethodResult clearRequestModelsEntries()
        Removes all the entries added into RequestModels.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getMethodResponses

        public Map<String,MethodResponse> getMethodResponses()

        Gets a method response associated with a given HTTP status code.

        Returns:
        Gets a method response associated with a given HTTP status code.
      • setMethodResponses

        public void setMethodResponses(Map<String,MethodResponse> methodResponses)

        Gets a method response associated with a given HTTP status code.

        Parameters:
        methodResponses - Gets a method response associated with a given HTTP status code.
      • withMethodResponses

        public PutMethodResult withMethodResponses(Map<String,MethodResponse> methodResponses)

        Gets a method response associated with a given HTTP status code.

        Parameters:
        methodResponses - Gets a method response associated with a given HTTP status code.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • clearMethodResponsesEntries

        public PutMethodResult clearMethodResponsesEntries()
        Removes all the entries added into MethodResponses.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setMethodIntegration

        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.

        Parameters:
        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.
      • getMethodIntegration

        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.

        Returns:
        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.
      • withMethodIntegration

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getAuthorizationScopes

        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.

        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.
      • setAuthorizationScopes

        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.

        Parameters:
        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.
      • withAuthorizationScopes

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withAuthorizationScopes

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /