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

Amazon WorkDocs authentication token. Not required when using Amazon Web * Services administrator credentials to access the API.

*/ inline const Aws::String& GetAuthenticationToken() const{ return m_authenticationToken; } /** *

Amazon WorkDocs authentication token. Not required when using Amazon Web * Services administrator credentials to access the API.

*/ inline bool AuthenticationTokenHasBeenSet() const { return m_authenticationTokenHasBeenSet; } /** *

Amazon WorkDocs authentication token. Not required when using Amazon Web * Services administrator credentials to access the API.

*/ inline void SetAuthenticationToken(const Aws::String& value) { m_authenticationTokenHasBeenSet = true; m_authenticationToken = value; } /** *

Amazon WorkDocs authentication token. Not required when using Amazon Web * Services administrator credentials to access the API.

*/ inline void SetAuthenticationToken(Aws::String&& value) { m_authenticationTokenHasBeenSet = true; m_authenticationToken = std::move(value); } /** *

Amazon WorkDocs authentication token. Not required when using Amazon Web * Services administrator credentials to access the API.

*/ inline void SetAuthenticationToken(const char* value) { m_authenticationTokenHasBeenSet = true; m_authenticationToken.assign(value); } /** *

Amazon WorkDocs authentication token. Not required when using Amazon Web * Services administrator credentials to access the API.

*/ inline DescribeGroupsRequest& WithAuthenticationToken(const Aws::String& value) { SetAuthenticationToken(value); return *this;} /** *

Amazon WorkDocs authentication token. Not required when using Amazon Web * Services administrator credentials to access the API.

*/ inline DescribeGroupsRequest& WithAuthenticationToken(Aws::String&& value) { SetAuthenticationToken(std::move(value)); return *this;} /** *

Amazon WorkDocs authentication token. Not required when using Amazon Web * Services administrator credentials to access the API.

*/ inline DescribeGroupsRequest& WithAuthenticationToken(const char* value) { SetAuthenticationToken(value); return *this;} /** *

A query to describe groups by group name.

*/ inline const Aws::String& GetSearchQuery() const{ return m_searchQuery; } /** *

A query to describe groups by group name.

*/ inline bool SearchQueryHasBeenSet() const { return m_searchQueryHasBeenSet; } /** *

A query to describe groups by group name.

*/ inline void SetSearchQuery(const Aws::String& value) { m_searchQueryHasBeenSet = true; m_searchQuery = value; } /** *

A query to describe groups by group name.

*/ inline void SetSearchQuery(Aws::String&& value) { m_searchQueryHasBeenSet = true; m_searchQuery = std::move(value); } /** *

A query to describe groups by group name.

*/ inline void SetSearchQuery(const char* value) { m_searchQueryHasBeenSet = true; m_searchQuery.assign(value); } /** *

A query to describe groups by group name.

*/ inline DescribeGroupsRequest& WithSearchQuery(const Aws::String& value) { SetSearchQuery(value); return *this;} /** *

A query to describe groups by group name.

*/ inline DescribeGroupsRequest& WithSearchQuery(Aws::String&& value) { SetSearchQuery(std::move(value)); return *this;} /** *

A query to describe groups by group name.

*/ inline DescribeGroupsRequest& WithSearchQuery(const char* value) { SetSearchQuery(value); return *this;} /** *

The ID of the organization.

*/ inline const Aws::String& GetOrganizationId() const{ return m_organizationId; } /** *

The ID of the organization.

*/ inline bool OrganizationIdHasBeenSet() const { return m_organizationIdHasBeenSet; } /** *

The ID of the organization.

*/ inline void SetOrganizationId(const Aws::String& value) { m_organizationIdHasBeenSet = true; m_organizationId = value; } /** *

The ID of the organization.

*/ inline void SetOrganizationId(Aws::String&& value) { m_organizationIdHasBeenSet = true; m_organizationId = std::move(value); } /** *

The ID of the organization.

*/ inline void SetOrganizationId(const char* value) { m_organizationIdHasBeenSet = true; m_organizationId.assign(value); } /** *

The ID of the organization.

*/ inline DescribeGroupsRequest& WithOrganizationId(const Aws::String& value) { SetOrganizationId(value); return *this;} /** *

The ID of the organization.

*/ inline DescribeGroupsRequest& WithOrganizationId(Aws::String&& value) { SetOrganizationId(std::move(value)); return *this;} /** *

The ID of the organization.

*/ inline DescribeGroupsRequest& WithOrganizationId(const char* value) { SetOrganizationId(value); return *this;} /** *

The marker for the next set of results. (You received this marker from a * previous call.)

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

The marker for the next set of results. (You received this marker from a * previous call.)

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

The marker for the next set of results. (You received this marker from a * previous call.)

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

The marker for the next set of results. (You received this marker from a * previous call.)

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

The marker for the next set of results. (You received this marker from a * previous call.)

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

The marker for the next set of results. (You received this marker from a * previous call.)

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

The marker for the next set of results. (You received this marker from a * previous call.)

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

The marker for the next set of results. (You received this marker from a * previous call.)

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

The maximum number of items to return with this call.

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

The maximum number of items to return with this call.

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

The maximum number of items to return with this call.

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

The maximum number of items to return with this call.

*/ inline DescribeGroupsRequest& WithLimit(int value) { SetLimit(value); return *this;} private: Aws::String m_authenticationToken; bool m_authenticationTokenHasBeenSet = false; Aws::String m_searchQuery; bool m_searchQueryHasBeenSet = false; Aws::String m_organizationId; bool m_organizationIdHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; int m_limit; bool m_limitHasBeenSet = false; }; } // namespace Model } // namespace WorkDocs } // namespace Aws