class
Amazonite::ApiGateway::GetResourcesRequest
- Amazonite::ApiGateway::GetResourcesRequest
- Reference
- Object
Overview
Request to list information about a collection of resources.
Included Modules
- JSON::Serializable
Defined in:
api_gateway/get_resources_request.crConstructors
- .new(pull : JSON::PullParser)
- .new(rest_api_id : String, position : String | Nil = nil, limit : Int32 | Nil = nil, embed : Array(String) | Nil = nil)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#embed : Array(String) | Nil
A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.
-
#embed=(embed : Array(String) | Nil)
A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response.
-
#hash(hasher)
See
Object#hash(hasher) -
#limit : Int32 | Nil
The maximum number of returned results per page.
-
#limit=(limit : Int32 | Nil)
The maximum number of returned results per page.
-
#position : String | Nil
The current pagination position in the paged result set.
-
#position=(position : String | Nil)
The current pagination position in the paged result set.
-
#rest_api_id : String
The string identifier of the associated RestApi.
-
#rest_api_id=(rest_api_id : String)
The string identifier of the associated RestApi.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
A query parameter used to retrieve the specified resources embedded in the returned Resources
resource in the response. This #embed parameter value is a list of comma-separated strings.
Currently, the request supports only retrieval of the embedded Method resources this way. The
query parameter value must be a single-valued list and contain the "methods" string. For
example, GET /restapis/{restapi_id}/resources?embed=methods.
A query parameter used to retrieve the specified resources embedded in the returned Resources
resource in the response. This #embed parameter value is a list of comma-separated strings.
Currently, the request supports only retrieval of the embedded Method resources this way. The
query parameter value must be a single-valued list and contain the "methods" string. For
example, GET /restapis/{restapi_id}/resources?embed=methods.
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.