Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 32d1c597b364e2641eca33ccf6df802bb218eea1 / . / docs / dyn / cloudshell_v1alpha1.users.environments.publicKeys.html
blob: 0659bf0f0e43d86bd92cd0290317666743f405c5 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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="cloudshell_v1alpha1.html">Cloud Shell API</a> . <a href="cloudshell_v1alpha1.users.html">users</a> . <a href="cloudshell_v1alpha1.users.environments.html">environments</a> . <a href="cloudshell_v1alpha1.users.environments.publicKeys.html">publicKeys</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same format and content already exists, this will return the existing key.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <pre>Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same format and content already exists, this will return the existing key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95
96Args:
97 parent: string, Parent resource name, e.g. `users/me/environments/default`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]98 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99 The object takes the form of:
100
101{ # Request message for CreatePublicKey.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102 &quot;key&quot;: { # A public SSH key, corresponding to a private SSH key held by the client. # Key that should be added to the environment.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]103 &quot;format&quot;: &quot;A String&quot;, # Required. Format of this key&#x27;s content.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]104 &quot;key&quot;: &quot;A String&quot;, # Required. Content of this key.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]105 &quot;name&quot;: &quot;A String&quot;, # Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 },
107 }
108
109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113
114Returns:
115 An object of the form:
116
117 { # A public SSH key, corresponding to a private SSH key held by the client.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]118 &quot;format&quot;: &quot;A String&quot;, # Required. Format of this key&#x27;s content.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]119 &quot;key&quot;: &quot;A String&quot;, # Required. Content of this key.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]120 &quot;name&quot;: &quot;A String&quot;, # Output only. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. `{owner_email}` is the email address of the user to whom the key belongs. `{environment_id}` is the identifier of the environment to which the key grants access. `{key_id}` is the unique identifier of the key. For example, `users/someone@example.com/environments/default/publicKeys/myKey`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 }</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126 <pre>Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127
128Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]129 name: string, Name of the resource to be deleted, e.g. `users/me/environments/default/publicKeys/my-key`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135Returns:
136 An object of the form:
137
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]138 { # 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 `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 }</pre>
140</div>
141
142</body></html>