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="baremetalsolution_v1alpha1.html">Bare Metal Solution API</a> . <a href="baremetalsolution_v1alpha1.projects.html">projects</a> . <a href="baremetalsolution_v1alpha1.projects.locations.html">locations</a> . <a href="baremetalsolution_v1alpha1.projects.locations.volumes.html">volumes</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="baremetalsolution_v1alpha1.projects.locations.volumes.snapshots.html">snapshots()</a></code> 79</p> 80<p class="firstline">Returns the snapshots Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 87<p class="firstline">Get details for a specific named Volume.</p> 88<p class="toc_element"> 89 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 90<p class="firstline">List the volumes for the specified project</p> 91<p class="toc_element"> 92 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 93<p class="firstline">Retrieves the next page of results.</p> 94<p class="toc_element"> 95 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Update certain parameters on a Volume.</p> 97<p class="toc_element"> 98 <code><a href="#setVolumeSnapshotSchedulePolicy">setVolumeSnapshotSchedulePolicy(volume, body=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Sets the specified snapshot schedule policy on the specified volume.</p> 100<h3>Method Details</h3> 101<div class="method"> 102 <code class="details" id="close">close()</code> 103 <pre>Close httplib2 connections.</pre> 104</div> 105 106<div class="method"> 107 <code class="details" id="get">get(name, x__xgafv=None)</code> 108 <pre>Get details for a specific named Volume. 109 110Args: 111 name: string, Required. The name of the Volume to retrieve. (required) 112 x__xgafv: string, V1 error format. 113 Allowed values 114 1 - v1 error format 115 2 - v2 error format 116 117Returns: 118 An object of the form: 119 120 { # Volume registered in the project. 121 "autoGrownSizeGb": "A String", # The size, in GB, that this Volume has expanded as a result of an auto grow policy. 122 "currentSizeGb": "A String", # The current size of this Volume, in GB, including space reserved for snapshots. This size may be different than the requested size if the Volume has been configured with auto grow or auto shrink. 123 "name": "A String", # Output only. The name of this Volume. 124 "remainingSpaceGb": "A String", # The space remaining in the Volume for new LUNs, in GB, excluding space reserved for snapshots. 125 "requestedSizeGb": "A String", # The requested size of this Volume, in GB. 126 "snapshotReservedSpacePercent": 42, # The percent of space on this Volume reserved for snapshots. 127 "snapshotReservedSpaceRemainingGb": "A String", # The amount, in GB, of space available in this Volume's reserved snapshot space. 128 "snapshotReservedSpaceUsedPercent": 42, # The percent of reserved snapshot space on this Volume that is actually used by snapshot copies. This may be higher than 100% if snapshot copies are occupying more space than has been reserved on the Volume. 129 "state": "A String", # The state of this Volume. 130 "type": "A String", # The type of this Volume. 131}</pre> 132</div> 133 134<div class="method"> 135 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 136 <pre>List the volumes for the specified project 137 138Args: 139 parent: string, Required. The location to list Volumes in. (required) 140 pageSize: integer, The maximum number of items to return. 141 pageToken: string, The next_page_token value returned from a previous List request, if any. 142 x__xgafv: string, V1 error format. 143 Allowed values 144 1 - v1 error format 145 2 - v2 error format 146 147Returns: 148 An object of the form: 149 150 { # Response for ListVolumes. 151 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 152 "volumes": [ # The volumes registered in this project. 153 { # Volume registered in the project. 154 "autoGrownSizeGb": "A String", # The size, in GB, that this Volume has expanded as a result of an auto grow policy. 155 "currentSizeGb": "A String", # The current size of this Volume, in GB, including space reserved for snapshots. This size may be different than the requested size if the Volume has been configured with auto grow or auto shrink. 156 "name": "A String", # Output only. The name of this Volume. 157 "remainingSpaceGb": "A String", # The space remaining in the Volume for new LUNs, in GB, excluding space reserved for snapshots. 158 "requestedSizeGb": "A String", # The requested size of this Volume, in GB. 159 "snapshotReservedSpacePercent": 42, # The percent of space on this Volume reserved for snapshots. 160 "snapshotReservedSpaceRemainingGb": "A String", # The amount, in GB, of space available in this Volume's reserved snapshot space. 161 "snapshotReservedSpaceUsedPercent": 42, # The percent of reserved snapshot space on this Volume that is actually used by snapshot copies. This may be higher than 100% if snapshot copies are occupying more space than has been reserved on the Volume. 162 "state": "A String", # The state of this Volume. 163 "type": "A String", # The type of this Volume. 164 }, 165 ], 166}</pre> 167</div> 168 169<div class="method"> 170 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 171 <pre>Retrieves the next page of results. 172 173Args: 174 previous_request: The request for the previous page. (required) 175 previous_response: The response from the request for the previous page. (required) 176 177Returns: 178 A request object that you can call 'execute()' on to request the next 179 page. Returns None if there are no more items in the collection. 180 </pre> 181</div> 182 183<div class="method"> 184 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 185 <pre>Update certain parameters on a Volume. 186 187Args: 188 name: string, Output only. The name of this Volume. (required) 189 body: object, The request body. 190 The object takes the form of: 191 192{ # Volume registered in the project. 193 "autoGrownSizeGb": "A String", # The size, in GB, that this Volume has expanded as a result of an auto grow policy. 194 "currentSizeGb": "A String", # The current size of this Volume, in GB, including space reserved for snapshots. This size may be different than the requested size if the Volume has been configured with auto grow or auto shrink. 195 "name": "A String", # Output only. The name of this Volume. 196 "remainingSpaceGb": "A String", # The space remaining in the Volume for new LUNs, in GB, excluding space reserved for snapshots. 197 "requestedSizeGb": "A String", # The requested size of this Volume, in GB. 198 "snapshotReservedSpacePercent": 42, # The percent of space on this Volume reserved for snapshots. 199 "snapshotReservedSpaceRemainingGb": "A String", # The amount, in GB, of space available in this Volume's reserved snapshot space. 200 "snapshotReservedSpaceUsedPercent": 42, # The percent of reserved snapshot space on this Volume that is actually used by snapshot copies. This may be higher than 100% if snapshot copies are occupying more space than has been reserved on the Volume. 201 "state": "A String", # The state of this Volume. 202 "type": "A String", # The type of this Volume. 203} 204 205 updateMask: string, The list of fields to update. The only currently supported field is `snapshot_reserved_space_percent`. 206 x__xgafv: string, V1 error format. 207 Allowed values 208 1 - v1 error format 209 2 - v2 error format 210 211Returns: 212 An object of the form: 213 214 { # Volume registered in the project. 215 "autoGrownSizeGb": "A String", # The size, in GB, that this Volume has expanded as a result of an auto grow policy. 216 "currentSizeGb": "A String", # The current size of this Volume, in GB, including space reserved for snapshots. This size may be different than the requested size if the Volume has been configured with auto grow or auto shrink. 217 "name": "A String", # Output only. The name of this Volume. 218 "remainingSpaceGb": "A String", # The space remaining in the Volume for new LUNs, in GB, excluding space reserved for snapshots. 219 "requestedSizeGb": "A String", # The requested size of this Volume, in GB. 220 "snapshotReservedSpacePercent": 42, # The percent of space on this Volume reserved for snapshots. 221 "snapshotReservedSpaceRemainingGb": "A String", # The amount, in GB, of space available in this Volume's reserved snapshot space. 222 "snapshotReservedSpaceUsedPercent": 42, # The percent of reserved snapshot space on this Volume that is actually used by snapshot copies. This may be higher than 100% if snapshot copies are occupying more space than has been reserved on the Volume. 223 "state": "A String", # The state of this Volume. 224 "type": "A String", # The type of this Volume. 225}</pre> 226</div> 227 228<div class="method"> 229 <code class="details" id="setVolumeSnapshotSchedulePolicy">setVolumeSnapshotSchedulePolicy(volume, body=None, x__xgafv=None)</code> 230 <pre>Sets the specified snapshot schedule policy on the specified volume. 231 232Args: 233 volume: string, Required. Name of the volume to set snapshot schedule policy on. (required) 234 body: object, The request body. 235 The object takes the form of: 236 237{ # Request for SetVolumeSnapshotSchedulePolicy. 238 "snapshotSchedulePolicy": "A String", # Required. The name of the policy to set on the volume. 239} 240 241 x__xgafv: string, V1 error format. 242 Allowed values 243 1 - v1 error format 244 2 - v2 error format 245 246Returns: 247 An object of the form: 248 249 { # Response for SetVolumeSnapshotSchedulePolicy. 250}</pre> 251</div> 252 253</body></html>