/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace Pipes { namespace Model { /** */ class ListPipesRequest : public PipesRequest { public: AWS_PIPES_API ListPipesRequest(); // 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 "ListPipes"; } AWS_PIPES_API Aws::String SerializePayload() const override; AWS_PIPES_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

The state the pipe is in.

*/ inline const PipeState& GetCurrentState() const{ return m_currentState; } /** *

The state the pipe is in.

*/ inline bool CurrentStateHasBeenSet() const { return m_currentStateHasBeenSet; } /** *

The state the pipe is in.

*/ inline void SetCurrentState(const PipeState& value) { m_currentStateHasBeenSet = true; m_currentState = value; } /** *

The state the pipe is in.

*/ inline void SetCurrentState(PipeState&& value) { m_currentStateHasBeenSet = true; m_currentState = std::move(value); } /** *

The state the pipe is in.

*/ inline ListPipesRequest& WithCurrentState(const PipeState& value) { SetCurrentState(value); return *this;} /** *

The state the pipe is in.

*/ inline ListPipesRequest& WithCurrentState(PipeState&& value) { SetCurrentState(std::move(value)); return *this;} /** *

The state the pipe should be in.

*/ inline const RequestedPipeState& GetDesiredState() const{ return m_desiredState; } /** *

The state the pipe should be in.

*/ inline bool DesiredStateHasBeenSet() const { return m_desiredStateHasBeenSet; } /** *

The state the pipe should be in.

*/ inline void SetDesiredState(const RequestedPipeState& value) { m_desiredStateHasBeenSet = true; m_desiredState = value; } /** *

The state the pipe should be in.

*/ inline void SetDesiredState(RequestedPipeState&& value) { m_desiredStateHasBeenSet = true; m_desiredState = std::move(value); } /** *

The state the pipe should be in.

*/ inline ListPipesRequest& WithDesiredState(const RequestedPipeState& value) { SetDesiredState(value); return *this;} /** *

The state the pipe should be in.

*/ inline ListPipesRequest& WithDesiredState(RequestedPipeState&& value) { SetDesiredState(std::move(value)); return *this;} /** *

The maximum number of pipes to include in the response.

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

The maximum number of pipes to include in the response.

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

The maximum number of pipes to include in the response.

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

The maximum number of pipes to include in the response.

*/ inline ListPipesRequest& WithLimit(int value) { SetLimit(value); return *this;} /** *

A value that will return a subset of the pipes associated with this account. * For example, "NamePrefix": "ABC" will return all endpoints with * "ABC" in the name.

*/ inline const Aws::String& GetNamePrefix() const{ return m_namePrefix; } /** *

A value that will return a subset of the pipes associated with this account. * For example, "NamePrefix": "ABC" will return all endpoints with * "ABC" in the name.

*/ inline bool NamePrefixHasBeenSet() const { return m_namePrefixHasBeenSet; } /** *

A value that will return a subset of the pipes associated with this account. * For example, "NamePrefix": "ABC" will return all endpoints with * "ABC" in the name.

*/ inline void SetNamePrefix(const Aws::String& value) { m_namePrefixHasBeenSet = true; m_namePrefix = value; } /** *

A value that will return a subset of the pipes associated with this account. * For example, "NamePrefix": "ABC" will return all endpoints with * "ABC" in the name.

*/ inline void SetNamePrefix(Aws::String&& value) { m_namePrefixHasBeenSet = true; m_namePrefix = std::move(value); } /** *

A value that will return a subset of the pipes associated with this account. * For example, "NamePrefix": "ABC" will return all endpoints with * "ABC" in the name.

*/ inline void SetNamePrefix(const char* value) { m_namePrefixHasBeenSet = true; m_namePrefix.assign(value); } /** *

A value that will return a subset of the pipes associated with this account. * For example, "NamePrefix": "ABC" will return all endpoints with * "ABC" in the name.

*/ inline ListPipesRequest& WithNamePrefix(const Aws::String& value) { SetNamePrefix(value); return *this;} /** *

A value that will return a subset of the pipes associated with this account. * For example, "NamePrefix": "ABC" will return all endpoints with * "ABC" in the name.

*/ inline ListPipesRequest& WithNamePrefix(Aws::String&& value) { SetNamePrefix(std::move(value)); return *this;} /** *

A value that will return a subset of the pipes associated with this account. * For example, "NamePrefix": "ABC" will return all endpoints with * "ABC" in the name.

*/ inline ListPipesRequest& WithNamePrefix(const char* value) { SetNamePrefix(value); return *this;} /** *

If nextToken is returned, there are more results available. The * value of nextToken is a unique pagination token for each page. Make * the call again using the returned token to retrieve the next page. Keep all * other arguments unchanged. Each pagination token expires after 24 hours. Using * an expired pagination token will return an HTTP 400 InvalidToken error.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

If nextToken is returned, there are more results available. The * value of nextToken is a unique pagination token for each page. Make * the call again using the returned token to retrieve the next page. Keep all * other arguments unchanged. Each pagination token expires after 24 hours. Using * an expired pagination token will return an HTTP 400 InvalidToken error.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

If nextToken is returned, there are more results available. The * value of nextToken is a unique pagination token for each page. Make * the call again using the returned token to retrieve the next page. Keep all * other arguments unchanged. Each pagination token expires after 24 hours. Using * an expired pagination token will return an HTTP 400 InvalidToken error.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

If nextToken is returned, there are more results available. The * value of nextToken is a unique pagination token for each page. Make * the call again using the returned token to retrieve the next page. Keep all * other arguments unchanged. Each pagination token expires after 24 hours. Using * an expired pagination token will return an HTTP 400 InvalidToken error.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

If nextToken is returned, there are more results available. The * value of nextToken is a unique pagination token for each page. Make * the call again using the returned token to retrieve the next page. Keep all * other arguments unchanged. Each pagination token expires after 24 hours. Using * an expired pagination token will return an HTTP 400 InvalidToken error.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

If nextToken is returned, there are more results available. The * value of nextToken is a unique pagination token for each page. Make * the call again using the returned token to retrieve the next page. Keep all * other arguments unchanged. Each pagination token expires after 24 hours. Using * an expired pagination token will return an HTTP 400 InvalidToken error.

*/ inline ListPipesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

If nextToken is returned, there are more results available. The * value of nextToken is a unique pagination token for each page. Make * the call again using the returned token to retrieve the next page. Keep all * other arguments unchanged. Each pagination token expires after 24 hours. Using * an expired pagination token will return an HTTP 400 InvalidToken error.

*/ inline ListPipesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

If nextToken is returned, there are more results available. The * value of nextToken is a unique pagination token for each page. Make * the call again using the returned token to retrieve the next page. Keep all * other arguments unchanged. Each pagination token expires after 24 hours. Using * an expired pagination token will return an HTTP 400 InvalidToken error.

*/ inline ListPipesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The prefix matching the pipe source.

*/ inline const Aws::String& GetSourcePrefix() const{ return m_sourcePrefix; } /** *

The prefix matching the pipe source.

*/ inline bool SourcePrefixHasBeenSet() const { return m_sourcePrefixHasBeenSet; } /** *

The prefix matching the pipe source.

*/ inline void SetSourcePrefix(const Aws::String& value) { m_sourcePrefixHasBeenSet = true; m_sourcePrefix = value; } /** *

The prefix matching the pipe source.

*/ inline void SetSourcePrefix(Aws::String&& value) { m_sourcePrefixHasBeenSet = true; m_sourcePrefix = std::move(value); } /** *

The prefix matching the pipe source.

*/ inline void SetSourcePrefix(const char* value) { m_sourcePrefixHasBeenSet = true; m_sourcePrefix.assign(value); } /** *

The prefix matching the pipe source.

*/ inline ListPipesRequest& WithSourcePrefix(const Aws::String& value) { SetSourcePrefix(value); return *this;} /** *

The prefix matching the pipe source.

*/ inline ListPipesRequest& WithSourcePrefix(Aws::String&& value) { SetSourcePrefix(std::move(value)); return *this;} /** *

The prefix matching the pipe source.

*/ inline ListPipesRequest& WithSourcePrefix(const char* value) { SetSourcePrefix(value); return *this;} /** *

The prefix matching the pipe target.

*/ inline const Aws::String& GetTargetPrefix() const{ return m_targetPrefix; } /** *

The prefix matching the pipe target.

*/ inline bool TargetPrefixHasBeenSet() const { return m_targetPrefixHasBeenSet; } /** *

The prefix matching the pipe target.

*/ inline void SetTargetPrefix(const Aws::String& value) { m_targetPrefixHasBeenSet = true; m_targetPrefix = value; } /** *

The prefix matching the pipe target.

*/ inline void SetTargetPrefix(Aws::String&& value) { m_targetPrefixHasBeenSet = true; m_targetPrefix = std::move(value); } /** *

The prefix matching the pipe target.

*/ inline void SetTargetPrefix(const char* value) { m_targetPrefixHasBeenSet = true; m_targetPrefix.assign(value); } /** *

The prefix matching the pipe target.

*/ inline ListPipesRequest& WithTargetPrefix(const Aws::String& value) { SetTargetPrefix(value); return *this;} /** *

The prefix matching the pipe target.

*/ inline ListPipesRequest& WithTargetPrefix(Aws::String&& value) { SetTargetPrefix(std::move(value)); return *this;} /** *

The prefix matching the pipe target.

*/ inline ListPipesRequest& WithTargetPrefix(const char* value) { SetTargetPrefix(value); return *this;} private: PipeState m_currentState; bool m_currentStateHasBeenSet = false; RequestedPipeState m_desiredState; bool m_desiredStateHasBeenSet = false; int m_limit; bool m_limitHasBeenSet = false; Aws::String m_namePrefix; bool m_namePrefixHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; Aws::String m_sourcePrefix; bool m_sourcePrefixHasBeenSet = false; Aws::String m_targetPrefix; bool m_targetPrefixHasBeenSet = false; }; } // namespace Model } // namespace Pipes } // namespace Aws