/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace imagebuilder { namespace Model { /** */ class ListImagesRequest : public ImagebuilderRequest { public: AWS_IMAGEBUILDER_API ListImagesRequest(); // 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 "ListImages"; } AWS_IMAGEBUILDER_API Aws::String SerializePayload() const override; /** *

The owner defines which images you want to list. By default, this request * will only show images owned by your account. You can use this field to specify * if you want to view images owned by yourself, by Amazon, or those images that * have been shared with you by other customers.

*/ inline const Ownership& GetOwner() const{ return m_owner; } /** *

The owner defines which images you want to list. By default, this request * will only show images owned by your account. You can use this field to specify * if you want to view images owned by yourself, by Amazon, or those images that * have been shared with you by other customers.

*/ inline bool OwnerHasBeenSet() const { return m_ownerHasBeenSet; } /** *

The owner defines which images you want to list. By default, this request * will only show images owned by your account. You can use this field to specify * if you want to view images owned by yourself, by Amazon, or those images that * have been shared with you by other customers.

*/ inline void SetOwner(const Ownership& value) { m_ownerHasBeenSet = true; m_owner = value; } /** *

The owner defines which images you want to list. By default, this request * will only show images owned by your account. You can use this field to specify * if you want to view images owned by yourself, by Amazon, or those images that * have been shared with you by other customers.

*/ inline void SetOwner(Ownership&& value) { m_ownerHasBeenSet = true; m_owner = std::move(value); } /** *

The owner defines which images you want to list. By default, this request * will only show images owned by your account. You can use this field to specify * if you want to view images owned by yourself, by Amazon, or those images that * have been shared with you by other customers.

*/ inline ListImagesRequest& WithOwner(const Ownership& value) { SetOwner(value); return *this;} /** *

The owner defines which images you want to list. By default, this request * will only show images owned by your account. You can use this field to specify * if you want to view images owned by yourself, by Amazon, or those images that * have been shared with you by other customers.

*/ inline ListImagesRequest& WithOwner(Ownership&& value) { SetOwner(std::move(value)); return *this;} /** *

Use the following filters to streamline results:

  • * name

  • osVersion

  • * platform

  • type

  • * version

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

Use the following filters to streamline results:

  • * name

  • osVersion

  • * platform

  • type

  • * version

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

Use the following filters to streamline results:

  • * name

  • osVersion

  • * platform

  • type

  • * version

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

Use the following filters to streamline results:

  • * name

  • osVersion

  • * platform

  • type

  • * version

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

Use the following filters to streamline results:

  • * name

  • osVersion

  • * platform

  • type

  • * version

*/ inline ListImagesRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

Use the following filters to streamline results:

  • * name

  • osVersion

  • * platform

  • type

  • * version

*/ inline ListImagesRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

Use the following filters to streamline results:

  • * name

  • osVersion

  • * platform

  • type

  • * version

*/ inline ListImagesRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

Use the following filters to streamline results:

  • * name

  • osVersion

  • * platform

  • type

  • * version

*/ inline ListImagesRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** *

Requests a list of images with a specific recipe name.

*/ inline bool GetByName() const{ return m_byName; } /** *

Requests a list of images with a specific recipe name.

*/ inline bool ByNameHasBeenSet() const { return m_byNameHasBeenSet; } /** *

Requests a list of images with a specific recipe name.

*/ inline void SetByName(bool value) { m_byNameHasBeenSet = true; m_byName = value; } /** *

Requests a list of images with a specific recipe name.

*/ inline ListImagesRequest& WithByName(bool value) { SetByName(value); return *this;} /** *

The maximum items to return in a request.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum items to return in a request.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum items to return in a request.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum items to return in a request.

*/ inline ListImagesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

A token to specify where to start paginating. This is the NextToken from a * previously truncated response.

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

A token to specify where to start paginating. This is the NextToken from a * previously truncated response.

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

A token to specify where to start paginating. This is the NextToken from a * previously truncated response.

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

A token to specify where to start paginating. This is the NextToken from a * previously truncated response.

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

A token to specify where to start paginating. This is the NextToken from a * previously truncated response.

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

A token to specify where to start paginating. This is the NextToken from a * previously truncated response.

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

A token to specify where to start paginating. This is the NextToken from a * previously truncated response.

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

A token to specify where to start paginating. This is the NextToken from a * previously truncated response.

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

Includes deprecated images in the response list.

*/ inline bool GetIncludeDeprecated() const{ return m_includeDeprecated; } /** *

Includes deprecated images in the response list.

*/ inline bool IncludeDeprecatedHasBeenSet() const { return m_includeDeprecatedHasBeenSet; } /** *

Includes deprecated images in the response list.

*/ inline void SetIncludeDeprecated(bool value) { m_includeDeprecatedHasBeenSet = true; m_includeDeprecated = value; } /** *

Includes deprecated images in the response list.

*/ inline ListImagesRequest& WithIncludeDeprecated(bool value) { SetIncludeDeprecated(value); return *this;} private: Ownership m_owner; bool m_ownerHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; bool m_byName; bool m_byNameHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; bool m_includeDeprecated; bool m_includeDeprecatedHasBeenSet = false; }; } // namespace Model } // namespace imagebuilder } // namespace Aws