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="storage_v1.html">Cloud Storage JSON API</a> . <a href="storage_v1.projects.html">projects</a> . <a href="storage_v1.projects.hmacKeys.html">hmacKeys</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#create">create(projectId, serviceAccountEmail, userProject=None)</a></code></p>
79<p class="firstline">Creates a new HMAC key for the specified service account.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(projectId, accessId, userProject=None)</a></code></p>
82<p class="firstline">Deletes an HMAC key.</p>
83<p class="toc_element">
84  <code><a href="#get">get(projectId, accessId, userProject=None)</a></code></p>
85<p class="firstline">Retrieves an HMAC key's metadata</p>
86<p class="toc_element">
87  <code><a href="#list">list(projectId, pageToken=None, showDeletedKeys=None, userProject=None, maxResults=None, serviceAccountEmail=None)</a></code></p>
88<p class="firstline">Retrieves a list of HMAC keys matching the criteria.</p>
89<p class="toc_element">
90  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93  <code><a href="#update">update(projectId, accessId, body, userProject=None)</a></code></p>
94<p class="firstline">Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.</p>
95<h3>Method Details</h3>
96<div class="method">
97    <code class="details" id="create">create(projectId, serviceAccountEmail, userProject=None)</code>
98  <pre>Creates a new HMAC key for the specified service account.
99
100Args:
101  projectId: string, Project ID owning the service account. (required)
102  serviceAccountEmail: string, Email address of the service account. (required)
103  userProject: string, The project to be billed for this request.
104
105Returns:
106  An object of the form:
107
108    { # JSON template to produce a JSON-style HMAC Key resource for Create responses.
109    "kind": "storage#hmacKey", # The kind of item this is. For HMAC keys, this is always storage#hmacKey.
110    "secret": "A String", # HMAC secret key material.
111    "metadata": { # JSON template to produce a JSON-style HMAC Key metadata resource. # Key metadata.
112      "kind": "storage#hmacKeyMetadata", # The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
113      "updated": "A String", # The last modification time of the HMAC key metadata in RFC 3339 format.
114      "timeCreated": "A String", # The creation time of the HMAC key in RFC 3339 format.
115      "projectId": "A String", # Project ID owning the service account to which the key authenticates.
116      "accessId": "A String", # The ID of the HMAC Key.
117      "state": "A String", # The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
118      "etag": "A String", # HTTP 1.1 Entity tag for the HMAC key.
119      "serviceAccountEmail": "A String", # The email address of the key's associated service account.
120      "id": "A String", # The ID of the HMAC key, including the Project ID and the Access ID.
121      "selfLink": "A String", # The link to this resource.
122    },
123  }</pre>
124</div>
125
126<div class="method">
127    <code class="details" id="delete">delete(projectId, accessId, userProject=None)</code>
128  <pre>Deletes an HMAC key.
129
130Args:
131  projectId: string, Project ID owning the requested key (required)
132  accessId: string, Name of the HMAC key to be deleted. (required)
133  userProject: string, The project to be billed for this request.
134</pre>
135</div>
136
137<div class="method">
138    <code class="details" id="get">get(projectId, accessId, userProject=None)</code>
139  <pre>Retrieves an HMAC key's metadata
140
141Args:
142  projectId: string, Project ID owning the service account of the requested key. (required)
143  accessId: string, Name of the HMAC key. (required)
144  userProject: string, The project to be billed for this request.
145
146Returns:
147  An object of the form:
148
149    { # JSON template to produce a JSON-style HMAC Key metadata resource.
150    "kind": "storage#hmacKeyMetadata", # The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
151    "updated": "A String", # The last modification time of the HMAC key metadata in RFC 3339 format.
152    "timeCreated": "A String", # The creation time of the HMAC key in RFC 3339 format.
153    "projectId": "A String", # Project ID owning the service account to which the key authenticates.
154    "accessId": "A String", # The ID of the HMAC Key.
155    "state": "A String", # The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
156    "etag": "A String", # HTTP 1.1 Entity tag for the HMAC key.
157    "serviceAccountEmail": "A String", # The email address of the key's associated service account.
158    "id": "A String", # The ID of the HMAC key, including the Project ID and the Access ID.
159    "selfLink": "A String", # The link to this resource.
160  }</pre>
161</div>
162
163<div class="method">
164    <code class="details" id="list">list(projectId, pageToken=None, showDeletedKeys=None, userProject=None, maxResults=None, serviceAccountEmail=None)</code>
165  <pre>Retrieves a list of HMAC keys matching the criteria.
166
167Args:
168  projectId: string, Name of the project in which to look for HMAC keys. (required)
169  pageToken: string, A previously-returned page token representing part of the larger set of results to view.
170  showDeletedKeys: boolean, Whether or not to show keys in the DELETED state.
171  userProject: string, The project to be billed for this request.
172  maxResults: integer, Maximum number of items to return in a single page of responses. The service uses this parameter or 250 items, whichever is smaller. The max number of items per page will also be limited by the number of distinct service accounts in the response. If the number of service accounts in a single response is too high, the page will truncated and a next page token will be returned.
173  serviceAccountEmail: string, If present, only keys for the given service account are returned.
174
175Returns:
176  An object of the form:
177
178    { # A list of hmacKeys.
179    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
180    "items": [ # The list of items.
181      { # JSON template to produce a JSON-style HMAC Key metadata resource.
182        "kind": "storage#hmacKeyMetadata", # The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
183        "updated": "A String", # The last modification time of the HMAC key metadata in RFC 3339 format.
184        "timeCreated": "A String", # The creation time of the HMAC key in RFC 3339 format.
185        "projectId": "A String", # Project ID owning the service account to which the key authenticates.
186        "accessId": "A String", # The ID of the HMAC Key.
187        "state": "A String", # The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
188        "etag": "A String", # HTTP 1.1 Entity tag for the HMAC key.
189        "serviceAccountEmail": "A String", # The email address of the key's associated service account.
190        "id": "A String", # The ID of the HMAC key, including the Project ID and the Access ID.
191        "selfLink": "A String", # The link to this resource.
192      },
193    ],
194    "kind": "storage#hmacKeysMetadata", # The kind of item this is. For lists of hmacKeys, this is always storage#hmacKeysMetadata.
195  }</pre>
196</div>
197
198<div class="method">
199    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
200  <pre>Retrieves the next page of results.
201
202Args:
203  previous_request: The request for the previous page. (required)
204  previous_response: The response from the request for the previous page. (required)
205
206Returns:
207  A request object that you can call 'execute()' on to request the next
208  page. Returns None if there are no more items in the collection.
209    </pre>
210</div>
211
212<div class="method">
213    <code class="details" id="update">update(projectId, accessId, body, userProject=None)</code>
214  <pre>Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.
215
216Args:
217  projectId: string, Project ID owning the service account of the updated key. (required)
218  accessId: string, Name of the HMAC key being updated. (required)
219  body: object, The request body. (required)
220    The object takes the form of:
221
222{ # JSON template to produce a JSON-style HMAC Key metadata resource.
223  "kind": "storage#hmacKeyMetadata", # The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
224  "updated": "A String", # The last modification time of the HMAC key metadata in RFC 3339 format.
225  "timeCreated": "A String", # The creation time of the HMAC key in RFC 3339 format.
226  "projectId": "A String", # Project ID owning the service account to which the key authenticates.
227  "accessId": "A String", # The ID of the HMAC Key.
228  "state": "A String", # The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
229  "etag": "A String", # HTTP 1.1 Entity tag for the HMAC key.
230  "serviceAccountEmail": "A String", # The email address of the key's associated service account.
231  "id": "A String", # The ID of the HMAC key, including the Project ID and the Access ID.
232  "selfLink": "A String", # The link to this resource.
233}
234
235  userProject: string, The project to be billed for this request.
236
237Returns:
238  An object of the form:
239
240    { # JSON template to produce a JSON-style HMAC Key metadata resource.
241    "kind": "storage#hmacKeyMetadata", # The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
242    "updated": "A String", # The last modification time of the HMAC key metadata in RFC 3339 format.
243    "timeCreated": "A String", # The creation time of the HMAC key in RFC 3339 format.
244    "projectId": "A String", # Project ID owning the service account to which the key authenticates.
245    "accessId": "A String", # The ID of the HMAC Key.
246    "state": "A String", # The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
247    "etag": "A String", # HTTP 1.1 Entity tag for the HMAC key.
248    "serviceAccountEmail": "A String", # The email address of the key's associated service account.
249    "id": "A String", # The ID of the HMAC key, including the Project ID and the Access ID.
250    "selfLink": "A String", # The link to this resource.
251  }</pre>
252</div>
253
254</body></html>