Struct aws_sdk_workdocs::client::fluent_builders::GetDocumentPath

pub struct GetDocumentPath<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to GetDocumentPath.

Retrieves the path information (the hierarchy from the root folder) for the requested document.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.

Implementations

impl<C, M, R> GetDocumentPath<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetDocumentPathOutput, SdkError<GetDocumentPathError>> where
    R::Policy: SmithyRetryPolicy<GetDocumentPathInputOperationOutputAlias, GetDocumentPathOutput, GetDocumentPathError, GetDocumentPathInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

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

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

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

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

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

The ID of the document.

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

The ID of the document.

pub fn limit(self, input: i32) -> Self

The maximum number of levels in the hierarchy to return.

pub fn set_limit(self, input: Option<i32>) -> Self

The maximum number of levels in the hierarchy to return.

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

A comma-separated list of values. Specify NAME to include the names of the parent folders.

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

A comma-separated list of values. Specify NAME to include the names of the parent folders.

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

This value is not supported.

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

This value is not supported.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for GetDocumentPath<C, M, R>

fn clone(&self) -> GetDocumentPath<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for GetDocumentPath<C, M, R>

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

Formats the value using the given formatter.