Struct GetDocumentationPartOutputBuilder

#[non_exhaustive]
pub struct GetDocumentationPartOutputBuilder { /* private fields */ }

A builder for GetDocumentationPartOutput.

Implementations

impl GetDocumentationPartOutputBuilder

pub fn id(self, input: impl Into<String>) -> Self

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

pub fn set_id(self, input: Option<String>) -> Self

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

pub fn get_id(&self) -> &Option<String>

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

pub fn location(self, input: DocumentationPartLocation) -> Self

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.

pub fn set_location(self, input: Option<DocumentationPartLocation>) -> Self

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.

pub fn get_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.

pub fn properties(self, input: impl Into<String>) -> Self

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.

pub fn set_properties(self, input: Option<String>) -> Self

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.

pub fn get_properties(&self) -> &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.

pub fn build(self) -> GetDocumentationPartOutput

Consumes the builder and constructs a GetDocumentationPartOutput.

Trait Implementations

impl Clone for GetDocumentationPartOutputBuilder

fn clone(&self) -> GetDocumentationPartOutputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetDocumentationPartOutputBuilder

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

Formats the value using the given formatter.

impl Default for GetDocumentationPartOutputBuilder

fn default() -> GetDocumentationPartOutputBuilder

Returns the “default value” for a type.

impl PartialEq for GetDocumentationPartOutputBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetDocumentationPartOutputBuilder