class Amazonite::ApiGateway::GetDeploymentRequest

Overview

Requests API Gateway to get information about a Deployment resource.

Included Modules

Defined in:

api_gateway/get_deployment_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(rest_api_id : String, deployment_id : String, embed : Array(String) | Nil = nil) #

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

[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 deployment_id : String #

The identifier of the Deployment resource to get information about.


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

The identifier of the Deployment resource to get information about.


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

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this #embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.


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

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this #embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.


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

See Object#hash(hasher)


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]