Debian Codegraph @

docs/dyn/baremetalsolution_v2.projects.locations.sshKeys.html

raw
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_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.sshKeys.html">sshKeys</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, sshKeyId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Register a public SSH key in the specified project for use with the interactive serial console feature.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a public SSH key registered in the specified project.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="create">create(parent, body=None, sshKeyId=None, x__xgafv=None)</code>
100 <pre>Register a public SSH key in the specified project for use with the interactive serial console feature.
101
102 Args:
103 parent: string, Required. The parent containing the SSH keys. (required)
104 body: object, The request body.
105 The object takes the form of:
106
107 { # An SSH key, used for authorizing with the interactive serial console feature.
108 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this SSH key. Currently, the only valid value for the location is &quot;global&quot;.
109 &quot;publicKey&quot;: &quot;A String&quot;, # The public SSH key. This must be in OpenSSH .authorized_keys format.
110 }
111
112 sshKeyId: string, Required. The ID to use for the key, which will become the final component of the key&#x27;s resource name. This value must match the regex: [a-zA-Z0-9@.\-_]{1,64}
113 x__xgafv: string, V1 error format.
114 Allowed values
115 1 - v1 error format
116 2 - v2 error format
117
118 Returns:
119 An object of the form:
120
121 { # An SSH key, used for authorizing with the interactive serial console feature.
122 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this SSH key. Currently, the only valid value for the location is &quot;global&quot;.
123 &quot;publicKey&quot;: &quot;A String&quot;, # The public SSH key. This must be in OpenSSH .authorized_keys format.
124 }</pre>
125 </div>
126
127 <div class="method">
128 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
129 <pre>Deletes a public SSH key registered in the specified project.
130
131 Args:
132 name: string, Required. The name of the SSH key to delete. Currently, the only valid value for the location is &quot;global&quot;. (required)
133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
137
138 Returns:
139 An object of the form:
140
141 { # 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); }
142 }</pre>
143 </div>
144
145 <div class="method">
146 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
147 <pre>Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.
148
149 Args:
150 parent: string, Required. The parent containing the SSH keys. Currently, the only valid value for the location is &quot;global&quot;. (required)
151 pageSize: integer, The maximum number of items to return.
152 pageToken: string, The next_page_token value returned from a previous List request, if any.
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158 Returns:
159 An object of the form:
160
161 { # Message for response of ListSSHKeys.
162 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
163 &quot;sshKeys&quot;: [ # The SSH keys registered in the project.
164 { # An SSH key, used for authorizing with the interactive serial console feature.
165 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this SSH key. Currently, the only valid value for the location is &quot;global&quot;.
166 &quot;publicKey&quot;: &quot;A String&quot;, # The public SSH key. This must be in OpenSSH .authorized_keys format.
167 },
168 ],
169 }</pre>
170 </div>
171
172 <div class="method">
173 <code class="details" id="list_next">list_next()</code>
174 <pre>Retrieves the next page of results.
175
176 Args:
177 previous_request: The request for the previous page. (required)
178 previous_response: The response from the request for the previous page. (required)
179
180 Returns:
181 A request object that you can call &#x27;execute()&#x27; on to request the next
182 page. Returns None if there are no more items in the collection.
183 </pre>
184 </div>
185
186 </body></html>