| yoshi-code-bot | a933dad | 2021-07-06 00:26:24 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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.snapshotSchedulePolicies.html">snapshotSchedulePolicies</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(parent, body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Create a SnapshotSchedulePolicy.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Delete removes named snapshot schedule policy</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Get details for a specific snapshot schedule policy</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">List the snapshot schedule policies for the specified project</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">Update a SnapshotSchedulePolicy.</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(parent, body=None, x__xgafv=None)</code> |
| 106 | <pre>Create a SnapshotSchedulePolicy. |
| 107 | |
| 108 | Args: |
| 109 | parent: string, Required. The parent project containing the SnapshotSchedulePolicy. (required) |
| 110 | body: object, The request body. |
| 111 | The object takes the form of: |
| 112 | |
| 113 | { # A snapshot schedule policy. |
| 114 | "description": "A String", # The description of this SnapshotSchedulePolicy. |
| 115 | "name": "A String", # Output only. The name of this SnapshotSchedulePolicy. |
| 116 | "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified. |
| 117 | { # A snapshot schedule. |
| 118 | "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots. |
| 119 | "prefix": "A String", # A string to prefix names of snapshots created under this Schedule. |
| 120 | "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule. |
| 121 | }, |
| 122 | ], |
| 123 | "volumes": [ # The names of the Volumes this policy is associated with. |
| 124 | "A String", |
| 125 | ], |
| 126 | } |
| 127 | |
| 128 | x__xgafv: string, V1 error format. |
| 129 | Allowed values |
| 130 | 1 - v1 error format |
| 131 | 2 - v2 error format |
| 132 | |
| 133 | Returns: |
| 134 | An object of the form: |
| 135 | |
| 136 | { # A snapshot schedule policy. |
| 137 | "description": "A String", # The description of this SnapshotSchedulePolicy. |
| 138 | "name": "A String", # Output only. The name of this SnapshotSchedulePolicy. |
| 139 | "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified. |
| 140 | { # A snapshot schedule. |
| 141 | "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots. |
| 142 | "prefix": "A String", # A string to prefix names of snapshots created under this Schedule. |
| 143 | "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule. |
| 144 | }, |
| 145 | ], |
| 146 | "volumes": [ # The names of the Volumes this policy is associated with. |
| 147 | "A String", |
| 148 | ], |
| 149 | }</pre> |
| 150 | </div> |
| 151 | |
| 152 | <div class="method"> |
| 153 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 154 | <pre>Delete removes named snapshot schedule policy |
| 155 | |
| 156 | Args: |
| 157 | name: string, Required. The name of the snapshot to delete. (required) |
| 158 | x__xgafv: string, V1 error format. |
| 159 | Allowed values |
| 160 | 1 - v1 error format |
| 161 | 2 - v2 error format |
| 162 | |
| 163 | Returns: |
| 164 | An object of the form: |
| 165 | |
| 166 | { # 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 `{}`. |
| 167 | }</pre> |
| 168 | </div> |
| 169 | |
| 170 | <div class="method"> |
| 171 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 172 | <pre>Get details for a specific snapshot schedule policy |
| 173 | |
| 174 | Args: |
| 175 | name: string, Required. The name of the policy to retrieve. (required) |
| 176 | x__xgafv: string, V1 error format. |
| 177 | Allowed values |
| 178 | 1 - v1 error format |
| 179 | 2 - v2 error format |
| 180 | |
| 181 | Returns: |
| 182 | An object of the form: |
| 183 | |
| 184 | { # A snapshot schedule policy. |
| 185 | "description": "A String", # The description of this SnapshotSchedulePolicy. |
| 186 | "name": "A String", # Output only. The name of this SnapshotSchedulePolicy. |
| 187 | "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified. |
| 188 | { # A snapshot schedule. |
| 189 | "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots. |
| 190 | "prefix": "A String", # A string to prefix names of snapshots created under this Schedule. |
| 191 | "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule. |
| 192 | }, |
| 193 | ], |
| 194 | "volumes": [ # The names of the Volumes this policy is associated with. |
| 195 | "A String", |
| 196 | ], |
| 197 | }</pre> |
| 198 | </div> |
| 199 | |
| 200 | <div class="method"> |
| 201 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 202 | <pre>List the snapshot schedule policies for the specified project |
| 203 | |
| 204 | Args: |
| 205 | parent: string, Required. The parent project containing the Snapshot Schedule Policies. (required) |
| 206 | pageSize: integer, The maximum number of items to return. |
| 207 | pageToken: string, The next_page_token value returned from a previous List request, if any. |
| 208 | x__xgafv: string, V1 error format. |
| 209 | Allowed values |
| 210 | 1 - v1 error format |
| 211 | 2 - v2 error format |
| 212 | |
| 213 | Returns: |
| 214 | An object of the form: |
| 215 | |
| 216 | { # Response for ListSnapshotSchedulePolicies. |
| 217 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. |
| 218 | "snapshotSchedulePolicies": [ # The snapshot schedule policies registered in this project. |
| 219 | { # A snapshot schedule policy. |
| 220 | "description": "A String", # The description of this SnapshotSchedulePolicy. |
| 221 | "name": "A String", # Output only. The name of this SnapshotSchedulePolicy. |
| 222 | "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified. |
| 223 | { # A snapshot schedule. |
| 224 | "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots. |
| 225 | "prefix": "A String", # A string to prefix names of snapshots created under this Schedule. |
| 226 | "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule. |
| 227 | }, |
| 228 | ], |
| 229 | "volumes": [ # The names of the Volumes this policy is associated with. |
| 230 | "A String", |
| 231 | ], |
| 232 | }, |
| 233 | ], |
| 234 | }</pre> |
| 235 | </div> |
| 236 | |
| 237 | <div class="method"> |
| 238 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 239 | <pre>Retrieves the next page of results. |
| 240 | |
| 241 | Args: |
| 242 | previous_request: The request for the previous page. (required) |
| 243 | previous_response: The response from the request for the previous page. (required) |
| 244 | |
| 245 | Returns: |
| 246 | A request object that you can call 'execute()' on to request the next |
| 247 | page. Returns None if there are no more items in the collection. |
| 248 | </pre> |
| 249 | </div> |
| 250 | |
| 251 | <div class="method"> |
| 252 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 253 | <pre>Update a SnapshotSchedulePolicy. |
| 254 | |
| 255 | Args: |
| 256 | name: string, Output only. The name of this SnapshotSchedulePolicy. (required) |
| 257 | body: object, The request body. |
| 258 | The object takes the form of: |
| 259 | |
| 260 | { # A snapshot schedule policy. |
| 261 | "description": "A String", # The description of this SnapshotSchedulePolicy. |
| 262 | "name": "A String", # Output only. The name of this SnapshotSchedulePolicy. |
| 263 | "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified. |
| 264 | { # A snapshot schedule. |
| 265 | "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots. |
| 266 | "prefix": "A String", # A string to prefix names of snapshots created under this Schedule. |
| 267 | "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule. |
| 268 | }, |
| 269 | ], |
| 270 | "volumes": [ # The names of the Volumes this policy is associated with. |
| 271 | "A String", |
| 272 | ], |
| 273 | } |
| 274 | |
| 275 | updateMask: string, The list of fields to update. |
| 276 | x__xgafv: string, V1 error format. |
| 277 | Allowed values |
| 278 | 1 - v1 error format |
| 279 | 2 - v2 error format |
| 280 | |
| 281 | Returns: |
| 282 | An object of the form: |
| 283 | |
| 284 | { # A snapshot schedule policy. |
| 285 | "description": "A String", # The description of this SnapshotSchedulePolicy. |
| 286 | "name": "A String", # Output only. The name of this SnapshotSchedulePolicy. |
| 287 | "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified. |
| 288 | { # A snapshot schedule. |
| 289 | "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots. |
| 290 | "prefix": "A String", # A string to prefix names of snapshots created under this Schedule. |
| 291 | "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule. |
| 292 | }, |
| 293 | ], |
| 294 | "volumes": [ # The names of the Volumes this policy is associated with. |
| 295 | "A String", |
| 296 | ], |
| 297 | }</pre> |
| 298 | </div> |
| 299 | |
| 300 | </body></html> |