Struct rusoto_apigateway::DocumentationPartLocation [−][src]
pub struct DocumentationPartLocation { pub method: Option<String>, pub name: Option<String>, pub path: Option<String>, pub status_code: Option<String>, pub type_: String, }
Specifies the target API entity to which the documentation applies.
Fields
method: Option<String>
The HTTP verb of a method. It is a valid field for the API entity types of METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
, REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
, and RESPONSE_BODY
. The default value is *
for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location
attributes, the child entity's method
attribute must match that of the parent entity exactly.
name: Option<String>
The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER
, MODEL
, PATH_PARAMETER
, QUERY_PARAMETER
, REQUEST_HEADER
, REQUEST_BODY
and RESPONSE_HEADER
. It is an invalid field for any other entity type.
path: Option<String>
The URL path of the target. It is a valid field for the API entity types of RESOURCE
, METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
, REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
, and RESPONSE_BODY
. The default value is /
for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location
attributes, the child entity's path
attribute must match that of the parent entity as a prefix.
status_code: Option<String>
The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE
, RESPONSE_HEADER
, and RESPONSE_BODY
. The default value is *
for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location
attributes, the child entity's statusCode
attribute must match that of the parent entity exactly.
type_: String
[Required] The type of API entity to which the documentation content applies. Valid values are API
, AUTHORIZER
, MODEL
, RESOURCE
, METHOD
, PATH_PARAMETER
, QUERY_PARAMETER
, REQUEST_HEADER
, REQUEST_BODY
, RESPONSE
, RESPONSE_HEADER
, and RESPONSE_BODY
. Content inheritance does not apply to any entity of the API
, AUTHORIZER
, METHOD
, MODEL
, REQUEST_BODY
, or RESOURCE
type.
Trait Implementations
impl Default for DocumentationPartLocation
[src]
impl Default for DocumentationPartLocation
fn default() -> DocumentationPartLocation
[src]
fn default() -> DocumentationPartLocation
Returns the "default value" for a type. Read more
impl Debug for DocumentationPartLocation
[src]
impl Debug for DocumentationPartLocation
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Clone for DocumentationPartLocation
[src]
impl Clone for DocumentationPartLocation
fn clone(&self) -> DocumentationPartLocation
[src]
fn clone(&self) -> DocumentationPartLocation
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl PartialEq for DocumentationPartLocation
[src]
impl PartialEq for DocumentationPartLocation
fn eq(&self, other: &DocumentationPartLocation) -> bool
[src]
fn eq(&self, other: &DocumentationPartLocation) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &DocumentationPartLocation) -> bool
[src]
fn ne(&self, other: &DocumentationPartLocation) -> bool
This method tests for !=
.
Auto Trait Implementations
impl Send for DocumentationPartLocation
impl Send for DocumentationPartLocation
impl Sync for DocumentationPartLocation
impl Sync for DocumentationPartLocation