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_v1.html">Compute Engine API</a> . <a href="compute_v1.targetSslProxies.html">targetSslProxies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, targetSslProxy, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes the specified TargetSslProxy resource.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, targetSslProxy, x__xgafv=None)</a></code></p> 85<p class="firstline">Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Creates a TargetSslProxy resource in the specified project using the data included in the request.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves the list of TargetSslProxy resources available to the specified project.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#setBackendService">setBackendService(project, targetSslProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Changes the BackendService for TargetSslProxy.</p> 98<p class="toc_element"> 99 <code><a href="#setProxyHeader">setProxyHeader(project, targetSslProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Changes the ProxyHeaderType for TargetSslProxy.</p> 101<p class="toc_element"> 102 <code><a href="#setSslCertificates">setSslCertificates(project, targetSslProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Changes SslCertificates for TargetSslProxy.</p> 104<p class="toc_element"> 105 <code><a href="#setSslPolicy">setSslPolicy(project, targetSslProxy, body=None, requestId=None, x__xgafv=None)</a></code></p> 106<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> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="close">close()</code> 110 <pre>Close httplib2 connections.</pre> 111</div> 112 113<div class="method"> 114 <code class="details" id="delete">delete(project, targetSslProxy, requestId=None, x__xgafv=None)</code> 115 <pre>Deletes the specified TargetSslProxy resource. 116 117Args: 118 project: string, Project ID for this request. (required) 119 targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required) 120 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 121 x__xgafv: string, V1 error format. 122 Allowed values 123 1 - v1 error format 124 2 - v2 error format 125 126Returns: 127 An object of the form: 128 129 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 130 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 131 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 132 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 133 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 134 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 135 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 136 { 137 "code": "A String", # [Output Only] The error type identifier for this error. 138 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 139 "message": "A String", # [Output Only] An optional, human-readable error message. 140 }, 141 ], 142 }, 143 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 144 "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. 145 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 146 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 147 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 148 "name": "A String", # [Output Only] Name of the operation. 149 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 150 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 151 "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. 152 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 153 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 154 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 155 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 156 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 157 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 158 "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. 159 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 160 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 161 { 162 "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. 163 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 164 { 165 "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). 166 "value": "A String", # [Output Only] A warning data value corresponding to the key. 167 }, 168 ], 169 "message": "A String", # [Output Only] A human-readable description of the warning code. 170 }, 171 ], 172 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 173}</pre> 174</div> 175 176<div class="method"> 177 <code class="details" id="get">get(project, targetSslProxy, x__xgafv=None)</code> 178 <pre>Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. 179 180Args: 181 project: string, Project ID for this request. (required) 182 targetSslProxy: string, Name of the TargetSslProxy resource to return. (required) 183 x__xgafv: string, V1 error format. 184 Allowed values 185 1 - v1 error format 186 2 - v2 error format 187 188Returns: 189 An object of the form: 190 191 { # Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. 192 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 193 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 194 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 195 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. 196 "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. 197 "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. 198 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 199 "service": "A String", # URL to the BackendService resource. 200 "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. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. 201 "A String", 202 ], 203 "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. 204}</pre> 205</div> 206 207<div class="method"> 208 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 209 <pre>Creates a TargetSslProxy resource in the specified project using the data included in the request. 210 211Args: 212 project: string, Project ID for this request. (required) 213 body: object, The request body. 214 The object takes the form of: 215 216{ # Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. 217 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 218 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 219 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 220 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. 221 "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. 222 "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. 223 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 224 "service": "A String", # URL to the BackendService resource. 225 "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. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. 226 "A String", 227 ], 228 "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. 229} 230 231 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 232 x__xgafv: string, V1 error format. 233 Allowed values 234 1 - v1 error format 235 2 - v2 error format 236 237Returns: 238 An object of the form: 239 240 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 241 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 242 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 243 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 244 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 245 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 246 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 247 { 248 "code": "A String", # [Output Only] The error type identifier for this error. 249 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 250 "message": "A String", # [Output Only] An optional, human-readable error message. 251 }, 252 ], 253 }, 254 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 255 "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. 256 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 257 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 258 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 259 "name": "A String", # [Output Only] Name of the operation. 260 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 261 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 262 "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. 263 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 264 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 265 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 266 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 267 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 268 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 269 "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. 270 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 271 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 272 { 273 "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. 274 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 275 { 276 "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). 277 "value": "A String", # [Output Only] A warning data value corresponding to the key. 278 }, 279 ], 280 "message": "A String", # [Output Only] A human-readable description of the warning code. 281 }, 282 ], 283 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 284}</pre> 285</div> 286 287<div class="method"> 288 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 289 <pre>Retrieves the list of TargetSslProxy resources available to the specified project. 290 291Args: 292 project: string, Project ID for this request. (required) 293 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To 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) ``` 294 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`) 295 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 296 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. 297 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 298 x__xgafv: string, V1 error format. 299 Allowed values 300 1 - v1 error format 301 2 - v2 error format 302 303Returns: 304 An object of the form: 305 306 { # Contains a list of TargetSslProxy resources. 307 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 308 "items": [ # A list of TargetSslProxy resources. 309 { # Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. 310 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 311 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 312 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 313 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. 314 "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. 315 "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. 316 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 317 "service": "A String", # URL to the BackendService resource. 318 "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. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. 319 "A String", 320 ], 321 "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. 322 }, 323 ], 324 "kind": "compute#targetSslProxyList", # Type of resource. 325 "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. 326 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 327 "warning": { # [Output Only] Informational warning message. 328 "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. 329 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 330 { 331 "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). 332 "value": "A String", # [Output Only] A warning data value corresponding to the key. 333 }, 334 ], 335 "message": "A String", # [Output Only] A human-readable description of the warning code. 336 }, 337}</pre> 338</div> 339 340<div class="method"> 341 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 342 <pre>Retrieves the next page of results. 343 344Args: 345 previous_request: The request for the previous page. (required) 346 previous_response: The response from the request for the previous page. (required) 347 348Returns: 349 A request object that you can call 'execute()' on to request the next 350 page. Returns None if there are no more items in the collection. 351 </pre> 352</div> 353 354<div class="method"> 355 <code class="details" id="setBackendService">setBackendService(project, targetSslProxy, body=None, requestId=None, x__xgafv=None)</code> 356 <pre>Changes the BackendService for TargetSslProxy. 357 358Args: 359 project: string, Project ID for this request. (required) 360 targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required) 361 body: object, The request body. 362 The object takes the form of: 363 364{ 365 "service": "A String", # The URL of the new BackendService resource for the targetSslProxy. 366} 367 368 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 369 x__xgafv: string, V1 error format. 370 Allowed values 371 1 - v1 error format 372 2 - v2 error format 373 374Returns: 375 An object of the form: 376 377 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 378 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 379 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 380 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 381 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 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 "code": "A String", # [Output Only] The error type identifier for this error. 386 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 387 "message": "A String", # [Output Only] An optional, human-readable error message. 388 }, 389 ], 390 }, 391 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 392 "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. 393 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 394 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 395 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 396 "name": "A String", # [Output Only] Name of the operation. 397 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 398 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 399 "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. 400 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 401 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 402 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 403 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 404 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 405 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 406 "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. 407 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 408 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 409 { 410 "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. 411 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 412 { 413 "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). 414 "value": "A String", # [Output Only] A warning data value corresponding to the key. 415 }, 416 ], 417 "message": "A String", # [Output Only] A human-readable description of the warning code. 418 }, 419 ], 420 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 421}</pre> 422</div> 423 424<div class="method"> 425 <code class="details" id="setProxyHeader">setProxyHeader(project, targetSslProxy, body=None, requestId=None, x__xgafv=None)</code> 426 <pre>Changes the ProxyHeaderType for TargetSslProxy. 427 428Args: 429 project: string, Project ID for this request. (required) 430 targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required) 431 body: object, The request body. 432 The object takes the form of: 433 434{ 435 "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed. 436} 437 438 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 439 x__xgafv: string, V1 error format. 440 Allowed values 441 1 - v1 error format 442 2 - v2 error format 443 444Returns: 445 An object of the form: 446 447 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 448 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 449 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 450 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 451 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 452 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 453 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 454 { 455 "code": "A String", # [Output Only] The error type identifier for this error. 456 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 457 "message": "A String", # [Output Only] An optional, human-readable error message. 458 }, 459 ], 460 }, 461 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 462 "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. 463 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 464 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 465 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 466 "name": "A String", # [Output Only] Name of the operation. 467 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 468 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 469 "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. 470 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 471 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 472 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 473 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 474 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 475 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 476 "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. 477 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 478 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 479 { 480 "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. 481 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 482 { 483 "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). 484 "value": "A String", # [Output Only] A warning data value corresponding to the key. 485 }, 486 ], 487 "message": "A String", # [Output Only] A human-readable description of the warning code. 488 }, 489 ], 490 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 491}</pre> 492</div> 493 494<div class="method"> 495 <code class="details" id="setSslCertificates">setSslCertificates(project, targetSslProxy, body=None, requestId=None, x__xgafv=None)</code> 496 <pre>Changes SslCertificates for TargetSslProxy. 497 498Args: 499 project: string, Project ID for this request. (required) 500 targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required) 501 body: object, The request body. 502 The object takes the form of: 503 504{ 505 "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. 506 "A String", 507 ], 508} 509 510 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 511 x__xgafv: string, V1 error format. 512 Allowed values 513 1 - v1 error format 514 2 - v2 error format 515 516Returns: 517 An object of the form: 518 519 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 520 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 521 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 522 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 523 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 524 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 525 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 526 { 527 "code": "A String", # [Output Only] The error type identifier for this error. 528 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 529 "message": "A String", # [Output Only] An optional, human-readable error message. 530 }, 531 ], 532 }, 533 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 534 "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. 535 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 536 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 537 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 538 "name": "A String", # [Output Only] Name of the operation. 539 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 540 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 541 "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. 542 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 543 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 544 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 545 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 546 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 547 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 548 "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. 549 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 550 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 551 { 552 "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. 553 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 554 { 555 "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). 556 "value": "A String", # [Output Only] A warning data value corresponding to the key. 557 }, 558 ], 559 "message": "A String", # [Output Only] A human-readable description of the warning code. 560 }, 561 ], 562 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 563}</pre> 564</div> 565 566<div class="method"> 567 <code class="details" id="setSslPolicy">setSslPolicy(project, targetSslProxy, body=None, requestId=None, x__xgafv=None)</code> 568 <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. 569 570Args: 571 project: string, Project ID for this request. (required) 572 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) 573 body: object, The request body. 574 The object takes the form of: 575 576{ 577 "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. 578} 579 580 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 581 x__xgafv: string, V1 error format. 582 Allowed values 583 1 - v1 error format 584 2 - v2 error format 585 586Returns: 587 An object of the form: 588 589 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 590 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 591 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 592 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 593 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 594 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 595 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 596 { 597 "code": "A String", # [Output Only] The error type identifier for this error. 598 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 599 "message": "A String", # [Output Only] An optional, human-readable error message. 600 }, 601 ], 602 }, 603 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 604 "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. 605 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 606 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 607 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 608 "name": "A String", # [Output Only] Name of the operation. 609 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 610 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 611 "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. 612 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 613 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 614 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 615 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 616 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 617 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 618 "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. 619 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 620 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 621 { 622 "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. 623 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 624 { 625 "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). 626 "value": "A String", # [Output Only] A warning data value corresponding to the key. 627 }, 628 ], 629 "message": "A String", # [Output Only] A human-readable description of the warning code. 630 }, 631 ], 632 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 633}</pre> 634</div> 635 636</body></html>