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 PutMethodRequest

    • Constructor Detail

      • PutMethodRequest

        public PutMethodRequest()
    • Method Detail

      • setRestApiId

        public void setRestApiId(String restApiId)

        The string identifier of the associated RestApi.

        Parameters:
        restApiId - The string identifier of the associated RestApi.
      • getRestApiId

        public String getRestApiId()

        The string identifier of the associated RestApi.

        Returns:
        The string identifier of the associated RestApi.
      • withRestApiId

        public PutMethodRequest withRestApiId(String restApiId)

        The string identifier of the associated RestApi.

        Parameters:
        restApiId - The string identifier of the associated RestApi.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setResourceId

        public void setResourceId(String resourceId)

        The Resource identifier for the new Method resource.

        Parameters:
        resourceId - The Resource identifier for the new Method resource.
      • getResourceId

        public String getResourceId()

        The Resource identifier for the new Method resource.

        Returns:
        The Resource identifier for the new Method resource.
      • withResourceId

        public PutMethodRequest withResourceId(String resourceId)

        The Resource identifier for the new Method resource.

        Parameters:
        resourceId - The Resource identifier for the new Method resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setHttpMethod

        public void setHttpMethod(String httpMethod)

        Specifies the method request's HTTP method type.

        Parameters:
        httpMethod - Specifies the method request's HTTP method type.
      • getHttpMethod

        public String getHttpMethod()

        Specifies the method request's HTTP method type.

        Returns:
        Specifies the method request's HTTP method type.
      • withHttpMethod

        public PutMethodRequest withHttpMethod(String httpMethod)

        Specifies the method request's HTTP method type.

        Parameters:
        httpMethod - Specifies the method request's HTTP method type.
        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 PutMethodRequest 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)

        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.

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

        public String getAuthorizerId()

        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.

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

        public PutMethodRequest withAuthorizerId(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.

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

        public void setApiKeyRequired(Boolean apiKeyRequired)

        Specifies whether the method required a valid ApiKey.

        Parameters:
        apiKeyRequired - Specifies whether the method required a valid ApiKey.
      • getApiKeyRequired

        public Boolean getApiKeyRequired()

        Specifies whether the method required a valid ApiKey.

        Returns:
        Specifies whether the method required a valid ApiKey.
      • withApiKeyRequired

        public PutMethodRequest withApiKeyRequired(Boolean apiKeyRequired)

        Specifies whether the method required a valid ApiKey.

        Parameters:
        apiKeyRequired - Specifies whether the method required a valid ApiKey.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isApiKeyRequired

        public Boolean isApiKeyRequired()

        Specifies whether the method required a valid ApiKey.

        Returns:
        Specifies whether the method required a valid ApiKey.
      • 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 PutMethodRequest 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 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.

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

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

        public PutMethodRequest 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 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.

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

        public PutMethodRequest 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()

        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.

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

        public void setRequestModels(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.

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

        public PutMethodRequest withRequestModels(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.

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

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

        public void setRequestValidatorId(String requestValidatorId)

        The identifier of a RequestValidator for validating the method request.

        Parameters:
        requestValidatorId - The identifier of a RequestValidator for validating the method request.
      • getRequestValidatorId

        public String getRequestValidatorId()

        The identifier of a RequestValidator for validating the method request.

        Returns:
        The identifier of a RequestValidator for validating the method request.
      • withRequestValidatorId

        public PutMethodRequest withRequestValidatorId(String requestValidatorId)

        The identifier of a RequestValidator for validating the method request.

        Parameters:
        requestValidatorId - The identifier of a RequestValidator for validating the method request.
        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 PutMethodRequest 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 PutMethodRequest 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 によって変換されたページ (->オリジナル) /