Struct aws_sdk_apigateway::output::CreateModelOutput

#[non_exhaustive]
pub struct CreateModelOutput {
    pub id: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub schema: Option<String>,
    pub content_type: Option<String>,
}

Represents the data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

Method, MethodResponse, Models and Mappings

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

The identifier for the model resource.

name: Option<String>

The name of the model. Must be an alphanumeric string.

description: Option<String>

The description of the model.

schema: Option<String>

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

content_type: Option<String>

The content-type for the model.

Implementations

impl CreateModelOutput

pub fn id(&self) -> Option<&str>

The identifier for the model resource.

pub fn name(&self) -> Option<&str>

The name of the model. Must be an alphanumeric string.

pub fn description(&self) -> Option<&str>

The description of the model.

pub fn schema(&self) -> Option<&str>

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

pub fn content_type(&self) -> Option<&str>

The content-type for the model.

impl CreateModelOutput

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateModelOutput

Trait Implementations

impl Clone for CreateModelOutput

fn clone(&self) -> CreateModelOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateModelOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CreateModelOutput> for CreateModelOutput

fn eq(&self, other: &CreateModelOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateModelOutput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateModelOutput