Struct GetDocumentationPartsInput 

#[non_exhaustive]
pub struct GetDocumentationPartsInput {
    pub rest_api_id: Option<String>,
    pub type: Option<DocumentationPartType>,
    pub name_query: Option<String>,
    pub path: Option<String>,
    pub position: Option<String>,
    pub limit: Option<i32>,
    pub location_status: Option<LocationStatusType>,
}

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

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.

rest_api_id: Option<String>

The string identifier of the associated RestApi.

type: Option<DocumentationPartType>

The type of API entities of the to-be-retrieved documentation parts.

name_query: Option<String>

The name of API entities of the to-be-retrieved documentation parts.

path: Option<String>

The path of API entities of the to-be-retrieved documentation parts.

position: Option<String>

The current pagination position in the paged result set.

limit: Option<i32>

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

location_status: Option<LocationStatusType>

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

Implementations

impl GetDocumentationPartsInput

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

The string identifier of the associated RestApi.

pub fn type(&self) -> Option<&DocumentationPartType>

The type of API entities of the to-be-retrieved documentation parts.

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

The name of API entities of the to-be-retrieved documentation parts.

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

The path of API entities of the to-be-retrieved documentation parts.

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

The current pagination position in the paged result set.

pub fn limit(&self) -> Option<i32>

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

pub fn location_status(&self) -> Option<&LocationStatusType>

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

impl GetDocumentationPartsInput

pub fn builder() -> GetDocumentationPartsInputBuilder

Creates a new builder-style object to manufacture GetDocumentationPartsInput.

Trait Implementations

impl Clone for GetDocumentationPartsInput

fn clone(&self) -> GetDocumentationPartsInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetDocumentationPartsInput

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

Formats the value using the given formatter.

impl PartialEq for GetDocumentationPartsInput

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

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

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 GetDocumentationPartsInput