/** * 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 QueryObjects.

See Also:

AWS * API Reference

*/ class QueryObjectsRequest : public DataPipelineRequest { public: AWS_DATAPIPELINE_API QueryObjectsRequest(); // 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 "QueryObjects"; } AWS_DATAPIPELINE_API Aws::String SerializePayload() const override; AWS_DATAPIPELINE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The ID of the pipeline.

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

The ID of the pipeline.

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

The ID of the pipeline.

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

The ID of the pipeline.

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

The ID of the pipeline.

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

The ID of the pipeline.

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

The ID of the pipeline.

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

The ID of the pipeline.

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

The query that defines the objects to be returned. The Query * object can contain a maximum of ten selectors. The conditions in the query are * limited to top-level String fields in the object. These filters can be applied * to components, instances, and attempts.

*/ inline const Query& GetQuery() const{ return m_query; } /** *

The query that defines the objects to be returned. The Query * object can contain a maximum of ten selectors. The conditions in the query are * limited to top-level String fields in the object. These filters can be applied * to components, instances, and attempts.

*/ inline bool QueryHasBeenSet() const { return m_queryHasBeenSet; } /** *

The query that defines the objects to be returned. The Query * object can contain a maximum of ten selectors. The conditions in the query are * limited to top-level String fields in the object. These filters can be applied * to components, instances, and attempts.

*/ inline void SetQuery(const Query& value) { m_queryHasBeenSet = true; m_query = value; } /** *

The query that defines the objects to be returned. The Query * object can contain a maximum of ten selectors. The conditions in the query are * limited to top-level String fields in the object. These filters can be applied * to components, instances, and attempts.

*/ inline void SetQuery(Query&& value) { m_queryHasBeenSet = true; m_query = std::move(value); } /** *

The query that defines the objects to be returned. The Query * object can contain a maximum of ten selectors. The conditions in the query are * limited to top-level String fields in the object. These filters can be applied * to components, instances, and attempts.

*/ inline QueryObjectsRequest& WithQuery(const Query& value) { SetQuery(value); return *this;} /** *

The query that defines the objects to be returned. The Query * object can contain a maximum of ten selectors. The conditions in the query are * limited to top-level String fields in the object. These filters can be applied * to components, instances, and attempts.

*/ inline QueryObjectsRequest& WithQuery(Query&& value) { SetQuery(std::move(value)); return *this;} /** *

Indicates whether the query applies to components or instances. The possible * values are: COMPONENT, INSTANCE, and * ATTEMPT.

*/ inline const Aws::String& GetSphere() const{ return m_sphere; } /** *

Indicates whether the query applies to components or instances. The possible * values are: COMPONENT, INSTANCE, and * ATTEMPT.

*/ inline bool SphereHasBeenSet() const { return m_sphereHasBeenSet; } /** *

Indicates whether the query applies to components or instances. The possible * values are: COMPONENT, INSTANCE, and * ATTEMPT.

*/ inline void SetSphere(const Aws::String& value) { m_sphereHasBeenSet = true; m_sphere = value; } /** *

Indicates whether the query applies to components or instances. The possible * values are: COMPONENT, INSTANCE, and * ATTEMPT.

*/ inline void SetSphere(Aws::String&& value) { m_sphereHasBeenSet = true; m_sphere = std::move(value); } /** *

Indicates whether the query applies to components or instances. The possible * values are: COMPONENT, INSTANCE, and * ATTEMPT.

*/ inline void SetSphere(const char* value) { m_sphereHasBeenSet = true; m_sphere.assign(value); } /** *

Indicates whether the query applies to components or instances. The possible * values are: COMPONENT, INSTANCE, and * ATTEMPT.

*/ inline QueryObjectsRequest& WithSphere(const Aws::String& value) { SetSphere(value); return *this;} /** *

Indicates whether the query applies to components or instances. The possible * values are: COMPONENT, INSTANCE, and * ATTEMPT.

*/ inline QueryObjectsRequest& WithSphere(Aws::String&& value) { SetSphere(std::move(value)); return *this;} /** *

Indicates whether the query applies to components or instances. The possible * values are: COMPONENT, INSTANCE, and * ATTEMPT.

*/ inline QueryObjectsRequest& WithSphere(const char* value) { SetSphere(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 * QueryObjects 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 * QueryObjects 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 * QueryObjects 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 * QueryObjects 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 * QueryObjects 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 * QueryObjects with the marker value from the previous call to * retrieve the next set of results.

*/ inline QueryObjectsRequest& 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 * QueryObjects with the marker value from the previous call to * retrieve the next set of results.

*/ inline QueryObjectsRequest& 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 * QueryObjects with the marker value from the previous call to * retrieve the next set of results.

*/ inline QueryObjectsRequest& WithMarker(const char* value) { SetMarker(value); return *this;} /** *

The maximum number of object names that QueryObjects will return * in a single call. The default value is 100.

*/ inline int GetLimit() const{ return m_limit; } /** *

The maximum number of object names that QueryObjects will return * in a single call. The default value is 100.

*/ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** *

The maximum number of object names that QueryObjects will return * in a single call. The default value is 100.

*/ inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; } /** *

The maximum number of object names that QueryObjects will return * in a single call. The default value is 100.

*/ inline QueryObjectsRequest& WithLimit(int value) { SetLimit(value); return *this;} private: Aws::String m_pipelineId; bool m_pipelineIdHasBeenSet = false; Query m_query; bool m_queryHasBeenSet = false; Aws::String m_sphere; bool m_sphereHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; int m_limit; bool m_limitHasBeenSet = false; }; } // namespace Model } // namespace DataPipeline } // namespace Aws