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/lightsail/Lightsail_EXPORTS.h> 8 #include <aws/lightsail/LightsailRequest.h> 9 #include <aws/core/utils/memory/stl/AWSString.h> 10 #include <utility> 11 12 namespace Aws 13 { 14 namespace Lightsail 15 { 16 namespace Model 17 { 18 19 /** 20 */ 21 class AWS_LIGHTSAIL_API GetBucketsRequest : public LightsailRequest 22 { 23 public: 24 GetBucketsRequest(); 25 26 // Service request name is the Operation name which will send this request out, 27 // each operation should has unique request name, so that we can get operation's name from this request. 28 // Note: this is not true for response, multiple operations may have the same response name, 29 // so we can not get operation's name from response. GetServiceRequestName()30 inline virtual const char* GetServiceRequestName() const override { return "GetBuckets"; } 31 32 Aws::String SerializePayload() const override; 33 34 Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; 35 36 37 /** 38 * <p>The name of the bucket for which to return information.</p> <p>When omitted, 39 * the response includes all of your buckets in the AWS Region where the request is 40 * made.</p> 41 */ GetBucketName()42 inline const Aws::String& GetBucketName() const{ return m_bucketName; } 43 44 /** 45 * <p>The name of the bucket for which to return information.</p> <p>When omitted, 46 * the response includes all of your buckets in the AWS Region where the request is 47 * made.</p> 48 */ BucketNameHasBeenSet()49 inline bool BucketNameHasBeenSet() const { return m_bucketNameHasBeenSet; } 50 51 /** 52 * <p>The name of the bucket for which to return information.</p> <p>When omitted, 53 * the response includes all of your buckets in the AWS Region where the request is 54 * made.</p> 55 */ SetBucketName(const Aws::String & value)56 inline void SetBucketName(const Aws::String& value) { m_bucketNameHasBeenSet = true; m_bucketName = value; } 57 58 /** 59 * <p>The name of the bucket for which to return information.</p> <p>When omitted, 60 * the response includes all of your buckets in the AWS Region where the request is 61 * made.</p> 62 */ SetBucketName(Aws::String && value)63 inline void SetBucketName(Aws::String&& value) { m_bucketNameHasBeenSet = true; m_bucketName = std::move(value); } 64 65 /** 66 * <p>The name of the bucket for which to return information.</p> <p>When omitted, 67 * the response includes all of your buckets in the AWS Region where the request is 68 * made.</p> 69 */ SetBucketName(const char * value)70 inline void SetBucketName(const char* value) { m_bucketNameHasBeenSet = true; m_bucketName.assign(value); } 71 72 /** 73 * <p>The name of the bucket for which to return information.</p> <p>When omitted, 74 * the response includes all of your buckets in the AWS Region where the request is 75 * made.</p> 76 */ WithBucketName(const Aws::String & value)77 inline GetBucketsRequest& WithBucketName(const Aws::String& value) { SetBucketName(value); return *this;} 78 79 /** 80 * <p>The name of the bucket for which to return information.</p> <p>When omitted, 81 * the response includes all of your buckets in the AWS Region where the request is 82 * made.</p> 83 */ WithBucketName(Aws::String && value)84 inline GetBucketsRequest& WithBucketName(Aws::String&& value) { SetBucketName(std::move(value)); return *this;} 85 86 /** 87 * <p>The name of the bucket for which to return information.</p> <p>When omitted, 88 * the response includes all of your buckets in the AWS Region where the request is 89 * made.</p> 90 */ WithBucketName(const char * value)91 inline GetBucketsRequest& WithBucketName(const char* value) { SetBucketName(value); return *this;} 92 93 94 /** 95 * <p>The token to advance to the next page of results from your request.</p> <p>To 96 * get a page token, perform an initial <code>GetBuckets</code> request. If your 97 * results are paginated, the response will return a next page token that you can 98 * specify as the page token in a subsequent request.</p> 99 */ GetPageToken()100 inline const Aws::String& GetPageToken() const{ return m_pageToken; } 101 102 /** 103 * <p>The token to advance to the next page of results from your request.</p> <p>To 104 * get a page token, perform an initial <code>GetBuckets</code> request. If your 105 * results are paginated, the response will return a next page token that you can 106 * specify as the page token in a subsequent request.</p> 107 */ PageTokenHasBeenSet()108 inline bool PageTokenHasBeenSet() const { return m_pageTokenHasBeenSet; } 109 110 /** 111 * <p>The token to advance to the next page of results from your request.</p> <p>To 112 * get a page token, perform an initial <code>GetBuckets</code> request. If your 113 * results are paginated, the response will return a next page token that you can 114 * specify as the page token in a subsequent request.</p> 115 */ SetPageToken(const Aws::String & value)116 inline void SetPageToken(const Aws::String& value) { m_pageTokenHasBeenSet = true; m_pageToken = value; } 117 118 /** 119 * <p>The token to advance to the next page of results from your request.</p> <p>To 120 * get a page token, perform an initial <code>GetBuckets</code> request. If your 121 * results are paginated, the response will return a next page token that you can 122 * specify as the page token in a subsequent request.</p> 123 */ SetPageToken(Aws::String && value)124 inline void SetPageToken(Aws::String&& value) { m_pageTokenHasBeenSet = true; m_pageToken = std::move(value); } 125 126 /** 127 * <p>The token to advance to the next page of results from your request.</p> <p>To 128 * get a page token, perform an initial <code>GetBuckets</code> request. If your 129 * results are paginated, the response will return a next page token that you can 130 * specify as the page token in a subsequent request.</p> 131 */ SetPageToken(const char * value)132 inline void SetPageToken(const char* value) { m_pageTokenHasBeenSet = true; m_pageToken.assign(value); } 133 134 /** 135 * <p>The token to advance to the next page of results from your request.</p> <p>To 136 * get a page token, perform an initial <code>GetBuckets</code> request. If your 137 * results are paginated, the response will return a next page token that you can 138 * specify as the page token in a subsequent request.</p> 139 */ WithPageToken(const Aws::String & value)140 inline GetBucketsRequest& WithPageToken(const Aws::String& value) { SetPageToken(value); return *this;} 141 142 /** 143 * <p>The token to advance to the next page of results from your request.</p> <p>To 144 * get a page token, perform an initial <code>GetBuckets</code> request. If your 145 * results are paginated, the response will return a next page token that you can 146 * specify as the page token in a subsequent request.</p> 147 */ WithPageToken(Aws::String && value)148 inline GetBucketsRequest& WithPageToken(Aws::String&& value) { SetPageToken(std::move(value)); return *this;} 149 150 /** 151 * <p>The token to advance to the next page of results from your request.</p> <p>To 152 * get a page token, perform an initial <code>GetBuckets</code> request. If your 153 * results are paginated, the response will return a next page token that you can 154 * specify as the page token in a subsequent request.</p> 155 */ WithPageToken(const char * value)156 inline GetBucketsRequest& WithPageToken(const char* value) { SetPageToken(value); return *this;} 157 158 159 /** 160 * <p>A Boolean value that indicates whether to include Lightsail instances that 161 * were given access to the bucket using the <a>SetResourceAccessForBucket</a> 162 * action.</p> 163 */ GetIncludeConnectedResources()164 inline bool GetIncludeConnectedResources() const{ return m_includeConnectedResources; } 165 166 /** 167 * <p>A Boolean value that indicates whether to include Lightsail instances that 168 * were given access to the bucket using the <a>SetResourceAccessForBucket</a> 169 * action.</p> 170 */ IncludeConnectedResourcesHasBeenSet()171 inline bool IncludeConnectedResourcesHasBeenSet() const { return m_includeConnectedResourcesHasBeenSet; } 172 173 /** 174 * <p>A Boolean value that indicates whether to include Lightsail instances that 175 * were given access to the bucket using the <a>SetResourceAccessForBucket</a> 176 * action.</p> 177 */ SetIncludeConnectedResources(bool value)178 inline void SetIncludeConnectedResources(bool value) { m_includeConnectedResourcesHasBeenSet = true; m_includeConnectedResources = value; } 179 180 /** 181 * <p>A Boolean value that indicates whether to include Lightsail instances that 182 * were given access to the bucket using the <a>SetResourceAccessForBucket</a> 183 * action.</p> 184 */ WithIncludeConnectedResources(bool value)185 inline GetBucketsRequest& WithIncludeConnectedResources(bool value) { SetIncludeConnectedResources(value); return *this;} 186 187 private: 188 189 Aws::String m_bucketName; 190 bool m_bucketNameHasBeenSet; 191 192 Aws::String m_pageToken; 193 bool m_pageTokenHasBeenSet; 194 195 bool m_includeConnectedResources; 196 bool m_includeConnectedResourcesHasBeenSet; 197 }; 198 199 } // namespace Model 200 } // namespace Lightsail 201 } // namespace Aws 202