| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionNotificationEndpoints.html">regionNotificationEndpoints</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 81 | <code><a href="#delete">delete(project, region, notificationEndpoint, requestId=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 82 | <p class="firstline">Deletes the specified NotificationEndpoint in the given region</p> |
| 83 | <p class="toc_element"> |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 84 | <code><a href="#get">get(project, region, notificationEndpoint)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 85 | <p class="firstline">Returns the specified NotificationEndpoint resource in the given region.</p> |
| 86 | <p class="toc_element"> |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 87 | <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 88 | <p class="firstline">Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.</p> |
| 89 | <p class="toc_element"> |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 90 | <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 91 | <p class="firstline">Lists the NotificationEndpoints for a project in the given region.</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> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 95 | <p class="toc_element"> |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 96 | <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 97 | <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 100 | <code class="details" id="close">close()</code> |
| 101 | <pre>Close httplib2 connections.</pre> |
| 102 | </div> |
| 103 | |
| 104 | <div class="method"> |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 105 | <code class="details" id="delete">delete(project, region, notificationEndpoint, requestId=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 106 | <pre>Deletes the specified NotificationEndpoint in the given region |
| 107 | |
| 108 | Args: |
| 109 | project: string, Project ID for this request. (required) |
| 110 | region: string, Name of the region scoping this request. (required) |
| 111 | notificationEndpoint: string, Name of the NotificationEndpoint resource to delete. (required) |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 112 | 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. |
| 113 | |
| 114 | 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. |
| 115 | |
| 116 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 117 | |
| 118 | Returns: |
| 119 | An object of the form: |
| 120 | |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 121 | { # Represents an Operation resource. |
| 122 | # |
| 123 | # Google Compute Engine has three Operation resources: |
| 124 | # |
| 125 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 126 | # |
| 127 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 128 | # |
| 129 | # Operations can be global, regional or zonal. |
| 130 | # - For global operations, use the `globalOperations` resource. |
| 131 | # - For regional operations, use the `regionOperations` resource. |
| 132 | # - For zonal operations, use the `zonalOperations` resource. |
| 133 | # |
| 134 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 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 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 138 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 139 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 140 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 142 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 143 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 144 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 145 | }, |
| 146 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 147 | }, |
| 148 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 149 | "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. |
| 150 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 151 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 152 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 153 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 154 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 155 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 156 | "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. |
| 157 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 158 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 159 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 160 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 161 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 162 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 163 | "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. |
| 164 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 165 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 166 | { |
| 167 | "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. |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 168 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 169 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 170 | { |
| 171 | "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). |
| 172 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 173 | }, |
| 174 | ], |
| 175 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 176 | }, |
| 177 | ], |
| 178 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 179 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 180 | </div> |
| 181 | |
| 182 | <div class="method"> |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 183 | <code class="details" id="get">get(project, region, notificationEndpoint)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 184 | <pre>Returns the specified NotificationEndpoint resource in the given region. |
| 185 | |
| 186 | Args: |
| 187 | project: string, Project ID for this request. (required) |
| 188 | region: string, Name of the region scoping this request. (required) |
| 189 | notificationEndpoint: string, Name of the NotificationEndpoint resource to return. (required) |
| 190 | |
| 191 | Returns: |
| 192 | An object of the form: |
| 193 | |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 194 | { # Represents a notification endpoint. |
| 195 | # |
| 196 | # A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. |
| 197 | # |
| 198 | # For more information, see Health checks overview. (== resource_for {$api_version}.notificationEndpoint ==) (== resource_for {$api_version}.regionNotificationEndpoints ==) |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 199 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 200 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 201 | "grpcSettings": { # Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint. # Settings of the gRPC notification endpoint including the endpoint URL and the retry duration. |
| 202 | "authority": "A String", # Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3 |
| 203 | "endpoint": "A String", # Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name. |
| 204 | "payloadName": "A String", # Optional. If specified, this field is used to populate the "name" field in gRPC requests. |
| 205 | "resendInterval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. |
| 206 | "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. |
| 207 | "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 208 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 209 | "retryDurationSec": 42, # How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number. |
| 210 | }, |
| 211 | "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. |
| 212 | "kind": "compute#notificationEndpoint", # [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints. |
| 213 | "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. |
| 214 | "region": "A String", # [Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 215 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 216 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 217 | </div> |
| 218 | |
| 219 | <div class="method"> |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 220 | <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 221 | <pre>Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request. |
| 222 | |
| 223 | Args: |
| 224 | project: string, Project ID for this request. (required) |
| 225 | region: string, Name of the region scoping this request. (required) |
| 226 | body: object, The request body. |
| 227 | The object takes the form of: |
| 228 | |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 229 | { # Represents a notification endpoint. |
| 230 | # |
| 231 | # A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. |
| 232 | # |
| 233 | # For more information, see Health checks overview. (== resource_for {$api_version}.notificationEndpoint ==) (== resource_for {$api_version}.regionNotificationEndpoints ==) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 234 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 235 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 236 | "grpcSettings": { # Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint. # Settings of the gRPC notification endpoint including the endpoint URL and the retry duration. |
| 237 | "authority": "A String", # Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3 |
| 238 | "endpoint": "A String", # Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name. |
| 239 | "payloadName": "A String", # Optional. If specified, this field is used to populate the "name" field in gRPC requests. |
| 240 | "resendInterval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. |
| 241 | "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. |
| 242 | "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
| 243 | }, |
| 244 | "retryDurationSec": 42, # How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number. |
| 245 | }, |
| 246 | "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. |
| 247 | "kind": "compute#notificationEndpoint", # [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints. |
| 248 | "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. |
| 249 | "region": "A String", # [Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 250 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 251 | } |
| 252 | |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 253 | 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. |
| 254 | |
| 255 | 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. |
| 256 | |
| 257 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 258 | |
| 259 | Returns: |
| 260 | An object of the form: |
| 261 | |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 262 | { # Represents an Operation resource. |
| 263 | # |
| 264 | # Google Compute Engine has three Operation resources: |
| 265 | # |
| 266 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 267 | # |
| 268 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 269 | # |
| 270 | # Operations can be global, regional or zonal. |
| 271 | # - For global operations, use the `globalOperations` resource. |
| 272 | # - For regional operations, use the `regionOperations` resource. |
| 273 | # - For zonal operations, use the `zonalOperations` resource. |
| 274 | # |
| 275 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 276 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 277 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 278 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 279 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 280 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 281 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 282 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 283 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 284 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 285 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 286 | }, |
| 287 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 288 | }, |
| 289 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 290 | "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. |
| 291 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 292 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 293 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 294 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 295 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 296 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 297 | "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. |
| 298 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 299 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 300 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 301 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 302 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 303 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 304 | "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. |
| 305 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 306 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 307 | { |
| 308 | "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. |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 309 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 310 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 311 | { |
| 312 | "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). |
| 313 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 314 | }, |
| 315 | ], |
| 316 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 317 | }, |
| 318 | ], |
| 319 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 320 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 321 | </div> |
| 322 | |
| 323 | <div class="method"> |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 324 | <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 325 | <pre>Lists the NotificationEndpoints for a project in the given region. |
| 326 | |
| 327 | Args: |
| 328 | project: string, Project ID for this request. (required) |
| 329 | region: string, Name of the region scoping this request. (required) |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 330 | 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 `<`. |
| 331 | |
| 332 | For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. |
| 333 | |
| 334 | 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. |
| 335 | |
| 336 | 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) ``` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 337 | 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`) |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 338 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| 339 | |
| 340 | 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. |
| 341 | |
| 342 | Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 343 | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 344 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 345 | |
| 346 | Returns: |
| 347 | An object of the form: |
| 348 | |
| 349 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 350 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 351 | "items": [ # A list of NotificationEndpoint resources. |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 352 | { # Represents a notification endpoint. |
| 353 | # |
| 354 | # A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. |
| 355 | # |
| 356 | # For more information, see Health checks overview. (== resource_for {$api_version}.notificationEndpoint ==) (== resource_for {$api_version}.regionNotificationEndpoints ==) |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 357 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 358 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 359 | "grpcSettings": { # Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint. # Settings of the gRPC notification endpoint including the endpoint URL and the retry duration. |
| 360 | "authority": "A String", # Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3 |
| 361 | "endpoint": "A String", # Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name. |
| 362 | "payloadName": "A String", # Optional. If specified, this field is used to populate the "name" field in gRPC requests. |
| 363 | "resendInterval": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. |
| 364 | "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. |
| 365 | "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 366 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 367 | "retryDurationSec": 42, # How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number. |
| 368 | }, |
| 369 | "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. |
| 370 | "kind": "compute#notificationEndpoint", # [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints. |
| 371 | "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. |
| 372 | "region": "A String", # [Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
| 373 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 374 | }, |
| 375 | ], |
| 376 | "kind": "compute#notificationEndpointList", # [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints. |
| 377 | "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. |
| 378 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 379 | "warning": { # [Output Only] Informational warning message. |
| 380 | "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. |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 381 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 382 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 383 | { |
| 384 | "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). |
| 385 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 386 | }, |
| 387 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 388 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 389 | }, |
| 390 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 391 | </div> |
| 392 | |
| 393 | <div class="method"> |
| 394 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 395 | <pre>Retrieves the next page of results. |
| 396 | |
| 397 | Args: |
| 398 | previous_request: The request for the previous page. (required) |
| 399 | previous_response: The response from the request for the previous page. (required) |
| 400 | |
| 401 | Returns: |
| 402 | A request object that you can call 'execute()' on to request the next |
| 403 | page. Returns None if there are no more items in the collection. |
| 404 | </pre> |
| 405 | </div> |
| 406 | |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 407 | <div class="method"> |
| yoshi-code-bot | c3f8675 | 2021-06-12 00:20:02 -0700 | [diff] [blame^] | 408 | <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 409 | <pre>Returns permissions that a caller has on the specified resource. |
| 410 | |
| 411 | Args: |
| 412 | project: string, Project ID for this request. (required) |
| 413 | region: string, The name of the region for this request. (required) |
| 414 | resource: string, Name or id of the resource for this request. (required) |
| 415 | body: object, The request body. |
| 416 | The object takes the form of: |
| 417 | |
| 418 | { |
| 419 | "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. |
| 420 | "A String", |
| 421 | ], |
| 422 | } |
| 423 | |
| 424 | |
| 425 | Returns: |
| 426 | An object of the form: |
| 427 | |
| 428 | { |
| 429 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| 430 | "A String", |
| 431 | ], |
| 432 | }</pre> |
| 433 | </div> |
| 434 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 435 | </body></html> |