Struct aws_sdk_datapipeline::client::fluent_builders::DescribeObjects

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

Fluent builder constructing a request to DescribeObjects.

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.DescribeObjects Content-Length: 98 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"pipelineId": "df-06372391ZG65EXAMPLE", "objectIds": ["Schedule"], "evaluateExpressions": true} x-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef Content-Type: application/x-amz-json-1.1 Content-Length: 1488 Date: Mon, 12 Nov 2012 17:50:53 GMT {"hasMoreResults": false, "pipelineObjects": [ {"fields": [ {"key": "startDateTime", "stringValue": "2012-12-12T00:00:00"}, {"key": "parent", "refValue": "Default"}, {"key": "@sphere", "stringValue": "COMPONENT"}, {"key": "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", "stringValue": "2012-12-21T18:00:00"}, {"key": "@version", "stringValue": "1"}, {"key": "@status", "stringValue": "PENDING"}, {"key": "@pipelineId", "stringValue": "df-06372391ZG65EXAMPLE"} ], "id": "Schedule", "name": "Schedule"} ] }

Implementations

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

pub async fn send(
    self
) -> Result<DescribeObjectsOutput, SdkError<DescribeObjectsError>> where
    R::Policy: SmithyRetryPolicy<DescribeObjectsInputOperationOutputAlias, DescribeObjectsOutput, DescribeObjectsError, DescribeObjectsInputOperationRetryAlias>, 

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 into_paginator(self) -> DescribeObjectsPaginator<C, M, R>

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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

The ID of the pipeline that contains the object definitions.

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

The ID of the pipeline that contains the object definitions.

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

Appends an item to objectIds.

To override the contents of this collection use set_object_ids.

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

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

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

pub fn evaluate_expressions(self, input: bool) -> Self

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

pub fn set_evaluate_expressions(self, input: Option<bool>) -> Self

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

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

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

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

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Trait Implementations

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

fn clone(&self) -> DescribeObjects<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 DescribeObjects<C, M, R>

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

Formats the value using the given formatter.