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