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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetSslProxies.html">targetSslProxies</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(project, targetSslProxy, requestId=None)</a></code></p> 79 <p class="firstline">Deletes the specified TargetSslProxy resource.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(project, targetSslProxy)</a></code></p> 82 <p class="firstline">Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request.</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p> 85 <p class="firstline">Creates a TargetSslProxy resource in the specified project using the data included in the request.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 88 <p class="firstline">Retrieves the list of TargetSslProxy resources available to the specified project.</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="#setBackendService">setBackendService(project, targetSslProxy, body, requestId=None)</a></code></p> 94 <p class="firstline">Changes the BackendService for TargetSslProxy.</p> 95 <p class="toc_element"> 96 <code><a href="#setProxyHeader">setProxyHeader(project, targetSslProxy, body, requestId=None)</a></code></p> 97 <p class="firstline">Changes the ProxyHeaderType for TargetSslProxy.</p> 98 <p class="toc_element"> 99 <code><a href="#setSslCertificates">setSslCertificates(project, targetSslProxy, body, requestId=None)</a></code></p> 100 <p class="firstline">Changes SslCertificates for TargetSslProxy.</p> 101 <p class="toc_element"> 102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 103 <p class="firstline">Returns permissions that a caller has on the specified resource.</p> 104 <h3>Method Details</h3> 105 <div class="method"> 106 <code class="details" id="delete">delete(project, targetSslProxy, requestId=None)</code> 107 <pre>Deletes the specified TargetSslProxy resource. 108 109 Args: 110 project: string, Project ID for this request. (required) 111 targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required) 112 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 113 114 Returns: 115 An object of the form: 116 117 { # An Operation resource, used to manage asynchronous API requests. 118 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 119 "clientOperationId": "A String", # [Output Only] Reserved for future use. 120 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 121 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 122 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 123 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 124 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 125 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 126 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 127 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 128 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 129 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 130 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 131 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 132 { 133 "message": "A String", # [Output Only] A human-readable description of the warning code. 134 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 135 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 136 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 137 { 138 "value": "A String", # [Output Only] A warning data value corresponding to the key. 139 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 140 }, 141 ], 142 }, 143 ], 144 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 145 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 146 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 147 "name": "A String", # [Output Only] Name of the resource. 148 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 149 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 150 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 151 { 152 "message": "A String", # [Output Only] An optional, human-readable error message. 153 "code": "A String", # [Output Only] The error type identifier for this error. 154 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 155 }, 156 ], 157 }, 158 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 159 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 160 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 161 }</pre> 162 </div> 163 164 <div class="method"> 165 <code class="details" id="get">get(project, targetSslProxy)</code> 166 <pre>Returns the specified TargetSslProxy resource. Get a list of available target SSL proxies by making a list() request. 167 168 Args: 169 project: string, Project ID for this request. (required) 170 targetSslProxy: string, Name of the TargetSslProxy resource to return. (required) 171 172 Returns: 173 An object of the form: 174 175 { # A TargetSslProxy resource. This resource defines an SSL proxy. 176 "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers. 177 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. 178 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 179 "service": "A String", # URL to the BackendService resource. 180 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 181 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified. 182 "A String", 183 ], 184 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 185 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 186 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 187 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 188 }</pre> 189 </div> 190 191 <div class="method"> 192 <code class="details" id="insert">insert(project, body, requestId=None)</code> 193 <pre>Creates a TargetSslProxy resource in the specified project using the data included in the request. 194 195 Args: 196 project: string, Project ID for this request. (required) 197 body: object, The request body. (required) 198 The object takes the form of: 199 200 { # A TargetSslProxy resource. This resource defines an SSL proxy. 201 "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers. 202 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. 203 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 204 "service": "A String", # URL to the BackendService resource. 205 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 206 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified. 207 "A String", 208 ], 209 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 210 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 211 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 212 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 213 } 214 215 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 216 217 Returns: 218 An object of the form: 219 220 { # An Operation resource, used to manage asynchronous API requests. 221 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 222 "clientOperationId": "A String", # [Output Only] Reserved for future use. 223 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 224 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 225 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 226 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 227 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 228 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 229 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 230 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 231 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 232 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 233 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 234 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 235 { 236 "message": "A String", # [Output Only] A human-readable description of the warning code. 237 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 238 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 239 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 240 { 241 "value": "A String", # [Output Only] A warning data value corresponding to the key. 242 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 243 }, 244 ], 245 }, 246 ], 247 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 248 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 249 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 250 "name": "A String", # [Output Only] Name of the resource. 251 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 252 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 253 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 254 { 255 "message": "A String", # [Output Only] An optional, human-readable error message. 256 "code": "A String", # [Output Only] The error type identifier for this error. 257 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 258 }, 259 ], 260 }, 261 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 262 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 263 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 264 }</pre> 265 </div> 266 267 <div class="method"> 268 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 269 <pre>Retrieves the list of TargetSslProxy resources available to the specified project. 270 271 Args: 272 project: string, Project ID for this request. (required) 273 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 274 275 You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. 276 277 Currently, only sorting by name or creationTimestamp desc is supported. 278 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) 279 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. 280 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 281 282 The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 283 284 For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 285 286 You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 287 288 To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 289 290 Returns: 291 An object of the form: 292 293 { # Contains a list of TargetSslProxy resources. 294 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. 295 "items": [ # A list of TargetSslProxy resources. 296 { # A TargetSslProxy resource. This resource defines an SSL proxy. 297 "clientSslPolicy": "A String", # URL to ClientSslPolicy resource which controls the set of allowed SSL versions and ciphers. 298 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. 299 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 300 "service": "A String", # URL to the BackendService resource. 301 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. 302 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. Currently exactly one SSL certificate must be specified. 303 "A String", 304 ], 305 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 306 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 307 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 308 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 309 }, 310 ], 311 "kind": "compute#targetSslProxyList", # Type of resource. 312 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 313 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 314 }</pre> 315 </div> 316 317 <div class="method"> 318 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 319 <pre>Retrieves the next page of results. 320 321 Args: 322 previous_request: The request for the previous page. (required) 323 previous_response: The response from the request for the previous page. (required) 324 325 Returns: 326 A request object that you can call 'execute()' on to request the next 327 page. Returns None if there are no more items in the collection. 328 </pre> 329 </div> 330 331 <div class="method"> 332 <code class="details" id="setBackendService">setBackendService(project, targetSslProxy, body, requestId=None)</code> 333 <pre>Changes the BackendService for TargetSslProxy. 334 335 Args: 336 project: string, Project ID for this request. (required) 337 targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required) 338 body: object, The request body. (required) 339 The object takes the form of: 340 341 { 342 "service": "A String", # The URL of the new BackendService resource for the targetSslProxy. 343 } 344 345 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 346 347 Returns: 348 An object of the form: 349 350 { # An Operation resource, used to manage asynchronous API requests. 351 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 352 "clientOperationId": "A String", # [Output Only] Reserved for future use. 353 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 354 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 355 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 356 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 357 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 358 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 359 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 360 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 361 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 362 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 363 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 364 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 365 { 366 "message": "A String", # [Output Only] A human-readable description of the warning code. 367 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 368 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 369 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 370 { 371 "value": "A String", # [Output Only] A warning data value corresponding to the key. 372 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 373 }, 374 ], 375 }, 376 ], 377 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 378 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 379 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 380 "name": "A String", # [Output Only] Name of the resource. 381 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 382 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 383 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 384 { 385 "message": "A String", # [Output Only] An optional, human-readable error message. 386 "code": "A String", # [Output Only] The error type identifier for this error. 387 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 388 }, 389 ], 390 }, 391 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 392 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 393 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 394 }</pre> 395 </div> 396 397 <div class="method"> 398 <code class="details" id="setProxyHeader">setProxyHeader(project, targetSslProxy, body, requestId=None)</code> 399 <pre>Changes the ProxyHeaderType for TargetSslProxy. 400 401 Args: 402 project: string, Project ID for this request. (required) 403 targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required) 404 body: object, The request body. (required) 405 The object takes the form of: 406 407 { 408 "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. 409 } 410 411 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 412 413 Returns: 414 An object of the form: 415 416 { # An Operation resource, used to manage asynchronous API requests. 417 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 418 "clientOperationId": "A String", # [Output Only] Reserved for future use. 419 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 420 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 421 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 422 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 423 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 424 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 425 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 426 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 427 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 428 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 429 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 430 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 431 { 432 "message": "A String", # [Output Only] A human-readable description of the warning code. 433 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 434 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 435 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 436 { 437 "value": "A String", # [Output Only] A warning data value corresponding to the key. 438 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 439 }, 440 ], 441 }, 442 ], 443 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 444 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 445 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 446 "name": "A String", # [Output Only] Name of the resource. 447 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 448 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 449 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 450 { 451 "message": "A String", # [Output Only] An optional, human-readable error message. 452 "code": "A String", # [Output Only] The error type identifier for this error. 453 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 454 }, 455 ], 456 }, 457 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 458 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 459 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 460 }</pre> 461 </div> 462 463 <div class="method"> 464 <code class="details" id="setSslCertificates">setSslCertificates(project, targetSslProxy, body, requestId=None)</code> 465 <pre>Changes SslCertificates for TargetSslProxy. 466 467 Args: 468 project: string, Project ID for this request. (required) 469 targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required) 470 body: object, The request body. (required) 471 The object takes the form of: 472 473 { 474 "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified. 475 "A String", 476 ], 477 } 478 479 requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency. 480 481 Returns: 482 An object of the form: 483 484 { # An Operation resource, used to manage asynchronous API requests. 485 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 486 "clientOperationId": "A String", # [Output Only] Reserved for future use. 487 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 488 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 489 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 490 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 491 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 492 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 493 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 494 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 495 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 496 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 497 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 498 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 499 { 500 "message": "A String", # [Output Only] A human-readable description of the warning code. 501 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. 502 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 503 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 504 { 505 "value": "A String", # [Output Only] A warning data value corresponding to the key. 506 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 507 }, 508 ], 509 }, 510 ], 511 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 512 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 513 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 514 "name": "A String", # [Output Only] Name of the resource. 515 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 516 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 517 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 518 { 519 "message": "A String", # [Output Only] An optional, human-readable error message. 520 "code": "A String", # [Output Only] The error type identifier for this error. 521 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 522 }, 523 ], 524 }, 525 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 526 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 527 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 528 }</pre> 529 </div> 530 531 <div class="method"> 532 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 533 <pre>Returns permissions that a caller has on the specified resource. 534 535 Args: 536 project: string, Project ID for this request. (required) 537 resource: string, Name of the resource for this request. (required) 538 body: object, The request body. (required) 539 The object takes the form of: 540 541 { 542 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 543 "A String", 544 ], 545 } 546 547 548 Returns: 549 An object of the form: 550 551 { 552 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 553 "A String", 554 ], 555 }</pre> 556 </div> 557 558 </body></html>
