1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="storagetransfer_v1.html">Storage Transfer API</a> . <a href="storagetransfer_v1.projects.html">projects</a> . <a href="storagetransfer_v1.projects.agentPools.html">agentPools</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(projectId, agentPoolId=None, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates an agent pool resource.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes an agent pool.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets an agent pool.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(projectId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists agent pools.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates an existing agent pool resource.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(projectId, agentPoolId=None, body=None, x__xgafv=None)</code> 106 <pre>Creates an agent pool resource. 107 108Args: 109 projectId: string, Required. The ID of the Google Cloud project that owns the agent pool. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # Represents an On-Premises Agent pool. 114 "bandwidthLimit": { # Specifies a bandwidth limit for an agent pool. # Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'. 115 "limitMbps": "A String", # Bandwidth rate in megabytes per second, distributed across all the agents in the pool. 116 }, 117 "displayName": "A String", # Specifies the client-specified AgentPool description. 118 "name": "A String", # Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` 119 "state": "A String", # Output only. Specifies the state of the AgentPool. 120} 121 122 agentPoolId: string, Required. The ID of the agent pool to create. The `agent_pool_id` must meet the following requirements: * Length of 128 characters or less. * Not start with the string `goog`. * Start with a lowercase ASCII character, followed by: * Zero or more: lowercase Latin alphabet characters, numerals, hyphens (`-`), periods (`.`), underscores (`_`), or tildes (`~`). * One or more numerals or lowercase ASCII characters. As expressed by the regular expression: `^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$`. 123 x__xgafv: string, V1 error format. 124 Allowed values 125 1 - v1 error format 126 2 - v2 error format 127 128Returns: 129 An object of the form: 130 131 { # Represents an On-Premises Agent pool. 132 "bandwidthLimit": { # Specifies a bandwidth limit for an agent pool. # Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'. 133 "limitMbps": "A String", # Bandwidth rate in megabytes per second, distributed across all the agents in the pool. 134 }, 135 "displayName": "A String", # Specifies the client-specified AgentPool description. 136 "name": "A String", # Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` 137 "state": "A String", # Output only. Specifies the state of the AgentPool. 138}</pre> 139</div> 140 141<div class="method"> 142 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 143 <pre>Deletes an agent pool. 144 145Args: 146 name: string, Required. The name of the agent pool to delete. (required) 147 x__xgafv: string, V1 error format. 148 Allowed values 149 1 - v1 error format 150 2 - v2 error format 151 152Returns: 153 An object of the form: 154 155 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 156}</pre> 157</div> 158 159<div class="method"> 160 <code class="details" id="get">get(name, x__xgafv=None)</code> 161 <pre>Gets an agent pool. 162 163Args: 164 name: string, Required. The name of the agent pool to get. (required) 165 x__xgafv: string, V1 error format. 166 Allowed values 167 1 - v1 error format 168 2 - v2 error format 169 170Returns: 171 An object of the form: 172 173 { # Represents an On-Premises Agent pool. 174 "bandwidthLimit": { # Specifies a bandwidth limit for an agent pool. # Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'. 175 "limitMbps": "A String", # Bandwidth rate in megabytes per second, distributed across all the agents in the pool. 176 }, 177 "displayName": "A String", # Specifies the client-specified AgentPool description. 178 "name": "A String", # Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` 179 "state": "A String", # Output only. Specifies the state of the AgentPool. 180}</pre> 181</div> 182 183<div class="method"> 184 <code class="details" id="list">list(projectId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 185 <pre>Lists agent pools. 186 187Args: 188 projectId: string, Required. The ID of the Google Cloud project that owns the job. (required) 189 filter: string, An optional list of query parameters specified as JSON text in the form of: `{"agentPoolNames":["agentpool1","agentpool2",...]}` Since `agentPoolNames` support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project. 190 pageSize: integer, The list page size. The max allowed value is `256`. 191 pageToken: string, The list page token. 192 x__xgafv: string, V1 error format. 193 Allowed values 194 1 - v1 error format 195 2 - v2 error format 196 197Returns: 198 An object of the form: 199 200 { # Response from ListAgentPools. 201 "agentPools": [ # A list of agent pools. 202 { # Represents an On-Premises Agent pool. 203 "bandwidthLimit": { # Specifies a bandwidth limit for an agent pool. # Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'. 204 "limitMbps": "A String", # Bandwidth rate in megabytes per second, distributed across all the agents in the pool. 205 }, 206 "displayName": "A String", # Specifies the client-specified AgentPool description. 207 "name": "A String", # Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` 208 "state": "A String", # Output only. Specifies the state of the AgentPool. 209 }, 210 ], 211 "nextPageToken": "A String", # The list next page token. 212}</pre> 213</div> 214 215<div class="method"> 216 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 217 <pre>Retrieves the next page of results. 218 219Args: 220 previous_request: The request for the previous page. (required) 221 previous_response: The response from the request for the previous page. (required) 222 223Returns: 224 A request object that you can call 'execute()' on to request the next 225 page. Returns None if there are no more items in the collection. 226 </pre> 227</div> 228 229<div class="method"> 230 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 231 <pre>Updates an existing agent pool resource. 232 233Args: 234 name: string, Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` (required) 235 body: object, The request body. 236 The object takes the form of: 237 238{ # Represents an On-Premises Agent pool. 239 "bandwidthLimit": { # Specifies a bandwidth limit for an agent pool. # Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'. 240 "limitMbps": "A String", # Bandwidth rate in megabytes per second, distributed across all the agents in the pool. 241 }, 242 "displayName": "A String", # Specifies the client-specified AgentPool description. 243 "name": "A String", # Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` 244 "state": "A String", # Output only. Specifies the state of the AgentPool. 245} 246 247 updateMask: string, The [field mask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) of the fields in `agentPool` to update in this request. The following `agentPool` fields can be updated: * display_name * bandwidth_limit 248 x__xgafv: string, V1 error format. 249 Allowed values 250 1 - v1 error format 251 2 - v2 error format 252 253Returns: 254 An object of the form: 255 256 { # Represents an On-Premises Agent pool. 257 "bandwidthLimit": { # Specifies a bandwidth limit for an agent pool. # Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'. 258 "limitMbps": "A String", # Bandwidth rate in megabytes per second, distributed across all the agents in the pool. 259 }, 260 "displayName": "A String", # Specifies the client-specified AgentPool description. 261 "name": "A String", # Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` 262 "state": "A String", # Output only. Specifies the state of the AgentPool. 263}</pre> 264</div> 265 266</body></html>