blob: cea3d93b14449294cda6ca8dc2ecb9e332df612d [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="baremetalsolution_v2.html">Bare Metal Solution API</a> . <a href="baremetalsolution_v2.projects.html">projects</a> . <a href="baremetalsolution_v2.projects.locations.html">locations</a> . <a href="baremetalsolution_v2.projects.locations.volumes.html">volumes</a> . <a href="baremetalsolution_v2.projects.locations.volumes.luns.html">luns</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#evict">evict(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Skips lun's cooloff and deletes it now. Lun must be in cooloff state.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get details of a single storage logical unit number(LUN).</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List storage volume luns for given storage volume.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="evict">evict(name, body=None, x__xgafv=None)</code>
<pre>Skips lun&#x27;s cooloff and deletes it now. Lun must be in cooloff state.
Args:
name: string, Required. The name of the lun. (required)
body: object, The request body.
The object takes the form of:
{ # Request for skip lun cooloff and delete it.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
&quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get details of a single storage logical unit number(LUN).
Args:
name: string, Required. Name of the resource. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A storage volume logical unit number (LUN).
&quot;bootLun&quot;: True or False, # Display if this LUN is a boot LUN.
&quot;expireTime&quot;: &quot;A String&quot;, # Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state.
&quot;id&quot;: &quot;A String&quot;, # An identifier for the LUN, generated by the backend.
&quot;instances&quot;: [ # Output only. Instances this Lun is attached to.
&quot;A String&quot;,
],
&quot;multiprotocolType&quot;: &quot;A String&quot;, # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the LUN.
&quot;shareable&quot;: True or False, # Display if this LUN can be shared between multiple physical servers.
&quot;sizeGb&quot;: &quot;A String&quot;, # The size of this LUN, in GiB.
&quot;state&quot;: &quot;A String&quot;, # The state of this storage volume.
&quot;storageType&quot;: &quot;A String&quot;, # The storage type for this LUN.
&quot;storageVolume&quot;: &quot;A String&quot;, # Display the storage volume for this LUN.
&quot;wwid&quot;: &quot;A String&quot;, # The WWID for this LUN.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List storage volume luns for given storage volume.
Args:
parent: string, Required. Parent value for ListLunsRequest. (required)
pageSize: integer, Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, A token identifying a page of results from the server.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message containing the list of storage volume luns.
&quot;luns&quot;: [ # The list of luns.
{ # A storage volume logical unit number (LUN).
&quot;bootLun&quot;: True or False, # Display if this LUN is a boot LUN.
&quot;expireTime&quot;: &quot;A String&quot;, # Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state.
&quot;id&quot;: &quot;A String&quot;, # An identifier for the LUN, generated by the backend.
&quot;instances&quot;: [ # Output only. Instances this Lun is attached to.
&quot;A String&quot;,
],
&quot;multiprotocolType&quot;: &quot;A String&quot;, # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the LUN.
&quot;shareable&quot;: True or False, # Display if this LUN can be shared between multiple physical servers.
&quot;sizeGb&quot;: &quot;A String&quot;, # The size of this LUN, in GiB.
&quot;state&quot;: &quot;A String&quot;, # The state of this storage volume.
&quot;storageType&quot;: &quot;A String&quot;, # The storage type for this LUN.
&quot;storageVolume&quot;: &quot;A String&quot;, # Display the storage volume for this LUN.
&quot;wwid&quot;: &quot;A String&quot;, # The WWID for this LUN.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results from the server.
&quot;unreachable&quot;: [ # Locations that could not be reached.
&quot;A String&quot;,
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>