class Amazonite::ApiGateway::GetResourcesRequest

Overview

Request to list information about a collection of resources.

Included Modules

Defined in:

api_gateway/get_resources_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(rest_api_id : String, position : String | Nil = nil, limit : Int32 | Nil = nil, embed : Array(String) | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def embed : Array(String) | Nil #

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.


[View source]
def embed=(embed : Array(String) | Nil) #

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.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def limit : Int32 | Nil #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.


[View source]
def limit=(limit : Int32 | Nil) #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.


[View source]
def position : String | Nil #

The current pagination position in the paged result set.


[View source]
def position=(position : String | Nil) #

The current pagination position in the paged result set.


[View source]
def rest_api_id : String #

The string identifier of the associated RestApi.


[View source]
def rest_api_id=(rest_api_id : String) #

The string identifier of the associated RestApi.


[View source]
def validate! : Nil #

[View source]