1 /** 2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 * SPDX-License-Identifier: Apache-2.0. 4 */ 5 6 #pragma once 7 #include <aws/workspaces/WorkSpaces_EXPORTS.h> 8 #include <aws/workspaces/WorkSpacesRequest.h> 9 #include <aws/core/utils/memory/stl/AWSVector.h> 10 #include <aws/workspaces/model/ImageType.h> 11 #include <aws/core/utils/memory/stl/AWSString.h> 12 #include <utility> 13 14 namespace Aws 15 { 16 namespace WorkSpaces 17 { 18 namespace Model 19 { 20 21 /** 22 */ 23 class AWS_WORKSPACES_API DescribeWorkspaceImagesRequest : public WorkSpacesRequest 24 { 25 public: 26 DescribeWorkspaceImagesRequest(); 27 28 // Service request name is the Operation name which will send this request out, 29 // each operation should has unique request name, so that we can get operation's name from this request. 30 // Note: this is not true for response, multiple operations may have the same response name, 31 // so we can not get operation's name from response. GetServiceRequestName()32 inline virtual const char* GetServiceRequestName() const override { return "DescribeWorkspaceImages"; } 33 34 Aws::String SerializePayload() const override; 35 36 Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; 37 38 39 /** 40 * <p>The identifier of the image.</p> 41 */ GetImageIds()42 inline const Aws::Vector<Aws::String>& GetImageIds() const{ return m_imageIds; } 43 44 /** 45 * <p>The identifier of the image.</p> 46 */ ImageIdsHasBeenSet()47 inline bool ImageIdsHasBeenSet() const { return m_imageIdsHasBeenSet; } 48 49 /** 50 * <p>The identifier of the image.</p> 51 */ SetImageIds(const Aws::Vector<Aws::String> & value)52 inline void SetImageIds(const Aws::Vector<Aws::String>& value) { m_imageIdsHasBeenSet = true; m_imageIds = value; } 53 54 /** 55 * <p>The identifier of the image.</p> 56 */ SetImageIds(Aws::Vector<Aws::String> && value)57 inline void SetImageIds(Aws::Vector<Aws::String>&& value) { m_imageIdsHasBeenSet = true; m_imageIds = std::move(value); } 58 59 /** 60 * <p>The identifier of the image.</p> 61 */ WithImageIds(const Aws::Vector<Aws::String> & value)62 inline DescribeWorkspaceImagesRequest& WithImageIds(const Aws::Vector<Aws::String>& value) { SetImageIds(value); return *this;} 63 64 /** 65 * <p>The identifier of the image.</p> 66 */ WithImageIds(Aws::Vector<Aws::String> && value)67 inline DescribeWorkspaceImagesRequest& WithImageIds(Aws::Vector<Aws::String>&& value) { SetImageIds(std::move(value)); return *this;} 68 69 /** 70 * <p>The identifier of the image.</p> 71 */ AddImageIds(const Aws::String & value)72 inline DescribeWorkspaceImagesRequest& AddImageIds(const Aws::String& value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(value); return *this; } 73 74 /** 75 * <p>The identifier of the image.</p> 76 */ AddImageIds(Aws::String && value)77 inline DescribeWorkspaceImagesRequest& AddImageIds(Aws::String&& value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(std::move(value)); return *this; } 78 79 /** 80 * <p>The identifier of the image.</p> 81 */ AddImageIds(const char * value)82 inline DescribeWorkspaceImagesRequest& AddImageIds(const char* value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(value); return *this; } 83 84 85 /** 86 * <p>The type (owned or shared) of the image.</p> 87 */ GetImageType()88 inline const ImageType& GetImageType() const{ return m_imageType; } 89 90 /** 91 * <p>The type (owned or shared) of the image.</p> 92 */ ImageTypeHasBeenSet()93 inline bool ImageTypeHasBeenSet() const { return m_imageTypeHasBeenSet; } 94 95 /** 96 * <p>The type (owned or shared) of the image.</p> 97 */ SetImageType(const ImageType & value)98 inline void SetImageType(const ImageType& value) { m_imageTypeHasBeenSet = true; m_imageType = value; } 99 100 /** 101 * <p>The type (owned or shared) of the image.</p> 102 */ SetImageType(ImageType && value)103 inline void SetImageType(ImageType&& value) { m_imageTypeHasBeenSet = true; m_imageType = std::move(value); } 104 105 /** 106 * <p>The type (owned or shared) of the image.</p> 107 */ WithImageType(const ImageType & value)108 inline DescribeWorkspaceImagesRequest& WithImageType(const ImageType& value) { SetImageType(value); return *this;} 109 110 /** 111 * <p>The type (owned or shared) of the image.</p> 112 */ WithImageType(ImageType && value)113 inline DescribeWorkspaceImagesRequest& WithImageType(ImageType&& value) { SetImageType(std::move(value)); return *this;} 114 115 116 /** 117 * <p>If you received a <code>NextToken</code> from a previous call that was 118 * paginated, provide this token to receive the next set of results.</p> 119 */ GetNextToken()120 inline const Aws::String& GetNextToken() const{ return m_nextToken; } 121 122 /** 123 * <p>If you received a <code>NextToken</code> from a previous call that was 124 * paginated, provide this token to receive the next set of results.</p> 125 */ NextTokenHasBeenSet()126 inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } 127 128 /** 129 * <p>If you received a <code>NextToken</code> from a previous call that was 130 * paginated, provide this token to receive the next set of results.</p> 131 */ SetNextToken(const Aws::String & value)132 inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } 133 134 /** 135 * <p>If you received a <code>NextToken</code> from a previous call that was 136 * paginated, provide this token to receive the next set of results.</p> 137 */ SetNextToken(Aws::String && value)138 inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } 139 140 /** 141 * <p>If you received a <code>NextToken</code> from a previous call that was 142 * paginated, provide this token to receive the next set of results.</p> 143 */ SetNextToken(const char * value)144 inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } 145 146 /** 147 * <p>If you received a <code>NextToken</code> from a previous call that was 148 * paginated, provide this token to receive the next set of results.</p> 149 */ WithNextToken(const Aws::String & value)150 inline DescribeWorkspaceImagesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} 151 152 /** 153 * <p>If you received a <code>NextToken</code> from a previous call that was 154 * paginated, provide this token to receive the next set of results.</p> 155 */ WithNextToken(Aws::String && value)156 inline DescribeWorkspaceImagesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} 157 158 /** 159 * <p>If you received a <code>NextToken</code> from a previous call that was 160 * paginated, provide this token to receive the next set of results.</p> 161 */ WithNextToken(const char * value)162 inline DescribeWorkspaceImagesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} 163 164 165 /** 166 * <p>The maximum number of items to return.</p> 167 */ GetMaxResults()168 inline int GetMaxResults() const{ return m_maxResults; } 169 170 /** 171 * <p>The maximum number of items to return.</p> 172 */ MaxResultsHasBeenSet()173 inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } 174 175 /** 176 * <p>The maximum number of items to return.</p> 177 */ SetMaxResults(int value)178 inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } 179 180 /** 181 * <p>The maximum number of items to return.</p> 182 */ WithMaxResults(int value)183 inline DescribeWorkspaceImagesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} 184 185 private: 186 187 Aws::Vector<Aws::String> m_imageIds; 188 bool m_imageIdsHasBeenSet; 189 190 ImageType m_imageType; 191 bool m_imageTypeHasBeenSet; 192 193 Aws::String m_nextToken; 194 bool m_nextTokenHasBeenSet; 195 196 int m_maxResults; 197 bool m_maxResultsHasBeenSet; 198 }; 199 200 } // namespace Model 201 } // namespace WorkSpaces 202 } // namespace Aws 203