Struct aws_sdk_apigateway::operation::update_documentation_part::UpdateDocumentationPartOutput
source · #[non_exhaustive]pub struct UpdateDocumentationPartOutput {
pub id: Option<String>,
pub location: Option<DocumentationPartLocation>,
pub properties: Option<String>,
/* private fields */
}
Expand description
A documentation part for a targeted API entity.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.id: Option<String>
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart
is created.
location: Option<DocumentationPartLocation>
The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
properties: Option<String>
A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }"
. Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation
.
Implementations§
source§impl UpdateDocumentationPartOutput
impl UpdateDocumentationPartOutput
sourcepub fn id(&self) -> Option<&str>
pub fn id(&self) -> Option<&str>
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart
is created.
sourcepub fn location(&self) -> Option<&DocumentationPartLocation>
pub fn location(&self) -> Option<&DocumentationPartLocation>
The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
sourcepub fn properties(&self) -> Option<&str>
pub fn properties(&self) -> Option<&str>
A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }"
. Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation
.
source§impl UpdateDocumentationPartOutput
impl UpdateDocumentationPartOutput
sourcepub fn builder() -> UpdateDocumentationPartOutputBuilder
pub fn builder() -> UpdateDocumentationPartOutputBuilder
Creates a new builder-style object to manufacture UpdateDocumentationPartOutput
.
Trait Implementations§
source§impl Clone for UpdateDocumentationPartOutput
impl Clone for UpdateDocumentationPartOutput
source§fn clone(&self) -> UpdateDocumentationPartOutput
fn clone(&self) -> UpdateDocumentationPartOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for UpdateDocumentationPartOutput
impl PartialEq for UpdateDocumentationPartOutput
source§fn eq(&self, other: &UpdateDocumentationPartOutput) -> bool
fn eq(&self, other: &UpdateDocumentationPartOutput) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RequestId for UpdateDocumentationPartOutput
impl RequestId for UpdateDocumentationPartOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for UpdateDocumentationPartOutput
Auto Trait Implementations§
impl Freeze for UpdateDocumentationPartOutput
impl RefUnwindSafe for UpdateDocumentationPartOutput
impl Send for UpdateDocumentationPartOutput
impl Sync for UpdateDocumentationPartOutput
impl Unpin for UpdateDocumentationPartOutput
impl UnwindSafe for UpdateDocumentationPartOutput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more