/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace DataPipeline { namespace Model { /** *

Contains the parameters for DescribeObjects.

See Also:

AWS * API Reference

*/ class DescribeObjectsRequest : public DataPipelineRequest { public: AWS_DATAPIPELINE_API DescribeObjectsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeObjects"; } AWS_DATAPIPELINE_API Aws::String SerializePayload() const override; AWS_DATAPIPELINE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The ID of the pipeline that contains the object definitions.

*/ inline const Aws::String& GetPipelineId() const{ return m_pipelineId; } /** *

The ID of the pipeline that contains the object definitions.

*/ inline bool PipelineIdHasBeenSet() const { return m_pipelineIdHasBeenSet; } /** *

The ID of the pipeline that contains the object definitions.

*/ inline void SetPipelineId(const Aws::String& value) { m_pipelineIdHasBeenSet = true; m_pipelineId = value; } /** *

The ID of the pipeline that contains the object definitions.

*/ inline void SetPipelineId(Aws::String&& value) { m_pipelineIdHasBeenSet = true; m_pipelineId = std::move(value); } /** *

The ID of the pipeline that contains the object definitions.

*/ inline void SetPipelineId(const char* value) { m_pipelineIdHasBeenSet = true; m_pipelineId.assign(value); } /** *

The ID of the pipeline that contains the object definitions.

*/ inline DescribeObjectsRequest& WithPipelineId(const Aws::String& value) { SetPipelineId(value); return *this;} /** *

The ID of the pipeline that contains the object definitions.

*/ inline DescribeObjectsRequest& WithPipelineId(Aws::String&& value) { SetPipelineId(std::move(value)); return *this;} /** *

The ID of the pipeline that contains the object definitions.

*/ inline DescribeObjectsRequest& WithPipelineId(const char* value) { SetPipelineId(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetObjectIds() const{ return m_objectIds; } /** *

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.

*/ inline bool ObjectIdsHasBeenSet() const { return m_objectIdsHasBeenSet; } /** *

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.

*/ inline void SetObjectIds(const Aws::Vector& value) { m_objectIdsHasBeenSet = true; m_objectIds = value; } /** *

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.

*/ inline void SetObjectIds(Aws::Vector&& value) { m_objectIdsHasBeenSet = true; m_objectIds = std::move(value); } /** *

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.

*/ inline DescribeObjectsRequest& WithObjectIds(const Aws::Vector& value) { SetObjectIds(value); return *this;} /** *

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.

*/ inline DescribeObjectsRequest& WithObjectIds(Aws::Vector&& value) { SetObjectIds(std::move(value)); return *this;} /** *

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.

*/ inline DescribeObjectsRequest& AddObjectIds(const Aws::String& value) { m_objectIdsHasBeenSet = true; m_objectIds.push_back(value); return *this; } /** *

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.

*/ inline DescribeObjectsRequest& AddObjectIds(Aws::String&& value) { m_objectIdsHasBeenSet = true; m_objectIds.push_back(std::move(value)); return *this; } /** *

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.

*/ inline DescribeObjectsRequest& AddObjectIds(const char* value) { m_objectIdsHasBeenSet = true; m_objectIds.push_back(value); return *this; } /** *

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

*/ inline bool GetEvaluateExpressions() const{ return m_evaluateExpressions; } /** *

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

*/ inline bool EvaluateExpressionsHasBeenSet() const { return m_evaluateExpressionsHasBeenSet; } /** *

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

*/ inline void SetEvaluateExpressions(bool value) { m_evaluateExpressionsHasBeenSet = true; m_evaluateExpressions = value; } /** *

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

*/ inline DescribeObjectsRequest& WithEvaluateExpressions(bool value) { SetEvaluateExpressions(value); return *this;} /** *

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.

*/ inline const Aws::String& GetMarker() const{ return m_marker; } /** *

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.

*/ inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; } /** *

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.

*/ inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; } /** *

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.

*/ inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); } /** *

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.

*/ inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); } /** *

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.

*/ inline DescribeObjectsRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;} /** *

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.

*/ inline DescribeObjectsRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;} /** *

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.

*/ inline DescribeObjectsRequest& WithMarker(const char* value) { SetMarker(value); return *this;} private: Aws::String m_pipelineId; bool m_pipelineIdHasBeenSet = false; Aws::Vector m_objectIds; bool m_objectIdsHasBeenSet = false; bool m_evaluateExpressions; bool m_evaluateExpressionsHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; }; } // namespace Model } // namespace DataPipeline } // namespace Aws