/** * 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 DirectoryService { namespace Model { /** *

Contains the inputs for the DescribeDirectories * operation.

See Also:

AWS * API Reference

*/ class DescribeDirectoriesRequest : public DirectoryServiceRequest { public: AWS_DIRECTORYSERVICE_API DescribeDirectoriesRequest(); // 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 "DescribeDirectories"; } AWS_DIRECTORYSERVICE_API Aws::String SerializePayload() const override; AWS_DIRECTORYSERVICE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

A list of identifiers of the directories for which to obtain the information. * If this member is null, all directories that belong to the current account are * returned.

An empty list results in an * InvalidParameterException being thrown.

*/ inline const Aws::Vector& GetDirectoryIds() const{ return m_directoryIds; } /** *

A list of identifiers of the directories for which to obtain the information. * If this member is null, all directories that belong to the current account are * returned.

An empty list results in an * InvalidParameterException being thrown.

*/ inline bool DirectoryIdsHasBeenSet() const { return m_directoryIdsHasBeenSet; } /** *

A list of identifiers of the directories for which to obtain the information. * If this member is null, all directories that belong to the current account are * returned.

An empty list results in an * InvalidParameterException being thrown.

*/ inline void SetDirectoryIds(const Aws::Vector& value) { m_directoryIdsHasBeenSet = true; m_directoryIds = value; } /** *

A list of identifiers of the directories for which to obtain the information. * If this member is null, all directories that belong to the current account are * returned.

An empty list results in an * InvalidParameterException being thrown.

*/ inline void SetDirectoryIds(Aws::Vector&& value) { m_directoryIdsHasBeenSet = true; m_directoryIds = std::move(value); } /** *

A list of identifiers of the directories for which to obtain the information. * If this member is null, all directories that belong to the current account are * returned.

An empty list results in an * InvalidParameterException being thrown.

*/ inline DescribeDirectoriesRequest& WithDirectoryIds(const Aws::Vector& value) { SetDirectoryIds(value); return *this;} /** *

A list of identifiers of the directories for which to obtain the information. * If this member is null, all directories that belong to the current account are * returned.

An empty list results in an * InvalidParameterException being thrown.

*/ inline DescribeDirectoriesRequest& WithDirectoryIds(Aws::Vector&& value) { SetDirectoryIds(std::move(value)); return *this;} /** *

A list of identifiers of the directories for which to obtain the information. * If this member is null, all directories that belong to the current account are * returned.

An empty list results in an * InvalidParameterException being thrown.

*/ inline DescribeDirectoriesRequest& AddDirectoryIds(const Aws::String& value) { m_directoryIdsHasBeenSet = true; m_directoryIds.push_back(value); return *this; } /** *

A list of identifiers of the directories for which to obtain the information. * If this member is null, all directories that belong to the current account are * returned.

An empty list results in an * InvalidParameterException being thrown.

*/ inline DescribeDirectoriesRequest& AddDirectoryIds(Aws::String&& value) { m_directoryIdsHasBeenSet = true; m_directoryIds.push_back(std::move(value)); return *this; } /** *

A list of identifiers of the directories for which to obtain the information. * If this member is null, all directories that belong to the current account are * returned.

An empty list results in an * InvalidParameterException being thrown.

*/ inline DescribeDirectoriesRequest& AddDirectoryIds(const char* value) { m_directoryIdsHasBeenSet = true; m_directoryIds.push_back(value); return *this; } /** *

The DescribeDirectoriesResult.NextToken value from a previous * call to DescribeDirectories. Pass null if this is the first call.

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

The DescribeDirectoriesResult.NextToken value from a previous * call to DescribeDirectories. Pass null if this is the first call.

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

The DescribeDirectoriesResult.NextToken value from a previous * call to DescribeDirectories. Pass null if this is the first call.

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

The DescribeDirectoriesResult.NextToken value from a previous * call to DescribeDirectories. Pass null if this is the first call.

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

The DescribeDirectoriesResult.NextToken value from a previous * call to DescribeDirectories. Pass null if this is the first call.

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

The DescribeDirectoriesResult.NextToken value from a previous * call to DescribeDirectories. Pass null if this is the first call.

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

The DescribeDirectoriesResult.NextToken value from a previous * call to DescribeDirectories. Pass null if this is the first call.

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

The DescribeDirectoriesResult.NextToken value from a previous * call to DescribeDirectories. Pass null if this is the first call.

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

The maximum number of items to return. If this value is zero, the maximum * number of items is specified by the limitations of the operation.

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

The maximum number of items to return. If this value is zero, the maximum * number of items is specified by the limitations of the operation.

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

The maximum number of items to return. If this value is zero, the maximum * number of items is specified by the limitations of the operation.

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

The maximum number of items to return. If this value is zero, the maximum * number of items is specified by the limitations of the operation.

*/ inline DescribeDirectoriesRequest& WithLimit(int value) { SetLimit(value); return *this;} private: Aws::Vector m_directoryIds; bool m_directoryIdsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_limit; bool m_limitHasBeenSet = false; }; } // namespace Model } // namespace DirectoryService } // namespace Aws