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="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. Gets 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="#setSslPolicy">setSslPolicy(project, targetSslProxy, body, requestId=None)</a></code></p> 103<p class="firstline">Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends.</p> 104<p class="toc_element"> 105 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 106<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="delete">delete(project, targetSslProxy, requestId=None)</code> 110 <pre>Deletes the specified TargetSslProxy resource. 111 112Args: 113 project: string, Project ID for this request. (required) 114 targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required) 115 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 116 117For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 118 119The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 120 121Returns: 122 An object of the form: 123 124 { # Represents an Operation resource. 125 # 126 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 127 # 128 # Operations can be global, regional or zonal. 129 # - For global operations, use the globalOperations resource. 130 # - For regional operations, use the regionOperations resource. 131 # - For zonal operations, use the zonalOperations resource. 132 # 133 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 134 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 135 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 136 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 137 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 138 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 139 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 140 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 141 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 142 "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. 143 "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. 144 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 145 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 146 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 147 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 148 { 149 "message": "A String", # [Output Only] A human-readable description of the warning code. 150 "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. 151 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 152 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 153 { 154 "value": "A String", # [Output Only] A warning data value corresponding to the key. 155 "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). 156 }, 157 ], 158 }, 159 ], 160 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 161 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 162 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 163 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 164 "name": "A String", # [Output Only] Name of the resource. 165 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 166 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 167 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 168 { 169 "message": "A String", # [Output Only] An optional, human-readable error message. 170 "code": "A String", # [Output Only] The error type identifier for this error. 171 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 172 }, 173 ], 174 }, 175 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 176 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 177 "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. 178 }</pre> 179</div> 180 181<div class="method"> 182 <code class="details" id="get">get(project, targetSslProxy)</code> 183 <pre>Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. 184 185Args: 186 project: string, Project ID for this request. (required) 187 targetSslProxy: string, Name of the TargetSslProxy resource to return. (required) 188 189Returns: 190 An object of the form: 191 192 { # A TargetSslProxy resource. This resource defines an SSL proxy. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) 193 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. 194 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 195 "service": "A String", # URL to the BackendService resource. 196 "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. 197 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. 198 "A String", 199 ], 200 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. 201 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 202 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 203 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 204 "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. 205 }</pre> 206</div> 207 208<div class="method"> 209 <code class="details" id="insert">insert(project, body, requestId=None)</code> 210 <pre>Creates a TargetSslProxy resource in the specified project using the data included in the request. 211 212Args: 213 project: string, Project ID for this request. (required) 214 body: object, The request body. (required) 215 The object takes the form of: 216 217{ # A TargetSslProxy resource. This resource defines an SSL proxy. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) 218 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. 219 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 220 "service": "A String", # URL to the BackendService resource. 221 "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. 222 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. 223 "A String", 224 ], 225 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. 226 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 227 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 228 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 229 "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. 230 } 231 232 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 233 234For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 235 236The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 237 238Returns: 239 An object of the form: 240 241 { # Represents an Operation resource. 242 # 243 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 244 # 245 # Operations can be global, regional or zonal. 246 # - For global operations, use the globalOperations resource. 247 # - For regional operations, use the regionOperations resource. 248 # - For zonal operations, use the zonalOperations resource. 249 # 250 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 251 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 252 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 253 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 254 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 255 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 256 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 257 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 258 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 259 "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. 260 "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. 261 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 262 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 263 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 264 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 265 { 266 "message": "A String", # [Output Only] A human-readable description of the warning code. 267 "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. 268 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 269 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 270 { 271 "value": "A String", # [Output Only] A warning data value corresponding to the key. 272 "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). 273 }, 274 ], 275 }, 276 ], 277 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 278 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 279 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 280 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 281 "name": "A String", # [Output Only] Name of the resource. 282 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 283 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 284 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 285 { 286 "message": "A String", # [Output Only] An optional, human-readable error message. 287 "code": "A String", # [Output Only] The error type identifier for this error. 288 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 289 }, 290 ], 291 }, 292 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 293 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 294 "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. 295 }</pre> 296</div> 297 298<div class="method"> 299 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 300 <pre>Retrieves the list of TargetSslProxy resources available to the specified project. 301 302Args: 303 project: string, Project ID for this request. (required) 304 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 305 306You 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. 307 308Currently, only sorting by name or creationTimestamp desc is supported. 309 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) 310 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. 311 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 312 313For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 314 315You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. 316 317To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). 318 319Returns: 320 An object of the form: 321 322 { # Contains a list of TargetSslProxy resources. 323 "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. 324 "kind": "compute#targetSslProxyList", # Type of resource. 325 "items": [ # A list of TargetSslProxy resources. 326 { # A TargetSslProxy resource. This resource defines an SSL proxy. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) 327 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. 328 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 329 "service": "A String", # URL to the BackendService resource. 330 "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. 331 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. 332 "A String", 333 ], 334 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. 335 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 336 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 337 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 338 "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. 339 }, 340 ], 341 "warning": { # [Output Only] Informational warning message. 342 "message": "A String", # [Output Only] A human-readable description of the warning code. 343 "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. 344 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 345 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 346 { 347 "value": "A String", # [Output Only] A warning data value corresponding to the key. 348 "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). 349 }, 350 ], 351 }, 352 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 353 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 354 }</pre> 355</div> 356 357<div class="method"> 358 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 359 <pre>Retrieves the next page of results. 360 361Args: 362 previous_request: The request for the previous page. (required) 363 previous_response: The response from the request for the previous page. (required) 364 365Returns: 366 A request object that you can call 'execute()' on to request the next 367 page. Returns None if there are no more items in the collection. 368 </pre> 369</div> 370 371<div class="method"> 372 <code class="details" id="setBackendService">setBackendService(project, targetSslProxy, body, requestId=None)</code> 373 <pre>Changes the BackendService for TargetSslProxy. 374 375Args: 376 project: string, Project ID for this request. (required) 377 targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required) 378 body: object, The request body. (required) 379 The object takes the form of: 380 381{ 382 "service": "A String", # The URL of the new BackendService resource for the targetSslProxy. 383 } 384 385 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 386 387For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 388 389The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 390 391Returns: 392 An object of the form: 393 394 { # Represents an Operation resource. 395 # 396 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 397 # 398 # Operations can be global, regional or zonal. 399 # - For global operations, use the globalOperations resource. 400 # - For regional operations, use the regionOperations resource. 401 # - For zonal operations, use the zonalOperations resource. 402 # 403 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 404 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 405 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 406 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 407 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 408 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 409 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 410 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 411 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 412 "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. 413 "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. 414 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 415 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 416 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 417 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 418 { 419 "message": "A String", # [Output Only] A human-readable description of the warning code. 420 "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. 421 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 422 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 423 { 424 "value": "A String", # [Output Only] A warning data value corresponding to the key. 425 "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). 426 }, 427 ], 428 }, 429 ], 430 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 431 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 432 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 433 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 434 "name": "A String", # [Output Only] Name of the resource. 435 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 436 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 437 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 438 { 439 "message": "A String", # [Output Only] An optional, human-readable error message. 440 "code": "A String", # [Output Only] The error type identifier for this error. 441 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 442 }, 443 ], 444 }, 445 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 446 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 447 "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. 448 }</pre> 449</div> 450 451<div class="method"> 452 <code class="details" id="setProxyHeader">setProxyHeader(project, targetSslProxy, body, requestId=None)</code> 453 <pre>Changes the ProxyHeaderType for TargetSslProxy. 454 455Args: 456 project: string, Project ID for this request. (required) 457 targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required) 458 body: object, The request body. (required) 459 The object takes the form of: 460 461{ 462 "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. 463 } 464 465 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 466 467For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 468 469The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 470 471Returns: 472 An object of the form: 473 474 { # Represents an Operation resource. 475 # 476 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 477 # 478 # Operations can be global, regional or zonal. 479 # - For global operations, use the globalOperations resource. 480 # - For regional operations, use the regionOperations resource. 481 # - For zonal operations, use the zonalOperations resource. 482 # 483 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 484 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 485 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 486 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 487 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 488 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 489 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 490 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 491 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 492 "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. 493 "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. 494 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 495 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 496 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 497 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 498 { 499 "message": "A String", # [Output Only] A human-readable description of the warning code. 500 "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. 501 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 502 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 503 { 504 "value": "A String", # [Output Only] A warning data value corresponding to the key. 505 "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). 506 }, 507 ], 508 }, 509 ], 510 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 511 "user": "A String", # [Output Only] User who requested the operation, for example: user@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 applicable 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="setSslCertificates">setSslCertificates(project, targetSslProxy, body, requestId=None)</code> 533 <pre>Changes SslCertificates for TargetSslProxy. 534 535Args: 536 project: string, Project ID for this request. (required) 537 targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required) 538 body: object, The request body. (required) 539 The object takes the form of: 540 541{ 542 "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified. 543 "A String", 544 ], 545 } 546 547 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 548 549For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 550 551The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 552 553Returns: 554 An object of the form: 555 556 { # Represents an Operation resource. 557 # 558 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 559 # 560 # Operations can be global, regional or zonal. 561 # - For global operations, use the globalOperations resource. 562 # - For regional operations, use the regionOperations resource. 563 # - For zonal operations, use the zonalOperations resource. 564 # 565 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 566 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 567 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 568 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 569 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 570 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 571 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 572 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 573 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 574 "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. 575 "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. 576 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 577 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 578 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 579 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 580 { 581 "message": "A String", # [Output Only] A human-readable description of the warning code. 582 "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. 583 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 584 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 585 { 586 "value": "A String", # [Output Only] A warning data value corresponding to the key. 587 "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). 588 }, 589 ], 590 }, 591 ], 592 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 593 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 594 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 595 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 596 "name": "A String", # [Output Only] Name of the resource. 597 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 598 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 599 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 600 { 601 "message": "A String", # [Output Only] An optional, human-readable error message. 602 "code": "A String", # [Output Only] The error type identifier for this error. 603 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 604 }, 605 ], 606 }, 607 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 608 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 609 "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. 610 }</pre> 611</div> 612 613<div class="method"> 614 <code class="details" id="setSslPolicy">setSslPolicy(project, targetSslProxy, body, requestId=None)</code> 615 <pre>Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. 616 617Args: 618 project: string, Project ID for this request. (required) 619 targetSslProxy: string, Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. (required) 620 body: object, The request body. (required) 621 The object takes the form of: 622 623{ 624 "sslPolicy": "A String", # URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource. 625 } 626 627 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 628 629For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 630 631The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 632 633Returns: 634 An object of the form: 635 636 { # Represents an Operation resource. 637 # 638 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 639 # 640 # Operations can be global, regional or zonal. 641 # - For global operations, use the globalOperations resource. 642 # - For regional operations, use the regionOperations resource. 643 # - For zonal operations, use the zonalOperations resource. 644 # 645 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 646 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 647 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 648 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 649 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 650 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 651 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 652 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 653 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 654 "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. 655 "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. 656 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 657 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 658 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 659 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 660 { 661 "message": "A String", # [Output Only] A human-readable description of the warning code. 662 "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. 663 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 664 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 665 { 666 "value": "A String", # [Output Only] A warning data value corresponding to the key. 667 "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). 668 }, 669 ], 670 }, 671 ], 672 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 673 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 674 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 675 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 676 "name": "A String", # [Output Only] Name of the resource. 677 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 678 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 679 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 680 { 681 "message": "A String", # [Output Only] An optional, human-readable error message. 682 "code": "A String", # [Output Only] The error type identifier for this error. 683 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 684 }, 685 ], 686 }, 687 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 688 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 689 "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. 690 }</pre> 691</div> 692 693<div class="method"> 694 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 695 <pre>Returns permissions that a caller has on the specified resource. 696 697Args: 698 project: string, Project ID for this request. (required) 699 resource: string, Name or id of the resource for this request. (required) 700 body: object, The request body. (required) 701 The object takes the form of: 702 703{ 704 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 705 "A String", 706 ], 707 } 708 709 710Returns: 711 An object of the form: 712 713 { 714 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 715 "A String", 716 ], 717 }</pre> 718</div> 719 720</body></html>