| 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.wireGroups.html">wireGroups</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, crossSiteNetwork, wireGroup, requestId=None, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Deletes the specified wire group in the given scope.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#get">get(project, crossSiteNetwork, wireGroup, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Gets the specified wire group resource in the given scope.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#insert">insert(project, crossSiteNetwork, body=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">Creates a wire group in the specified project in the given scope</p> |
| 89 |
<p class="toc_element"> |
| 90 |
<code><a href="#list">list(project, crossSiteNetwork, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| 91 |
<p class="firstline">Lists the wire groups for a project in the given scope.</p> |
| 92 |
<p class="toc_element"> |
| 93 |
<code><a href="#list_next">list_next()</a></code></p> |
| 94 |
<p class="firstline">Retrieves the next page of results.</p> |
| 95 |
<p class="toc_element"> |
| 96 |
<code><a href="#patch">patch(project, crossSiteNetwork, wireGroup, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p> |
| 97 |
<p class="firstline">Updates the specified wire group resource with the data included in the</p> |
| 98 |
<h3>Method Details</h3> |
| 99 |
<div class="method"> |
| 100 |
<code class="details" id="close">close()</code> |
| 101 |
<pre>Close httplib2 connections.</pre> |
| 102 |
</div> |
| 103 |
|
| 104 |
<div class="method"> |
| 105 |
<code class="details" id="delete">delete(project, crossSiteNetwork, wireGroup, requestId=None, x__xgafv=None)</code> |
| 106 |
<pre>Deletes the specified wire group in the given scope. |
| 107 |
|
| 108 |
Args: |
| 109 |
project: string, Project ID for this request. (required) |
| 110 |
crossSiteNetwork: string, A parameter (required) |
| 111 |
wireGroup: string, Name of the wire group resource to delete. (required) |
| 112 |
requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| 113 |
that if you must retry your request, the server will know to ignore the |
| 114 |
request if it has already been completed. |
| 115 |
|
| 116 |
For example, consider a situation where you make an initial request and |
| 117 |
the request times out. If you make the request again with the same |
| 118 |
request ID, the server can check if original operation with the same |
| 119 |
request ID was received, and if so, will ignore the second request. This |
| 120 |
prevents clients from accidentally creating duplicate commitments. |
| 121 |
|
| 122 |
The request ID must be |
| 123 |
a valid UUID with the exception that zero UUID is not supported |
| 124 |
(00000000-0000-0000-0000-000000000000). |
| 125 |
end_interface: MixerMutationRequestBuilder |
| 126 |
x__xgafv: string, V1 error format. |
| 127 |
Allowed values |
| 128 |
1 - v1 error format |
| 129 |
2 - v2 error format |
| 130 |
|
| 131 |
Returns: |
| 132 |
An object of the form: |
| 133 |
|
| 134 |
{ # Represents an Operation resource. |
| 135 |
# |
| 136 |
# Google Compute Engine has three Operation resources: |
| 137 |
# |
| 138 |
# * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| 139 |
# * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| 140 |
# * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| 141 |
# |
| 142 |
# You can use an operation resource to manage asynchronous API requests. |
| 143 |
# For more information, readHandling |
| 144 |
# API responses. |
| 145 |
# |
| 146 |
# Operations can be global, regional or zonal. |
| 147 |
# |
| 148 |
# - For global operations, use the `globalOperations` |
| 149 |
# resource. |
| 150 |
# - For regional operations, use the |
| 151 |
# `regionOperations` resource. |
| 152 |
# - For zonal operations, use |
| 153 |
# the `zoneOperations` resource. |
| 154 |
# |
| 155 |
# |
| 156 |
# |
| 157 |
# For more information, read |
| 158 |
# Global, Regional, and Zonal Resources. |
| 159 |
# |
| 160 |
# Note that completed Operation resources have a limited |
| 161 |
# retention period. |
| 162 |
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| 163 |
# Not present otherwise. |
| 164 |
"creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 165 |
"description": "A String", # [Output Only] A textual description of the operation, which is |
| 166 |
# set when the operation is created. |
| 167 |
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| 168 |
# text format. |
| 169 |
"error": { # [Output Only] If errors are generated during processing of the operation, |
| 170 |
# this field will be populated. |
| 171 |
"errors": [ # [Output Only] The array of errors encountered while processing this |
| 172 |
# operation. |
| 173 |
{ |
| 174 |
"code": "A String", # [Output Only] The error type identifier for this error. |
| 175 |
"errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| 176 |
# details. There is a set of defined message types to use for providing |
| 177 |
# details.The syntax depends on the error code. For example, |
| 178 |
# QuotaExceededInfo will have details when the error code is |
| 179 |
# QUOTA_EXCEEDED. |
| 180 |
{ |
| 181 |
"errorInfo": { # Describes the cause of the error with structured details. |
| 182 |
# |
| 183 |
# Example of an error when contacting the "pubsub.googleapis.com" API when it |
| 184 |
# is not enabled: |
| 185 |
# |
| 186 |
# { "reason": "API_DISABLED" |
| 187 |
# "domain": "googleapis.com" |
| 188 |
# "metadata": { |
| 189 |
# "resource": "projects/123", |
| 190 |
# "service": "pubsub.googleapis.com" |
| 191 |
# } |
| 192 |
# } |
| 193 |
# |
| 194 |
# This response indicates that the pubsub.googleapis.com API is not enabled. |
| 195 |
# |
| 196 |
# Example of an error that is returned when attempting to create a Spanner |
| 197 |
# instance in a region that is out of stock: |
| 198 |
# |
| 199 |
# { "reason": "STOCKOUT" |
| 200 |
# "domain": "spanner.googleapis.com", |
| 201 |
# "metadata": { |
| 202 |
# "availableRegions": "us-central1,us-east2" |
| 203 |
# } |
| 204 |
# } |
| 205 |
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| 206 |
# is typically the registered service name of the tool or product that |
| 207 |
# generates the error. Example: "pubsub.googleapis.com". If the error is |
| 208 |
# generated by some common infrastructure, the error domain must be a |
| 209 |
# globally unique value that identifies the infrastructure. For Google API |
| 210 |
# infrastructure, the error domain is "googleapis.com". |
| 211 |
"metadatas": { # Additional structured details about this error. |
| 212 |
# |
| 213 |
# Keys must match a regular expression of `a-z+` but should |
| 214 |
# ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| 215 |
# length. When identifying the current value of an exceeded limit, the units |
| 216 |
# should be contained in the key, not the value. For example, rather than |
| 217 |
# `{"instanceLimit": "100/request"}`, should be returned as, |
| 218 |
# `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| 219 |
# instances that can be created in a single (batch) request. |
| 220 |
"a_key": "A String", |
| 221 |
}, |
| 222 |
"reason": "A String", # The reason of the error. This is a constant value that identifies the |
| 223 |
# proximate cause of the error. Error reasons are unique within a particular |
| 224 |
# domain of errors. This should be at most 63 characters and match a |
| 225 |
# regular expression of `A-Z+[A-Z0-9]`, which represents |
| 226 |
# UPPER_SNAKE_CASE. |
| 227 |
}, |
| 228 |
"help": { # Provides links to documentation or for performing an out of band action. |
| 229 |
# |
| 230 |
# For example, if a quota check failed with an error indicating the calling |
| 231 |
# project hasn't enabled the accessed service, this can contain a URL pointing |
| 232 |
# directly to the right place in the developer console to flip the bit. |
| 233 |
"links": [ # URL(s) pointing to additional information on handling the current error. |
| 234 |
{ # Describes a URL link. |
| 235 |
"description": "A String", # Describes what the link offers. |
| 236 |
"url": "A String", # The URL of the link. |
| 237 |
}, |
| 238 |
], |
| 239 |
}, |
| 240 |
"localizedMessage": { # Provides a localized error message that is safe to return to the user |
| 241 |
# which can be attached to an RPC error. |
| 242 |
"locale": "A String", # The locale used following the specification defined at |
| 243 |
# https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| 244 |
# Examples are: "en-US", "fr-CH", "es-MX" |
| 245 |
"message": "A String", # The localized error message in the above locale. |
| 246 |
}, |
| 247 |
"quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| 248 |
"dimensions": { # The map holding related quota dimensions. |
| 249 |
"a_key": "A String", |
| 250 |
}, |
| 251 |
"futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| 252 |
# type or metric. |
| 253 |
"limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| 254 |
# or metric. |
| 255 |
"limitName": "A String", # The name of the quota limit. |
| 256 |
"metricName": "A String", # The Compute Engine quota metric name. |
| 257 |
"rolloutStatus": "A String", # Rollout status of the future quota limit. |
| 258 |
}, |
| 259 |
}, |
| 260 |
], |
| 261 |
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| 262 |
# This property is optional. |
| 263 |
"message": "A String", # [Output Only] An optional, human-readable error message. |
| 264 |
}, |
| 265 |
], |
| 266 |
}, |
| 267 |
"getVersionOperationMetadata": { |
| 268 |
"inlineSbomInfo": { |
| 269 |
"currentComponentVersions": { # A mapping of components to their currently-applied versions or other |
| 270 |
# appropriate identifiers. |
| 271 |
"a_key": "A String", |
| 272 |
}, |
| 273 |
"targetComponentVersions": { # A mapping of components to their target versions or other appropriate |
| 274 |
# identifiers. |
| 275 |
"a_key": "A String", |
| 276 |
}, |
| 277 |
}, |
| 278 |
}, |
| 279 |
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| 280 |
# message that was returned, such as `NOT FOUND`. |
| 281 |
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error |
| 282 |
# status code that was returned. For example, a `404` means the |
| 283 |
# resource was not found. |
| 284 |
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| 285 |
# defined by the server. |
| 286 |
"insertTime": "A String", # [Output Only] The time that this operation was requested. |
| 287 |
# This value is inRFC3339 |
| 288 |
# text format. |
| 289 |
"instancesBulkInsertOperationMetadata": { |
| 290 |
"perLocationStatus": { # Status information per location (location name is key). |
| 291 |
# Example key: zones/us-central1-a |
| 292 |
"a_key": { |
| 293 |
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| 294 |
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| 295 |
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| 296 |
# error. |
| 297 |
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| 298 |
# if the flow is rolling forward or rolling back. |
| 299 |
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| 300 |
}, |
| 301 |
}, |
| 302 |
}, |
| 303 |
"kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| 304 |
# Operation resources. |
| 305 |
"name": "A String", # [Output Only] Name of the operation. |
| 306 |
"operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| 307 |
# group of operations results from a `bulkInsert` API request. |
| 308 |
"operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| 309 |
# `update`, or `delete`, and so on. |
| 310 |
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. |
| 311 |
# There is no requirement that this be linear or support any granularity of |
| 312 |
# operations. This should not be used to guess when the operation will be |
| 313 |
# complete. This number should monotonically increase as the operation |
| 314 |
# progresses. |
| 315 |
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| 316 |
# applicable when performing regional operations. |
| 317 |
"selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 318 |
"setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| 319 |
# this field will contain information on all underlying zonal actions and |
| 320 |
# their state. |
| 321 |
"clientOperationId": "A String", # [Output Only] The client operation id. |
| 322 |
"perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| 323 |
# Example key: zones/us-central1-a |
| 324 |
"a_key": { |
| 325 |
"error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| 326 |
# populated. |
| 327 |
# different programming environments, including REST APIs and RPC APIs. It is |
| 328 |
# used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 329 |
# three pieces of data: error code, error message, and error details. |
| 330 |
# |
| 331 |
# You can find out more about this error model and how to work with it in the |
| 332 |
# [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 333 |
"code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 334 |
"details": [ # A list of messages that carry the error details. There is a common set of |
| 335 |
# message types for APIs to use. |
| 336 |
{ |
| 337 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 338 |
}, |
| 339 |
], |
| 340 |
"message": "A String", # A developer-facing error message, which should be in English. Any |
| 341 |
# user-facing error message should be localized and sent in the |
| 342 |
# google.rpc.Status.details field, or localized by the client. |
| 343 |
}, |
| 344 |
"state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| 345 |
# `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| 346 |
}, |
| 347 |
}, |
| 348 |
}, |
| 349 |
"startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| 350 |
# This value is inRFC3339 |
| 351 |
# text format. |
| 352 |
"status": "A String", # [Output Only] The status of the operation, which can be one of the |
| 353 |
# following: |
| 354 |
# `PENDING`, `RUNNING`, or `DONE`. |
| 355 |
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| 356 |
# operation. |
| 357 |
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| 358 |
# of the target resource. |
| 359 |
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| 360 |
# operations related to creating a snapshot, this points to the disk |
| 361 |
# that the snapshot was created from. |
| 362 |
"user": "A String", # [Output Only] User who requested the operation, for example: |
| 363 |
# `[email protected]` or |
| 364 |
# `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| 365 |
"warnings": [ # [Output Only] If warning messages are generated during processing of the |
| 366 |
# operation, this field will be populated. |
| 367 |
{ |
| 368 |
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| 369 |
# Engine returns NO_RESULTS_ON_PAGE if there |
| 370 |
# are no results in the response. |
| 371 |
"data": [ # [Output Only] Metadata about this warning in key: |
| 372 |
# value format. For example: |
| 373 |
# |
| 374 |
# "data": [ |
| 375 |
# { |
| 376 |
# "key": "scope", |
| 377 |
# "value": "zones/us-east1-d" |
| 378 |
# } |
| 379 |
{ |
| 380 |
"key": "A String", # [Output Only] A key that provides more detail on the warning being |
| 381 |
# returned. For example, for warnings where there are no results in a list |
| 382 |
# request for a particular zone, this key might be scope and |
| 383 |
# the key value might be the zone name. Other examples might be a key |
| 384 |
# indicating a deprecated resource and a suggested replacement, or a |
| 385 |
# warning about invalid network settings (for example, if an instance |
| 386 |
# attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 387 |
"value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 388 |
}, |
| 389 |
], |
| 390 |
"message": "A String", # [Output Only] A human-readable description of the warning code. |
| 391 |
}, |
| 392 |
], |
| 393 |
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| 394 |
# applicable when performing per-zone operations. |
| 395 |
}</pre> |
| 396 |
</div> |
| 397 |
|
| 398 |
<div class="method"> |
| 399 |
<code class="details" id="get">get(project, crossSiteNetwork, wireGroup, x__xgafv=None)</code> |
| 400 |
<pre>Gets the specified wire group resource in the given scope. |
| 401 |
|
| 402 |
Args: |
| 403 |
project: string, Project ID for this request. (required) |
| 404 |
crossSiteNetwork: string, A parameter (required) |
| 405 |
wireGroup: string, Name of the wire group resource to return. (required) |
| 406 |
x__xgafv: string, V1 error format. |
| 407 |
Allowed values |
| 408 |
1 - v1 error format |
| 409 |
2 - v2 error format |
| 410 |
|
| 411 |
Returns: |
| 412 |
An object of the form: |
| 413 |
|
| 414 |
{ # A resource that represents a group of redundant wires. |
| 415 |
"adminEnabled": True or False, # Indicates whether the wires in the wire group are enabled. When false, the |
| 416 |
# wires in the wire group are disabled. When true and when |
| 417 |
# there is simultaneously no wire-specific override of `adminEnabled` to |
| 418 |
# false, a given wire is enabled. Defaults to true. |
| 419 |
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 |
| 420 |
# text format. |
| 421 |
"description": "A String", # An optional description of the wire group. |
| 422 |
"endpoints": { # A map that contains the logical endpoints of the wire group. Specify |
| 423 |
# key-value pairs for the map as follows: |
| 424 |
# |
| 425 |
# - Key: an RFC1035 user-specified label. |
| 426 |
# - Value: an Endpoint object. |
| 427 |
"a_key": { # A logical endpoint for the wire group. An endpoint represents a metro that |
| 428 |
# contains redundant Interconnect connections. A wire group is created |
| 429 |
# between two endpoints. |
| 430 |
"interconnects": { # A map that contains the redundant Interconnect connections. Specify |
| 431 |
# key-value pairs for the map as follows: |
| 432 |
# |
| 433 |
# - Key: an RFC1035 user-specified label. |
| 434 |
# - Value: an Interconnect object. |
| 435 |
"a_key": { # The redundant Interconnect connections for this endpoint. |
| 436 |
"interconnect": "A String", # Required. An Interconnect connection. You can specify the connection as |
| 437 |
# a partial or full URL. If the connection is in a different project from |
| 438 |
# the cross-site network, use a format that specifies the project. See |
| 439 |
# the following examples of partial and full URLs: |
| 440 |
# |
| 441 |
# |
| 442 |
# |
| 443 |
# global/interconnects/NAME |
| 444 |
# |
| 445 |
# |
| 446 |
# projects/PROJECT_ID/global/interconnects/NAME |
| 447 |
# |
| 448 |
# - |
| 449 |
# https://compute.googleapis.com/compute/projects/PROJECT_ID/global/interconnects/NAME |
| 450 |
"vlanTags": [ # Required. To configure the wire group for VLAN mode, enter a VLAN tag, |
| 451 |
# which is a number from `2` to `4093`. You can autoallocate a tag by |
| 452 |
# entering `0`. To configure the wire group for port mode, enter `-1`. |
| 453 |
# Review the following guidelines: |
| 454 |
# |
| 455 |
# - A VLAN tag must be unique for an Interconnect connection across all |
| 456 |
# attachments and wire groups. |
| 457 |
# - Both endpoints of a wire must use the same VLAN tag value. |
| 458 |
# - Single wire and redundant type wire groups must have only one |
| 459 |
# VLAN tag. |
| 460 |
# - Port mode pseudowires must have a single VLAN tag with a value of |
| 461 |
# `-1` for both endpoints. |
| 462 |
# - Box and cross type wire groups must have two VLAN tags. The first |
| 463 |
# is for the same-zone pseudowire, and the second is for the cross-zone |
| 464 |
# pseudowire. |
| 465 |
42, |
| 466 |
], |
| 467 |
}, |
| 468 |
}, |
| 469 |
}, |
| 470 |
}, |
| 471 |
"id": "A String", # Output only. [Output Only] The unique identifier for the resource type. The server |
| 472 |
# generates this identifier. |
| 473 |
"kind": "compute#wireGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups. |
| 474 |
"name": "A String", # Name of the resource. Provided by the client when the resource is created. |
| 475 |
# The name must be 1-63 characters long, and comply withRFC1035. |
| 476 |
# Specifically, the name must be 1-63 characters long and match the regular |
| 477 |
# expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first |
| 478 |
# character must be a lowercase letter, and all following characters must |
| 479 |
# be a dash, lowercase letter, or digit, except the last character, which |
| 480 |
# cannot be a dash. |
| 481 |
"reconciling": True or False, # Output only. [Output Only] Indicates whether there are wire changes yet to be processed. |
| 482 |
"selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. |
| 483 |
"topology": { # Topology details for the wire group. # Output only. Topology details for the wire group configuration. |
| 484 |
"endpoints": [ # Output only. Topology details for all endpoints in the wire group. |
| 485 |
{ # Topology details for a single wire group endpoint. |
| 486 |
"city": "A String", # Output only. The InterconnectLocation.city (metropolitan area designator) that all |
| 487 |
# interconnects are located in. |
| 488 |
"label": "A String", # Output only. Endpoint label from the wire group. |
| 489 |
}, |
| 490 |
], |
| 491 |
}, |
| 492 |
"wireGroupProperties": { # The properties of a wire group. These properties # Properties of the wire group. |
| 493 |
# determine how a group of redundant wires are created and managed. |
| 494 |
"type": "A String", # The type of the wire group, one of the following: |
| 495 |
# |
| 496 |
# - WIRE: a single pseudowire over two Interconnect connections with no |
| 497 |
# redundancy. |
| 498 |
# - REDUNDANT: two pseudowires over four Interconnect connections, with |
| 499 |
# two connections in one metro and two connections in another metro. |
| 500 |
# Each redundant pair of Interconnect connections spans both edge |
| 501 |
# availability domains of the metro. Each pseudowire connects Interconnect |
| 502 |
# connections in matching edge availability domains of the two metros. |
| 503 |
# - BOX_AND_CROSS: four pseudowires over four Interconnect connections, |
| 504 |
# with two connections in one metro and two connections in another metro. |
| 505 |
# Each redundant pair of Interconnect connections spans both edge |
| 506 |
# availability domains of the metro. Two pseudowires connect Interconnect |
| 507 |
# connections in matching edge availability domains of the two metros. |
| 508 |
# Two additional pseudowires connect the non-matching edge availability |
| 509 |
# domains of the two metros. |
| 510 |
}, |
| 511 |
"wireProperties": { # The properties of a wire. # Properties for all wires in the wire group. |
| 512 |
"bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: |
| 513 |
# |
| 514 |
# - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation |
| 515 |
# (and associated charges) for each wire in the group. |
| 516 |
# - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures |
| 517 |
# one unmetered bandwidth allocation for the wire group. The unmetered |
| 518 |
# bandwidth is divided equally across each wire in the group, but dynamic |
| 519 |
# throttling reallocates unused unmetered bandwidth from unused or underused |
| 520 |
# wires to other wires in the group. |
| 521 |
"bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` |
| 522 |
# is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0. |
| 523 |
"faultResponse": "A String", # Response when a fault is detected in a pseudowire: |
| 524 |
# |
| 525 |
# - NONE: default. |
| 526 |
# - DISABLE_PORT: set the port line protocol down when inline probes |
| 527 |
# detect a fault. This setting is only permitted on port mode |
| 528 |
# pseudowires. |
| 529 |
}, |
| 530 |
"wires": [ # Output only. The single/redundant wire(s) managed by the wire group. |
| 531 |
{ # A pseudowire that connects two Interconnect connections. |
| 532 |
"adminEnabled": True or False, # Output only. [Output Only] Indicates whether the wire is enabled. |
| 533 |
# When false, the wire is disabled. When true and when the wire group of |
| 534 |
# the wire is also enabled, the wire is enabled. Defaults to true. |
| 535 |
"endpoints": [ # Output only. Wire endpoints are specific Interconnect connections. |
| 536 |
{ # Wire endpoints are specific Interconnect connections. |
| 537 |
"interconnect": "A String", |
| 538 |
"vlanTag": 42, |
| 539 |
}, |
| 540 |
], |
| 541 |
"label": "A String", # Output only. [Output Only] A label that identifies the wire. The format of this label |
| 542 |
# combines the existing labels of the wire group endpoints and Interconnect |
| 543 |
# connections used by this wire in alphabetical order as follows: |
| 544 |
# `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where: |
| 545 |
# |
| 546 |
# - ENDPOINT_A and ENDPOINT_B: are the labels |
| 547 |
# that you entered as map keys when you specified the wire group endpoint |
| 548 |
# objects. |
| 549 |
# - CONNECTION_A1 and CONNECTION_B1: are the |
| 550 |
# labels that you entered as map keys when you specified the wire group |
| 551 |
# Interconnect objects. |
| 552 |
"wireProperties": { # The properties of a wire. # Output only. [Output Only] Properties of the wire. |
| 553 |
"bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: |
| 554 |
# |
| 555 |
# - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation |
| 556 |
# (and associated charges) for each wire in the group. |
| 557 |
# - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures |
| 558 |
# one unmetered bandwidth allocation for the wire group. The unmetered |
| 559 |
# bandwidth is divided equally across each wire in the group, but dynamic |
| 560 |
# throttling reallocates unused unmetered bandwidth from unused or underused |
| 561 |
# wires to other wires in the group. |
| 562 |
"bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` |
| 563 |
# is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0. |
| 564 |
"faultResponse": "A String", # Response when a fault is detected in a pseudowire: |
| 565 |
# |
| 566 |
# - NONE: default. |
| 567 |
# - DISABLE_PORT: set the port line protocol down when inline probes |
| 568 |
# detect a fault. This setting is only permitted on port mode |
| 569 |
# pseudowires. |
| 570 |
}, |
| 571 |
}, |
| 572 |
], |
| 573 |
}</pre> |
| 574 |
</div> |
| 575 |
|
| 576 |
<div class="method"> |
| 577 |
<code class="details" id="insert">insert(project, crossSiteNetwork, body=None, requestId=None, validateOnly=None, x__xgafv=None)</code> |
| 578 |
<pre>Creates a wire group in the specified project in the given scope |
| 579 |
using the parameters that are included in the request. |
| 580 |
|
| 581 |
Args: |
| 582 |
project: string, Project ID for this request. (required) |
| 583 |
crossSiteNetwork: string, A parameter (required) |
| 584 |
body: object, The request body. |
| 585 |
The object takes the form of: |
| 586 |
|
| 587 |
{ # A resource that represents a group of redundant wires. |
| 588 |
"adminEnabled": True or False, # Indicates whether the wires in the wire group are enabled. When false, the |
| 589 |
# wires in the wire group are disabled. When true and when |
| 590 |
# there is simultaneously no wire-specific override of `adminEnabled` to |
| 591 |
# false, a given wire is enabled. Defaults to true. |
| 592 |
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 |
| 593 |
# text format. |
| 594 |
"description": "A String", # An optional description of the wire group. |
| 595 |
"endpoints": { # A map that contains the logical endpoints of the wire group. Specify |
| 596 |
# key-value pairs for the map as follows: |
| 597 |
# |
| 598 |
# - Key: an RFC1035 user-specified label. |
| 599 |
# - Value: an Endpoint object. |
| 600 |
"a_key": { # A logical endpoint for the wire group. An endpoint represents a metro that |
| 601 |
# contains redundant Interconnect connections. A wire group is created |
| 602 |
# between two endpoints. |
| 603 |
"interconnects": { # A map that contains the redundant Interconnect connections. Specify |
| 604 |
# key-value pairs for the map as follows: |
| 605 |
# |
| 606 |
# - Key: an RFC1035 user-specified label. |
| 607 |
# - Value: an Interconnect object. |
| 608 |
"a_key": { # The redundant Interconnect connections for this endpoint. |
| 609 |
"interconnect": "A String", # Required. An Interconnect connection. You can specify the connection as |
| 610 |
# a partial or full URL. If the connection is in a different project from |
| 611 |
# the cross-site network, use a format that specifies the project. See |
| 612 |
# the following examples of partial and full URLs: |
| 613 |
# |
| 614 |
# |
| 615 |
# |
| 616 |
# global/interconnects/NAME |
| 617 |
# |
| 618 |
# |
| 619 |
# projects/PROJECT_ID/global/interconnects/NAME |
| 620 |
# |
| 621 |
# - |
| 622 |
# https://compute.googleapis.com/compute/projects/PROJECT_ID/global/interconnects/NAME |
| 623 |
"vlanTags": [ # Required. To configure the wire group for VLAN mode, enter a VLAN tag, |
| 624 |
# which is a number from `2` to `4093`. You can autoallocate a tag by |
| 625 |
# entering `0`. To configure the wire group for port mode, enter `-1`. |
| 626 |
# Review the following guidelines: |
| 627 |
# |
| 628 |
# - A VLAN tag must be unique for an Interconnect connection across all |
| 629 |
# attachments and wire groups. |
| 630 |
# - Both endpoints of a wire must use the same VLAN tag value. |
| 631 |
# - Single wire and redundant type wire groups must have only one |
| 632 |
# VLAN tag. |
| 633 |
# - Port mode pseudowires must have a single VLAN tag with a value of |
| 634 |
# `-1` for both endpoints. |
| 635 |
# - Box and cross type wire groups must have two VLAN tags. The first |
| 636 |
# is for the same-zone pseudowire, and the second is for the cross-zone |
| 637 |
# pseudowire. |
| 638 |
42, |
| 639 |
], |
| 640 |
}, |
| 641 |
}, |
| 642 |
}, |
| 643 |
}, |
| 644 |
"id": "A String", # Output only. [Output Only] The unique identifier for the resource type. The server |
| 645 |
# generates this identifier. |
| 646 |
"kind": "compute#wireGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups. |
| 647 |
"name": "A String", # Name of the resource. Provided by the client when the resource is created. |
| 648 |
# The name must be 1-63 characters long, and comply withRFC1035. |
| 649 |
# Specifically, the name must be 1-63 characters long and match the regular |
| 650 |
# expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first |
| 651 |
# character must be a lowercase letter, and all following characters must |
| 652 |
# be a dash, lowercase letter, or digit, except the last character, which |
| 653 |
# cannot be a dash. |
| 654 |
"reconciling": True or False, # Output only. [Output Only] Indicates whether there are wire changes yet to be processed. |
| 655 |
"selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. |
| 656 |
"topology": { # Topology details for the wire group. # Output only. Topology details for the wire group configuration. |
| 657 |
"endpoints": [ # Output only. Topology details for all endpoints in the wire group. |
| 658 |
{ # Topology details for a single wire group endpoint. |
| 659 |
"city": "A String", # Output only. The InterconnectLocation.city (metropolitan area designator) that all |
| 660 |
# interconnects are located in. |
| 661 |
"label": "A String", # Output only. Endpoint label from the wire group. |
| 662 |
}, |
| 663 |
], |
| 664 |
}, |
| 665 |
"wireGroupProperties": { # The properties of a wire group. These properties # Properties of the wire group. |
| 666 |
# determine how a group of redundant wires are created and managed. |
| 667 |
"type": "A String", # The type of the wire group, one of the following: |
| 668 |
# |
| 669 |
# - WIRE: a single pseudowire over two Interconnect connections with no |
| 670 |
# redundancy. |
| 671 |
# - REDUNDANT: two pseudowires over four Interconnect connections, with |
| 672 |
# two connections in one metro and two connections in another metro. |
| 673 |
# Each redundant pair of Interconnect connections spans both edge |
| 674 |
# availability domains of the metro. Each pseudowire connects Interconnect |
| 675 |
# connections in matching edge availability domains of the two metros. |
| 676 |
# - BOX_AND_CROSS: four pseudowires over four Interconnect connections, |
| 677 |
# with two connections in one metro and two connections in another metro. |
| 678 |
# Each redundant pair of Interconnect connections spans both edge |
| 679 |
# availability domains of the metro. Two pseudowires connect Interconnect |
| 680 |
# connections in matching edge availability domains of the two metros. |
| 681 |
# Two additional pseudowires connect the non-matching edge availability |
| 682 |
# domains of the two metros. |
| 683 |
}, |
| 684 |
"wireProperties": { # The properties of a wire. # Properties for all wires in the wire group. |
| 685 |
"bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: |
| 686 |
# |
| 687 |
# - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation |
| 688 |
# (and associated charges) for each wire in the group. |
| 689 |
# - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures |
| 690 |
# one unmetered bandwidth allocation for the wire group. The unmetered |
| 691 |
# bandwidth is divided equally across each wire in the group, but dynamic |
| 692 |
# throttling reallocates unused unmetered bandwidth from unused or underused |
| 693 |
# wires to other wires in the group. |
| 694 |
"bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` |
| 695 |
# is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0. |
| 696 |
"faultResponse": "A String", # Response when a fault is detected in a pseudowire: |
| 697 |
# |
| 698 |
# - NONE: default. |
| 699 |
# - DISABLE_PORT: set the port line protocol down when inline probes |
| 700 |
# detect a fault. This setting is only permitted on port mode |
| 701 |
# pseudowires. |
| 702 |
}, |
| 703 |
"wires": [ # Output only. The single/redundant wire(s) managed by the wire group. |
| 704 |
{ # A pseudowire that connects two Interconnect connections. |
| 705 |
"adminEnabled": True or False, # Output only. [Output Only] Indicates whether the wire is enabled. |
| 706 |
# When false, the wire is disabled. When true and when the wire group of |
| 707 |
# the wire is also enabled, the wire is enabled. Defaults to true. |
| 708 |
"endpoints": [ # Output only. Wire endpoints are specific Interconnect connections. |
| 709 |
{ # Wire endpoints are specific Interconnect connections. |
| 710 |
"interconnect": "A String", |
| 711 |
"vlanTag": 42, |
| 712 |
}, |
| 713 |
], |
| 714 |
"label": "A String", # Output only. [Output Only] A label that identifies the wire. The format of this label |
| 715 |
# combines the existing labels of the wire group endpoints and Interconnect |
| 716 |
# connections used by this wire in alphabetical order as follows: |
| 717 |
# `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where: |
| 718 |
# |
| 719 |
# - ENDPOINT_A and ENDPOINT_B: are the labels |
| 720 |
# that you entered as map keys when you specified the wire group endpoint |
| 721 |
# objects. |
| 722 |
# - CONNECTION_A1 and CONNECTION_B1: are the |
| 723 |
# labels that you entered as map keys when you specified the wire group |
| 724 |
# Interconnect objects. |
| 725 |
"wireProperties": { # The properties of a wire. # Output only. [Output Only] Properties of the wire. |
| 726 |
"bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: |
| 727 |
# |
| 728 |
# - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation |
| 729 |
# (and associated charges) for each wire in the group. |
| 730 |
# - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures |
| 731 |
# one unmetered bandwidth allocation for the wire group. The unmetered |
| 732 |
# bandwidth is divided equally across each wire in the group, but dynamic |
| 733 |
# throttling reallocates unused unmetered bandwidth from unused or underused |
| 734 |
# wires to other wires in the group. |
| 735 |
"bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` |
| 736 |
# is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0. |
| 737 |
"faultResponse": "A String", # Response when a fault is detected in a pseudowire: |
| 738 |
# |
| 739 |
# - NONE: default. |
| 740 |
# - DISABLE_PORT: set the port line protocol down when inline probes |
| 741 |
# detect a fault. This setting is only permitted on port mode |
| 742 |
# pseudowires. |
| 743 |
}, |
| 744 |
}, |
| 745 |
], |
| 746 |
} |
| 747 |
|
| 748 |
requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| 749 |
that if you must retry your request, the server will know to ignore the |
| 750 |
request if it has already been completed. |
| 751 |
|
| 752 |
For example, consider a situation where you make an initial request and |
| 753 |
the request times out. If you make the request again with the same |
| 754 |
request ID, the server can check if original operation with the same |
| 755 |
request ID was received, and if so, will ignore the second request. This |
| 756 |
prevents clients from accidentally creating duplicate commitments. |
| 757 |
|
| 758 |
The request ID must be |
| 759 |
a valid UUID with the exception that zero UUID is not supported |
| 760 |
(00000000-0000-0000-0000-000000000000). |
| 761 |
end_interface: MixerMutationRequestBuilder |
| 762 |
validateOnly: boolean, [Input Only] Validate the new configuration, but don't create it. |
| 763 |
x__xgafv: string, V1 error format. |
| 764 |
Allowed values |
| 765 |
1 - v1 error format |
| 766 |
2 - v2 error format |
| 767 |
|
| 768 |
Returns: |
| 769 |
An object of the form: |
| 770 |
|
| 771 |
{ # Represents an Operation resource. |
| 772 |
# |
| 773 |
# Google Compute Engine has three Operation resources: |
| 774 |
# |
| 775 |
# * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| 776 |
# * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| 777 |
# * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| 778 |
# |
| 779 |
# You can use an operation resource to manage asynchronous API requests. |
| 780 |
# For more information, readHandling |
| 781 |
# API responses. |
| 782 |
# |
| 783 |
# Operations can be global, regional or zonal. |
| 784 |
# |
| 785 |
# - For global operations, use the `globalOperations` |
| 786 |
# resource. |
| 787 |
# - For regional operations, use the |
| 788 |
# `regionOperations` resource. |
| 789 |
# - For zonal operations, use |
| 790 |
# the `zoneOperations` resource. |
| 791 |
# |
| 792 |
# |
| 793 |
# |
| 794 |
# For more information, read |
| 795 |
# Global, Regional, and Zonal Resources. |
| 796 |
# |
| 797 |
# Note that completed Operation resources have a limited |
| 798 |
# retention period. |
| 799 |
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| 800 |
# Not present otherwise. |
| 801 |
"creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 802 |
"description": "A String", # [Output Only] A textual description of the operation, which is |
| 803 |
# set when the operation is created. |
| 804 |
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| 805 |
# text format. |
| 806 |
"error": { # [Output Only] If errors are generated during processing of the operation, |
| 807 |
# this field will be populated. |
| 808 |
"errors": [ # [Output Only] The array of errors encountered while processing this |
| 809 |
# operation. |
| 810 |
{ |
| 811 |
"code": "A String", # [Output Only] The error type identifier for this error. |
| 812 |
"errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| 813 |
# details. There is a set of defined message types to use for providing |
| 814 |
# details.The syntax depends on the error code. For example, |
| 815 |
# QuotaExceededInfo will have details when the error code is |
| 816 |
# QUOTA_EXCEEDED. |
| 817 |
{ |
| 818 |
"errorInfo": { # Describes the cause of the error with structured details. |
| 819 |
# |
| 820 |
# Example of an error when contacting the "pubsub.googleapis.com" API when it |
| 821 |
# is not enabled: |
| 822 |
# |
| 823 |
# { "reason": "API_DISABLED" |
| 824 |
# "domain": "googleapis.com" |
| 825 |
# "metadata": { |
| 826 |
# "resource": "projects/123", |
| 827 |
# "service": "pubsub.googleapis.com" |
| 828 |
# } |
| 829 |
# } |
| 830 |
# |
| 831 |
# This response indicates that the pubsub.googleapis.com API is not enabled. |
| 832 |
# |
| 833 |
# Example of an error that is returned when attempting to create a Spanner |
| 834 |
# instance in a region that is out of stock: |
| 835 |
# |
| 836 |
# { "reason": "STOCKOUT" |
| 837 |
# "domain": "spanner.googleapis.com", |
| 838 |
# "metadata": { |
| 839 |
# "availableRegions": "us-central1,us-east2" |
| 840 |
# } |
| 841 |
# } |
| 842 |
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| 843 |
# is typically the registered service name of the tool or product that |
| 844 |
# generates the error. Example: "pubsub.googleapis.com". If the error is |
| 845 |
# generated by some common infrastructure, the error domain must be a |
| 846 |
# globally unique value that identifies the infrastructure. For Google API |
| 847 |
# infrastructure, the error domain is "googleapis.com". |
| 848 |
"metadatas": { # Additional structured details about this error. |
| 849 |
# |
| 850 |
# Keys must match a regular expression of `a-z+` but should |
| 851 |
# ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| 852 |
# length. When identifying the current value of an exceeded limit, the units |
| 853 |
# should be contained in the key, not the value. For example, rather than |
| 854 |
# `{"instanceLimit": "100/request"}`, should be returned as, |
| 855 |
# `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| 856 |
# instances that can be created in a single (batch) request. |
| 857 |
"a_key": "A String", |
| 858 |
}, |
| 859 |
"reason": "A String", # The reason of the error. This is a constant value that identifies the |
| 860 |
# proximate cause of the error. Error reasons are unique within a particular |
| 861 |
# domain of errors. This should be at most 63 characters and match a |
| 862 |
# regular expression of `A-Z+[A-Z0-9]`, which represents |
| 863 |
# UPPER_SNAKE_CASE. |
| 864 |
}, |
| 865 |
"help": { # Provides links to documentation or for performing an out of band action. |
| 866 |
# |
| 867 |
# For example, if a quota check failed with an error indicating the calling |
| 868 |
# project hasn't enabled the accessed service, this can contain a URL pointing |
| 869 |
# directly to the right place in the developer console to flip the bit. |
| 870 |
"links": [ # URL(s) pointing to additional information on handling the current error. |
| 871 |
{ # Describes a URL link. |
| 872 |
"description": "A String", # Describes what the link offers. |
| 873 |
"url": "A String", # The URL of the link. |
| 874 |
}, |
| 875 |
], |
| 876 |
}, |
| 877 |
"localizedMessage": { # Provides a localized error message that is safe to return to the user |
| 878 |
# which can be attached to an RPC error. |
| 879 |
"locale": "A String", # The locale used following the specification defined at |
| 880 |
# https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| 881 |
# Examples are: "en-US", "fr-CH", "es-MX" |
| 882 |
"message": "A String", # The localized error message in the above locale. |
| 883 |
}, |
| 884 |
"quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| 885 |
"dimensions": { # The map holding related quota dimensions. |
| 886 |
"a_key": "A String", |
| 887 |
}, |
| 888 |
"futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| 889 |
# type or metric. |
| 890 |
"limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| 891 |
# or metric. |
| 892 |
"limitName": "A String", # The name of the quota limit. |
| 893 |
"metricName": "A String", # The Compute Engine quota metric name. |
| 894 |
"rolloutStatus": "A String", # Rollout status of the future quota limit. |
| 895 |
}, |
| 896 |
}, |
| 897 |
], |
| 898 |
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| 899 |
# This property is optional. |
| 900 |
"message": "A String", # [Output Only] An optional, human-readable error message. |
| 901 |
}, |
| 902 |
], |
| 903 |
}, |
| 904 |
"getVersionOperationMetadata": { |
| 905 |
"inlineSbomInfo": { |
| 906 |
"currentComponentVersions": { # A mapping of components to their currently-applied versions or other |
| 907 |
# appropriate identifiers. |
| 908 |
"a_key": "A String", |
| 909 |
}, |
| 910 |
"targetComponentVersions": { # A mapping of components to their target versions or other appropriate |
| 911 |
# identifiers. |
| 912 |
"a_key": "A String", |
| 913 |
}, |
| 914 |
}, |
| 915 |
}, |
| 916 |
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| 917 |
# message that was returned, such as `NOT FOUND`. |
| 918 |
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error |
| 919 |
# status code that was returned. For example, a `404` means the |
| 920 |
# resource was not found. |
| 921 |
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| 922 |
# defined by the server. |
| 923 |
"insertTime": "A String", # [Output Only] The time that this operation was requested. |
| 924 |
# This value is inRFC3339 |
| 925 |
# text format. |
| 926 |
"instancesBulkInsertOperationMetadata": { |
| 927 |
"perLocationStatus": { # Status information per location (location name is key). |
| 928 |
# Example key: zones/us-central1-a |
| 929 |
"a_key": { |
| 930 |
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| 931 |
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| 932 |
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| 933 |
# error. |
| 934 |
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| 935 |
# if the flow is rolling forward or rolling back. |
| 936 |
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| 937 |
}, |
| 938 |
}, |
| 939 |
}, |
| 940 |
"kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| 941 |
# Operation resources. |
| 942 |
"name": "A String", # [Output Only] Name of the operation. |
| 943 |
"operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| 944 |
# group of operations results from a `bulkInsert` API request. |
| 945 |
"operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| 946 |
# `update`, or `delete`, and so on. |
| 947 |
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. |
| 948 |
# There is no requirement that this be linear or support any granularity of |
| 949 |
# operations. This should not be used to guess when the operation will be |
| 950 |
# complete. This number should monotonically increase as the operation |
| 951 |
# progresses. |
| 952 |
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| 953 |
# applicable when performing regional operations. |
| 954 |
"selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 955 |
"setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| 956 |
# this field will contain information on all underlying zonal actions and |
| 957 |
# their state. |
| 958 |
"clientOperationId": "A String", # [Output Only] The client operation id. |
| 959 |
"perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| 960 |
# Example key: zones/us-central1-a |
| 961 |
"a_key": { |
| 962 |
"error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| 963 |
# populated. |
| 964 |
# different programming environments, including REST APIs and RPC APIs. It is |
| 965 |
# used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 966 |
# three pieces of data: error code, error message, and error details. |
| 967 |
# |
| 968 |
# You can find out more about this error model and how to work with it in the |
| 969 |
# [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 970 |
"code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 971 |
"details": [ # A list of messages that carry the error details. There is a common set of |
| 972 |
# message types for APIs to use. |
| 973 |
{ |
| 974 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 975 |
}, |
| 976 |
], |
| 977 |
"message": "A String", # A developer-facing error message, which should be in English. Any |
| 978 |
# user-facing error message should be localized and sent in the |
| 979 |
# google.rpc.Status.details field, or localized by the client. |
| 980 |
}, |
| 981 |
"state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| 982 |
# `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| 983 |
}, |
| 984 |
}, |
| 985 |
}, |
| 986 |
"startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| 987 |
# This value is inRFC3339 |
| 988 |
# text format. |
| 989 |
"status": "A String", # [Output Only] The status of the operation, which can be one of the |
| 990 |
# following: |
| 991 |
# `PENDING`, `RUNNING`, or `DONE`. |
| 992 |
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| 993 |
# operation. |
| 994 |
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| 995 |
# of the target resource. |
| 996 |
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| 997 |
# operations related to creating a snapshot, this points to the disk |
| 998 |
# that the snapshot was created from. |
| 999 |
"user": "A String", # [Output Only] User who requested the operation, for example: |
| 1000 |
# `[email protected]` or |
| 1001 |
# `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| 1002 |
"warnings": [ # [Output Only] If warning messages are generated during processing of the |
| 1003 |
# operation, this field will be populated. |
| 1004 |
{ |
| 1005 |
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| 1006 |
# Engine returns NO_RESULTS_ON_PAGE if there |
| 1007 |
# are no results in the response. |
| 1008 |
"data": [ # [Output Only] Metadata about this warning in key: |
| 1009 |
# value format. For example: |
| 1010 |
# |
| 1011 |
# "data": [ |
| 1012 |
# { |
| 1013 |
# "key": "scope", |
| 1014 |
# "value": "zones/us-east1-d" |
| 1015 |
# } |
| 1016 |
{ |
| 1017 |
"key": "A String", # [Output Only] A key that provides more detail on the warning being |
| 1018 |
# returned. For example, for warnings where there are no results in a list |
| 1019 |
# request for a particular zone, this key might be scope and |
| 1020 |
# the key value might be the zone name. Other examples might be a key |
| 1021 |
# indicating a deprecated resource and a suggested replacement, or a |
| 1022 |
# warning about invalid network settings (for example, if an instance |
| 1023 |
# attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 1024 |
"value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 1025 |
}, |
| 1026 |
], |
| 1027 |
"message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1028 |
}, |
| 1029 |
], |
| 1030 |
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| 1031 |
# applicable when performing per-zone operations. |
| 1032 |
}</pre> |
| 1033 |
</div> |
| 1034 |
|
| 1035 |
<div class="method"> |
| 1036 |
<code class="details" id="list">list(project, crossSiteNetwork, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| 1037 |
<pre>Lists the wire groups for a project in the given scope. |
| 1038 |
|
| 1039 |
Args: |
| 1040 |
project: string, Project ID for this request. (required) |
| 1041 |
crossSiteNetwork: string, A parameter (required) |
| 1042 |
filter: string, A filter expression that filters resources listed in the response. Most |
| 1043 |
Compute resources support two types of filter expressions: |
| 1044 |
expressions that support regular expressions and expressions that follow |
| 1045 |
API improvement proposal AIP-160. |
| 1046 |
These two types of filter expressions cannot be mixed in one request. |
| 1047 |
|
| 1048 |
If you want to use AIP-160, your expression must specify the field name, an |
| 1049 |
operator, and the value that you want to use for filtering. The value |
| 1050 |
must be a string, a number, or a boolean. The operator |
| 1051 |
must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. |
| 1052 |
|
| 1053 |
For example, if you are filtering Compute Engine instances, you can |
| 1054 |
exclude instances named `example-instance` by specifying |
| 1055 |
`name != example-instance`. |
| 1056 |
|
| 1057 |
The `:*` comparison can be used to test whether a key has been defined. |
| 1058 |
For example, to find all objects with `owner` label use: |
| 1059 |
``` |
| 1060 |
labels.owner:* |
| 1061 |
``` |
| 1062 |
|
| 1063 |
You can also filter nested fields. For example, you could specify |
| 1064 |
`scheduling.automaticRestart = false` to include instances only |
| 1065 |
if they are not scheduled for automatic restarts. You can use filtering |
| 1066 |
on nested fields to filter based onresource labels. |
| 1067 |
|
| 1068 |
To filter on multiple expressions, provide each separate expression within |
| 1069 |
parentheses. For example: |
| 1070 |
``` |
| 1071 |
(scheduling.automaticRestart = true) |
| 1072 |
(cpuPlatform = "Intel Skylake") |
| 1073 |
``` |
| 1074 |
By default, each expression is an `AND` expression. However, you |
| 1075 |
can include `AND` and `OR` expressions explicitly. |
| 1076 |
For example: |
| 1077 |
``` |
| 1078 |
(cpuPlatform = "Intel Skylake") OR |
| 1079 |
(cpuPlatform = "Intel Broadwell") AND |
| 1080 |
(scheduling.automaticRestart = true) |
| 1081 |
``` |
| 1082 |
|
| 1083 |
If you want to use a regular expression, use the `eq` (equal) or `ne` |
| 1084 |
(not equal) operator against a single un-parenthesized expression with or |
| 1085 |
without quotes or against multiple parenthesized expressions. Examples: |
| 1086 |
|
| 1087 |
`fieldname eq unquoted literal` |
| 1088 |
`fieldname eq 'single quoted literal'` |
| 1089 |
`fieldname eq "double quoted literal"` |
| 1090 |
`(fieldname1 eq literal) (fieldname2 ne "literal")` |
| 1091 |
|
| 1092 |
The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| 1093 |
The literal value must match the entire field. |
| 1094 |
|
| 1095 |
For example, to filter for instances that do not end with name "instance", |
| 1096 |
you would use `name ne .*instance`. |
| 1097 |
|
| 1098 |
You cannot combine constraints on multiple fields using regular |
| 1099 |
expressions. |
| 1100 |
maxResults: integer, The maximum number of results per page that should be returned. |
| 1101 |
If the number of available results is larger than `maxResults`, |
| 1102 |
Compute Engine returns a `nextPageToken` that can be used to get |
| 1103 |
the next page of results in subsequent list requests. Acceptable values are |
| 1104 |
`0` to `500`, inclusive. (Default: `500`) |
| 1105 |
orderBy: string, Sorts list results by a certain order. By default, results |
| 1106 |
are returned in alphanumerical order based on the resource name. |
| 1107 |
|
| 1108 |
You can also sort results in descending order based on the creation |
| 1109 |
timestamp using `orderBy="creationTimestamp desc"`. This sorts |
| 1110 |
results based on the `creationTimestamp` field in |
| 1111 |
reverse chronological order (newest result first). Use this to sort |
| 1112 |
resources like operations so that the newest operation is returned first. |
| 1113 |
|
| 1114 |
Currently, only sorting by `name` or |
| 1115 |
`creationTimestamp desc` is supported. |
| 1116 |
pageToken: string, Specifies a page token to use. Set `pageToken` to the |
| 1117 |
`nextPageToken` returned by a previous list request to get |
| 1118 |
the next page of results. |
| 1119 |
returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| 1120 |
of failure. The default value is false. |
| 1121 |
|
| 1122 |
For example, when partial success behavior is enabled, aggregatedList for a |
| 1123 |
single zone scope either returns all resources in the zone or no resources, |
| 1124 |
with an error code. |
| 1125 |
x__xgafv: string, V1 error format. |
| 1126 |
Allowed values |
| 1127 |
1 - v1 error format |
| 1128 |
2 - v2 error format |
| 1129 |
|
| 1130 |
Returns: |
| 1131 |
An object of the form: |
| 1132 |
|
| 1133 |
{ # Response for the list request. |
| 1134 |
"etag": "A String", |
| 1135 |
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 1136 |
"items": [ # A list of wire group resources. |
| 1137 |
{ # A resource that represents a group of redundant wires. |
| 1138 |
"adminEnabled": True or False, # Indicates whether the wires in the wire group are enabled. When false, the |
| 1139 |
# wires in the wire group are disabled. When true and when |
| 1140 |
# there is simultaneously no wire-specific override of `adminEnabled` to |
| 1141 |
# false, a given wire is enabled. Defaults to true. |
| 1142 |
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 |
| 1143 |
# text format. |
| 1144 |
"description": "A String", # An optional description of the wire group. |
| 1145 |
"endpoints": { # A map that contains the logical endpoints of the wire group. Specify |
| 1146 |
# key-value pairs for the map as follows: |
| 1147 |
# |
| 1148 |
# - Key: an RFC1035 user-specified label. |
| 1149 |
# - Value: an Endpoint object. |
| 1150 |
"a_key": { # A logical endpoint for the wire group. An endpoint represents a metro that |
| 1151 |
# contains redundant Interconnect connections. A wire group is created |
| 1152 |
# between two endpoints. |
| 1153 |
"interconnects": { # A map that contains the redundant Interconnect connections. Specify |
| 1154 |
# key-value pairs for the map as follows: |
| 1155 |
# |
| 1156 |
# - Key: an RFC1035 user-specified label. |
| 1157 |
# - Value: an Interconnect object. |
| 1158 |
"a_key": { # The redundant Interconnect connections for this endpoint. |
| 1159 |
"interconnect": "A String", # Required. An Interconnect connection. You can specify the connection as |
| 1160 |
# a partial or full URL. If the connection is in a different project from |
| 1161 |
# the cross-site network, use a format that specifies the project. See |
| 1162 |
# the following examples of partial and full URLs: |
| 1163 |
# |
| 1164 |
# |
| 1165 |
# |
| 1166 |
# global/interconnects/NAME |
| 1167 |
# |
| 1168 |
# |
| 1169 |
# projects/PROJECT_ID/global/interconnects/NAME |
| 1170 |
# |
| 1171 |
# - |
| 1172 |
# https://compute.googleapis.com/compute/projects/PROJECT_ID/global/interconnects/NAME |
| 1173 |
"vlanTags": [ # Required. To configure the wire group for VLAN mode, enter a VLAN tag, |
| 1174 |
# which is a number from `2` to `4093`. You can autoallocate a tag by |
| 1175 |
# entering `0`. To configure the wire group for port mode, enter `-1`. |
| 1176 |
# Review the following guidelines: |
| 1177 |
# |
| 1178 |
# - A VLAN tag must be unique for an Interconnect connection across all |
| 1179 |
# attachments and wire groups. |
| 1180 |
# - Both endpoints of a wire must use the same VLAN tag value. |
| 1181 |
# - Single wire and redundant type wire groups must have only one |
| 1182 |
# VLAN tag. |
| 1183 |
# - Port mode pseudowires must have a single VLAN tag with a value of |
| 1184 |
# `-1` for both endpoints. |
| 1185 |
# - Box and cross type wire groups must have two VLAN tags. The first |
| 1186 |
# is for the same-zone pseudowire, and the second is for the cross-zone |
| 1187 |
# pseudowire. |
| 1188 |
42, |
| 1189 |
], |
| 1190 |
}, |
| 1191 |
}, |
| 1192 |
}, |
| 1193 |
}, |
| 1194 |
"id": "A String", # Output only. [Output Only] The unique identifier for the resource type. The server |
| 1195 |
# generates this identifier. |
| 1196 |
"kind": "compute#wireGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups. |
| 1197 |
"name": "A String", # Name of the resource. Provided by the client when the resource is created. |
| 1198 |
# The name must be 1-63 characters long, and comply withRFC1035. |
| 1199 |
# Specifically, the name must be 1-63 characters long and match the regular |
| 1200 |
# expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first |
| 1201 |
# character must be a lowercase letter, and all following characters must |
| 1202 |
# be a dash, lowercase letter, or digit, except the last character, which |
| 1203 |
# cannot be a dash. |
| 1204 |
"reconciling": True or False, # Output only. [Output Only] Indicates whether there are wire changes yet to be processed. |
| 1205 |
"selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. |
| 1206 |
"topology": { # Topology details for the wire group. # Output only. Topology details for the wire group configuration. |
| 1207 |
"endpoints": [ # Output only. Topology details for all endpoints in the wire group. |
| 1208 |
{ # Topology details for a single wire group endpoint. |
| 1209 |
"city": "A String", # Output only. The InterconnectLocation.city (metropolitan area designator) that all |
| 1210 |
# interconnects are located in. |
| 1211 |
"label": "A String", # Output only. Endpoint label from the wire group. |
| 1212 |
}, |
| 1213 |
], |
| 1214 |
}, |
| 1215 |
"wireGroupProperties": { # The properties of a wire group. These properties # Properties of the wire group. |
| 1216 |
# determine how a group of redundant wires are created and managed. |
| 1217 |
"type": "A String", # The type of the wire group, one of the following: |
| 1218 |
# |
| 1219 |
# - WIRE: a single pseudowire over two Interconnect connections with no |
| 1220 |
# redundancy. |
| 1221 |
# - REDUNDANT: two pseudowires over four Interconnect connections, with |
| 1222 |
# two connections in one metro and two connections in another metro. |
| 1223 |
# Each redundant pair of Interconnect connections spans both edge |
| 1224 |
# availability domains of the metro. Each pseudowire connects Interconnect |
| 1225 |
# connections in matching edge availability domains of the two metros. |
| 1226 |
# - BOX_AND_CROSS: four pseudowires over four Interconnect connections, |
| 1227 |
# with two connections in one metro and two connections in another metro. |
| 1228 |
# Each redundant pair of Interconnect connections spans both edge |
| 1229 |
# availability domains of the metro. Two pseudowires connect Interconnect |
| 1230 |
# connections in matching edge availability domains of the two metros. |
| 1231 |
# Two additional pseudowires connect the non-matching edge availability |
| 1232 |
# domains of the two metros. |
| 1233 |
}, |
| 1234 |
"wireProperties": { # The properties of a wire. # Properties for all wires in the wire group. |
| 1235 |
"bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: |
| 1236 |
# |
| 1237 |
# - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation |
| 1238 |
# (and associated charges) for each wire in the group. |
| 1239 |
# - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures |
| 1240 |
# one unmetered bandwidth allocation for the wire group. The unmetered |
| 1241 |
# bandwidth is divided equally across each wire in the group, but dynamic |
| 1242 |
# throttling reallocates unused unmetered bandwidth from unused or underused |
| 1243 |
# wires to other wires in the group. |
| 1244 |
"bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` |
| 1245 |
# is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0. |
| 1246 |
"faultResponse": "A String", # Response when a fault is detected in a pseudowire: |
| 1247 |
# |
| 1248 |
# - NONE: default. |
| 1249 |
# - DISABLE_PORT: set the port line protocol down when inline probes |
| 1250 |
# detect a fault. This setting is only permitted on port mode |
| 1251 |
# pseudowires. |
| 1252 |
}, |
| 1253 |
"wires": [ # Output only. The single/redundant wire(s) managed by the wire group. |
| 1254 |
{ # A pseudowire that connects two Interconnect connections. |
| 1255 |
"adminEnabled": True or False, # Output only. [Output Only] Indicates whether the wire is enabled. |
| 1256 |
# When false, the wire is disabled. When true and when the wire group of |
| 1257 |
# the wire is also enabled, the wire is enabled. Defaults to true. |
| 1258 |
"endpoints": [ # Output only. Wire endpoints are specific Interconnect connections. |
| 1259 |
{ # Wire endpoints are specific Interconnect connections. |
| 1260 |
"interconnect": "A String", |
| 1261 |
"vlanTag": 42, |
| 1262 |
}, |
| 1263 |
], |
| 1264 |
"label": "A String", # Output only. [Output Only] A label that identifies the wire. The format of this label |
| 1265 |
# combines the existing labels of the wire group endpoints and Interconnect |
| 1266 |
# connections used by this wire in alphabetical order as follows: |
| 1267 |
# `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where: |
| 1268 |
# |
| 1269 |
# - ENDPOINT_A and ENDPOINT_B: are the labels |
| 1270 |
# that you entered as map keys when you specified the wire group endpoint |
| 1271 |
# objects. |
| 1272 |
# - CONNECTION_A1 and CONNECTION_B1: are the |
| 1273 |
# labels that you entered as map keys when you specified the wire group |
| 1274 |
# Interconnect objects. |
| 1275 |
"wireProperties": { # The properties of a wire. # Output only. [Output Only] Properties of the wire. |
| 1276 |
"bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: |
| 1277 |
# |
| 1278 |
# - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation |
| 1279 |
# (and associated charges) for each wire in the group. |
| 1280 |
# - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures |
| 1281 |
# one unmetered bandwidth allocation for the wire group. The unmetered |
| 1282 |
# bandwidth is divided equally across each wire in the group, but dynamic |
| 1283 |
# throttling reallocates unused unmetered bandwidth from unused or underused |
| 1284 |
# wires to other wires in the group. |
| 1285 |
"bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` |
| 1286 |
# is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0. |
| 1287 |
"faultResponse": "A String", # Response when a fault is detected in a pseudowire: |
| 1288 |
# |
| 1289 |
# - NONE: default. |
| 1290 |
# - DISABLE_PORT: set the port line protocol down when inline probes |
| 1291 |
# detect a fault. This setting is only permitted on port mode |
| 1292 |
# pseudowires. |
| 1293 |
}, |
| 1294 |
}, |
| 1295 |
], |
| 1296 |
}, |
| 1297 |
], |
| 1298 |
"kind": "compute#wireGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups. |
| 1299 |
"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for |
| 1300 |
# list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for |
| 1301 |
# the query parameter pageToken in the next list request. |
| 1302 |
# Subsequent list requests will have their own nextPageToken to |
| 1303 |
# continue paging through the results. |
| 1304 |
"selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 1305 |
"unreachables": [ # Output only. [Output Only] Unreachable resources. |
| 1306 |
# end_interface: MixerListResponseWithEtagBuilder |
| 1307 |
"A String", |
| 1308 |
], |
| 1309 |
"warning": { # [Output Only] Informational warning message. |
| 1310 |
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| 1311 |
# Engine returns NO_RESULTS_ON_PAGE if there |
| 1312 |
# are no results in the response. |
| 1313 |
"data": [ # [Output Only] Metadata about this warning in key: |
| 1314 |
# value format. For example: |
| 1315 |
# |
| 1316 |
# "data": [ |
| 1317 |
# { |
| 1318 |
# "key": "scope", |
| 1319 |
# "value": "zones/us-east1-d" |
| 1320 |
# } |
| 1321 |
{ |
| 1322 |
"key": "A String", # [Output Only] A key that provides more detail on the warning being |
| 1323 |
# returned. For example, for warnings where there are no results in a list |
| 1324 |
# request for a particular zone, this key might be scope and |
| 1325 |
# the key value might be the zone name. Other examples might be a key |
| 1326 |
# indicating a deprecated resource and a suggested replacement, or a |
| 1327 |
# warning about invalid network settings (for example, if an instance |
| 1328 |
# attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 1329 |
"value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 1330 |
}, |
| 1331 |
], |
| 1332 |
"message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1333 |
}, |
| 1334 |
}</pre> |
| 1335 |
</div> |
| 1336 |
|
| 1337 |
<div class="method"> |
| 1338 |
<code class="details" id="list_next">list_next()</code> |
| 1339 |
<pre>Retrieves the next page of results. |
| 1340 |
|
| 1341 |
Args: |
| 1342 |
previous_request: The request for the previous page. (required) |
| 1343 |
previous_response: The response from the request for the previous page. (required) |
| 1344 |
|
| 1345 |
Returns: |
| 1346 |
A request object that you can call 'execute()' on to request the next |
| 1347 |
page. Returns None if there are no more items in the collection. |
| 1348 |
</pre> |
| 1349 |
</div> |
| 1350 |
|
| 1351 |
<div class="method"> |
| 1352 |
<code class="details" id="patch">patch(project, crossSiteNetwork, wireGroup, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code> |
| 1353 |
<pre>Updates the specified wire group resource with the data included in the |
| 1354 |
request. This method supportsPATCH |
| 1355 |
semantics and usesJSON merge |
| 1356 |
patch format and processing rules. |
| 1357 |
|
| 1358 |
Args: |
| 1359 |
project: string, Project ID for this request. (required) |
| 1360 |
crossSiteNetwork: string, A parameter (required) |
| 1361 |
wireGroup: string, Name of the WireGroups resource to patch. (required) |
| 1362 |
body: object, The request body. |
| 1363 |
The object takes the form of: |
| 1364 |
|
| 1365 |
{ # A resource that represents a group of redundant wires. |
| 1366 |
"adminEnabled": True or False, # Indicates whether the wires in the wire group are enabled. When false, the |
| 1367 |
# wires in the wire group are disabled. When true and when |
| 1368 |
# there is simultaneously no wire-specific override of `adminEnabled` to |
| 1369 |
# false, a given wire is enabled. Defaults to true. |
| 1370 |
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 |
| 1371 |
# text format. |
| 1372 |
"description": "A String", # An optional description of the wire group. |
| 1373 |
"endpoints": { # A map that contains the logical endpoints of the wire group. Specify |
| 1374 |
# key-value pairs for the map as follows: |
| 1375 |
# |
| 1376 |
# - Key: an RFC1035 user-specified label. |
| 1377 |
# - Value: an Endpoint object. |
| 1378 |
"a_key": { # A logical endpoint for the wire group. An endpoint represents a metro that |
| 1379 |
# contains redundant Interconnect connections. A wire group is created |
| 1380 |
# between two endpoints. |
| 1381 |
"interconnects": { # A map that contains the redundant Interconnect connections. Specify |
| 1382 |
# key-value pairs for the map as follows: |
| 1383 |
# |
| 1384 |
# - Key: an RFC1035 user-specified label. |
| 1385 |
# - Value: an Interconnect object. |
| 1386 |
"a_key": { # The redundant Interconnect connections for this endpoint. |
| 1387 |
"interconnect": "A String", # Required. An Interconnect connection. You can specify the connection as |
| 1388 |
# a partial or full URL. If the connection is in a different project from |
| 1389 |
# the cross-site network, use a format that specifies the project. See |
| 1390 |
# the following examples of partial and full URLs: |
| 1391 |
# |
| 1392 |
# |
| 1393 |
# |
| 1394 |
# global/interconnects/NAME |
| 1395 |
# |
| 1396 |
# |
| 1397 |
# projects/PROJECT_ID/global/interconnects/NAME |
| 1398 |
# |
| 1399 |
# - |
| 1400 |
# https://compute.googleapis.com/compute/projects/PROJECT_ID/global/interconnects/NAME |
| 1401 |
"vlanTags": [ # Required. To configure the wire group for VLAN mode, enter a VLAN tag, |
| 1402 |
# which is a number from `2` to `4093`. You can autoallocate a tag by |
| 1403 |
# entering `0`. To configure the wire group for port mode, enter `-1`. |
| 1404 |
# Review the following guidelines: |
| 1405 |
# |
| 1406 |
# - A VLAN tag must be unique for an Interconnect connection across all |
| 1407 |
# attachments and wire groups. |
| 1408 |
# - Both endpoints of a wire must use the same VLAN tag value. |
| 1409 |
# - Single wire and redundant type wire groups must have only one |
| 1410 |
# VLAN tag. |
| 1411 |
# - Port mode pseudowires must have a single VLAN tag with a value of |
| 1412 |
# `-1` for both endpoints. |
| 1413 |
# - Box and cross type wire groups must have two VLAN tags. The first |
| 1414 |
# is for the same-zone pseudowire, and the second is for the cross-zone |
| 1415 |
# pseudowire. |
| 1416 |
42, |
| 1417 |
], |
| 1418 |
}, |
| 1419 |
}, |
| 1420 |
}, |
| 1421 |
}, |
| 1422 |
"id": "A String", # Output only. [Output Only] The unique identifier for the resource type. The server |
| 1423 |
# generates this identifier. |
| 1424 |
"kind": "compute#wireGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups. |
| 1425 |
"name": "A String", # Name of the resource. Provided by the client when the resource is created. |
| 1426 |
# The name must be 1-63 characters long, and comply withRFC1035. |
| 1427 |
# Specifically, the name must be 1-63 characters long and match the regular |
| 1428 |
# expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first |
| 1429 |
# character must be a lowercase letter, and all following characters must |
| 1430 |
# be a dash, lowercase letter, or digit, except the last character, which |
| 1431 |
# cannot be a dash. |
| 1432 |
"reconciling": True or False, # Output only. [Output Only] Indicates whether there are wire changes yet to be processed. |
| 1433 |
"selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. |
| 1434 |
"topology": { # Topology details for the wire group. # Output only. Topology details for the wire group configuration. |
| 1435 |
"endpoints": [ # Output only. Topology details for all endpoints in the wire group. |
| 1436 |
{ # Topology details for a single wire group endpoint. |
| 1437 |
"city": "A String", # Output only. The InterconnectLocation.city (metropolitan area designator) that all |
| 1438 |
# interconnects are located in. |
| 1439 |
"label": "A String", # Output only. Endpoint label from the wire group. |
| 1440 |
}, |
| 1441 |
], |
| 1442 |
}, |
| 1443 |
"wireGroupProperties": { # The properties of a wire group. These properties # Properties of the wire group. |
| 1444 |
# determine how a group of redundant wires are created and managed. |
| 1445 |
"type": "A String", # The type of the wire group, one of the following: |
| 1446 |
# |
| 1447 |
# - WIRE: a single pseudowire over two Interconnect connections with no |
| 1448 |
# redundancy. |
| 1449 |
# - REDUNDANT: two pseudowires over four Interconnect connections, with |
| 1450 |
# two connections in one metro and two connections in another metro. |
| 1451 |
# Each redundant pair of Interconnect connections spans both edge |
| 1452 |
# availability domains of the metro. Each pseudowire connects Interconnect |
| 1453 |
# connections in matching edge availability domains of the two metros. |
| 1454 |
# - BOX_AND_CROSS: four pseudowires over four Interconnect connections, |
| 1455 |
# with two connections in one metro and two connections in another metro. |
| 1456 |
# Each redundant pair of Interconnect connections spans both edge |
| 1457 |
# availability domains of the metro. Two pseudowires connect Interconnect |
| 1458 |
# connections in matching edge availability domains of the two metros. |
| 1459 |
# Two additional pseudowires connect the non-matching edge availability |
| 1460 |
# domains of the two metros. |
| 1461 |
}, |
| 1462 |
"wireProperties": { # The properties of a wire. # Properties for all wires in the wire group. |
| 1463 |
"bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: |
| 1464 |
# |
| 1465 |
# - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation |
| 1466 |
# (and associated charges) for each wire in the group. |
| 1467 |
# - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures |
| 1468 |
# one unmetered bandwidth allocation for the wire group. The unmetered |
| 1469 |
# bandwidth is divided equally across each wire in the group, but dynamic |
| 1470 |
# throttling reallocates unused unmetered bandwidth from unused or underused |
| 1471 |
# wires to other wires in the group. |
| 1472 |
"bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` |
| 1473 |
# is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0. |
| 1474 |
"faultResponse": "A String", # Response when a fault is detected in a pseudowire: |
| 1475 |
# |
| 1476 |
# - NONE: default. |
| 1477 |
# - DISABLE_PORT: set the port line protocol down when inline probes |
| 1478 |
# detect a fault. This setting is only permitted on port mode |
| 1479 |
# pseudowires. |
| 1480 |
}, |
| 1481 |
"wires": [ # Output only. The single/redundant wire(s) managed by the wire group. |
| 1482 |
{ # A pseudowire that connects two Interconnect connections. |
| 1483 |
"adminEnabled": True or False, # Output only. [Output Only] Indicates whether the wire is enabled. |
| 1484 |
# When false, the wire is disabled. When true and when the wire group of |
| 1485 |
# the wire is also enabled, the wire is enabled. Defaults to true. |
| 1486 |
"endpoints": [ # Output only. Wire endpoints are specific Interconnect connections. |
| 1487 |
{ # Wire endpoints are specific Interconnect connections. |
| 1488 |
"interconnect": "A String", |
| 1489 |
"vlanTag": 42, |
| 1490 |
}, |
| 1491 |
], |
| 1492 |
"label": "A String", # Output only. [Output Only] A label that identifies the wire. The format of this label |
| 1493 |
# combines the existing labels of the wire group endpoints and Interconnect |
| 1494 |
# connections used by this wire in alphabetical order as follows: |
| 1495 |
# `ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where: |
| 1496 |
# |
| 1497 |
# - ENDPOINT_A and ENDPOINT_B: are the labels |
| 1498 |
# that you entered as map keys when you specified the wire group endpoint |
| 1499 |
# objects. |
| 1500 |
# - CONNECTION_A1 and CONNECTION_B1: are the |
| 1501 |
# labels that you entered as map keys when you specified the wire group |
| 1502 |
# Interconnect objects. |
| 1503 |
"wireProperties": { # The properties of a wire. # Output only. [Output Only] Properties of the wire. |
| 1504 |
"bandwidthAllocation": "A String", # The configuration of the bandwidth allocation, one of the following: |
| 1505 |
# |
| 1506 |
# - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation |
| 1507 |
# (and associated charges) for each wire in the group. |
| 1508 |
# - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures |
| 1509 |
# one unmetered bandwidth allocation for the wire group. The unmetered |
| 1510 |
# bandwidth is divided equally across each wire in the group, but dynamic |
| 1511 |
# throttling reallocates unused unmetered bandwidth from unused or underused |
| 1512 |
# wires to other wires in the group. |
| 1513 |
"bandwidthUnmetered": "A String", # The unmetered bandwidth in Gigabits per second, using decimal units. `10` |
| 1514 |
# is 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0. |
| 1515 |
"faultResponse": "A String", # Response when a fault is detected in a pseudowire: |
| 1516 |
# |
| 1517 |
# - NONE: default. |
| 1518 |
# - DISABLE_PORT: set the port line protocol down when inline probes |
| 1519 |
# detect a fault. This setting is only permitted on port mode |
| 1520 |
# pseudowires. |
| 1521 |
}, |
| 1522 |
}, |
| 1523 |
], |
| 1524 |
} |
| 1525 |
|
| 1526 |
requestId: string, An optional request ID to identify requests. Specify a unique request ID so |
| 1527 |
that if you must retry your request, the server will know to ignore the |
| 1528 |
request if it has already been completed. |
| 1529 |
|
| 1530 |
For example, consider a situation where you make an initial request and |
| 1531 |
the request times out. If you make the request again with the same |
| 1532 |
request ID, the server can check if original operation with the same |
| 1533 |
request ID was received, and if so, will ignore the second request. This |
| 1534 |
prevents clients from accidentally creating duplicate commitments. |
| 1535 |
|
| 1536 |
The request ID must be |
| 1537 |
a valid UUID with the exception that zero UUID is not supported |
| 1538 |
(00000000-0000-0000-0000-000000000000). |
| 1539 |
end_interface: MixerMutationRequestBuilder |
| 1540 |
updateMask: string, update_mask indicates fields to be updated as part of this request. |
| 1541 |
validateOnly: boolean, [Input Only] Validate the new configuration, but don't update it. |
| 1542 |
x__xgafv: string, V1 error format. |
| 1543 |
Allowed values |
| 1544 |
1 - v1 error format |
| 1545 |
2 - v2 error format |
| 1546 |
|
| 1547 |
Returns: |
| 1548 |
An object of the form: |
| 1549 |
|
| 1550 |
{ # Represents an Operation resource. |
| 1551 |
# |
| 1552 |
# Google Compute Engine has three Operation resources: |
| 1553 |
# |
| 1554 |
# * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| 1555 |
# * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| 1556 |
# * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| 1557 |
# |
| 1558 |
# You can use an operation resource to manage asynchronous API requests. |
| 1559 |
# For more information, readHandling |
| 1560 |
# API responses. |
| 1561 |
# |
| 1562 |
# Operations can be global, regional or zonal. |
| 1563 |
# |
| 1564 |
# - For global operations, use the `globalOperations` |
| 1565 |
# resource. |
| 1566 |
# - For regional operations, use the |
| 1567 |
# `regionOperations` resource. |
| 1568 |
# - For zonal operations, use |
| 1569 |
# the `zoneOperations` resource. |
| 1570 |
# |
| 1571 |
# |
| 1572 |
# |
| 1573 |
# For more information, read |
| 1574 |
# Global, Regional, and Zonal Resources. |
| 1575 |
# |
| 1576 |
# Note that completed Operation resources have a limited |
| 1577 |
# retention period. |
| 1578 |
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. |
| 1579 |
# Not present otherwise. |
| 1580 |
"creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 1581 |
"description": "A String", # [Output Only] A textual description of the operation, which is |
| 1582 |
# set when the operation is created. |
| 1583 |
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 |
| 1584 |
# text format. |
| 1585 |
"error": { # [Output Only] If errors are generated during processing of the operation, |
| 1586 |
# this field will be populated. |
| 1587 |
"errors": [ # [Output Only] The array of errors encountered while processing this |
| 1588 |
# operation. |
| 1589 |
{ |
| 1590 |
"code": "A String", # [Output Only] The error type identifier for this error. |
| 1591 |
"errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| 1592 |
# details. There is a set of defined message types to use for providing |
| 1593 |
# details.The syntax depends on the error code. For example, |
| 1594 |
# QuotaExceededInfo will have details when the error code is |
| 1595 |
# QUOTA_EXCEEDED. |
| 1596 |
{ |
| 1597 |
"errorInfo": { # Describes the cause of the error with structured details. |
| 1598 |
# |
| 1599 |
# Example of an error when contacting the "pubsub.googleapis.com" API when it |
| 1600 |
# is not enabled: |
| 1601 |
# |
| 1602 |
# { "reason": "API_DISABLED" |
| 1603 |
# "domain": "googleapis.com" |
| 1604 |
# "metadata": { |
| 1605 |
# "resource": "projects/123", |
| 1606 |
# "service": "pubsub.googleapis.com" |
| 1607 |
# } |
| 1608 |
# } |
| 1609 |
# |
| 1610 |
# This response indicates that the pubsub.googleapis.com API is not enabled. |
| 1611 |
# |
| 1612 |
# Example of an error that is returned when attempting to create a Spanner |
| 1613 |
# instance in a region that is out of stock: |
| 1614 |
# |
| 1615 |
# { "reason": "STOCKOUT" |
| 1616 |
# "domain": "spanner.googleapis.com", |
| 1617 |
# "metadata": { |
| 1618 |
# "availableRegions": "us-central1,us-east2" |
| 1619 |
# } |
| 1620 |
# } |
| 1621 |
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| 1622 |
# is typically the registered service name of the tool or product that |
| 1623 |
# generates the error. Example: "pubsub.googleapis.com". If the error is |
| 1624 |
# generated by some common infrastructure, the error domain must be a |
| 1625 |
# globally unique value that identifies the infrastructure. For Google API |
| 1626 |
# infrastructure, the error domain is "googleapis.com". |
| 1627 |
"metadatas": { # Additional structured details about this error. |
| 1628 |
# |
| 1629 |
# Keys must match a regular expression of `a-z+` but should |
| 1630 |
# ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| 1631 |
# length. When identifying the current value of an exceeded limit, the units |
| 1632 |
# should be contained in the key, not the value. For example, rather than |
| 1633 |
# `{"instanceLimit": "100/request"}`, should be returned as, |
| 1634 |
# `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| 1635 |
# instances that can be created in a single (batch) request. |
| 1636 |
"a_key": "A String", |
| 1637 |
}, |
| 1638 |
"reason": "A String", # The reason of the error. This is a constant value that identifies the |
| 1639 |
# proximate cause of the error. Error reasons are unique within a particular |
| 1640 |
# domain of errors. This should be at most 63 characters and match a |
| 1641 |
# regular expression of `A-Z+[A-Z0-9]`, which represents |
| 1642 |
# UPPER_SNAKE_CASE. |
| 1643 |
}, |
| 1644 |
"help": { # Provides links to documentation or for performing an out of band action. |
| 1645 |
# |
| 1646 |
# For example, if a quota check failed with an error indicating the calling |
| 1647 |
# project hasn't enabled the accessed service, this can contain a URL pointing |
| 1648 |
# directly to the right place in the developer console to flip the bit. |
| 1649 |
"links": [ # URL(s) pointing to additional information on handling the current error. |
| 1650 |
{ # Describes a URL link. |
| 1651 |
"description": "A String", # Describes what the link offers. |
| 1652 |
"url": "A String", # The URL of the link. |
| 1653 |
}, |
| 1654 |
], |
| 1655 |
}, |
| 1656 |
"localizedMessage": { # Provides a localized error message that is safe to return to the user |
| 1657 |
# which can be attached to an RPC error. |
| 1658 |
"locale": "A String", # The locale used following the specification defined at |
| 1659 |
# https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| 1660 |
# Examples are: "en-US", "fr-CH", "es-MX" |
| 1661 |
"message": "A String", # The localized error message in the above locale. |
| 1662 |
}, |
| 1663 |
"quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| 1664 |
"dimensions": { # The map holding related quota dimensions. |
| 1665 |
"a_key": "A String", |
| 1666 |
}, |
| 1667 |
"futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| 1668 |
# type or metric. |
| 1669 |
"limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| 1670 |
# or metric. |
| 1671 |
"limitName": "A String", # The name of the quota limit. |
| 1672 |
"metricName": "A String", # The Compute Engine quota metric name. |
| 1673 |
"rolloutStatus": "A String", # Rollout status of the future quota limit. |
| 1674 |
}, |
| 1675 |
}, |
| 1676 |
], |
| 1677 |
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. |
| 1678 |
# This property is optional. |
| 1679 |
"message": "A String", # [Output Only] An optional, human-readable error message. |
| 1680 |
}, |
| 1681 |
], |
| 1682 |
}, |
| 1683 |
"getVersionOperationMetadata": { |
| 1684 |
"inlineSbomInfo": { |
| 1685 |
"currentComponentVersions": { # A mapping of components to their currently-applied versions or other |
| 1686 |
# appropriate identifiers. |
| 1687 |
"a_key": "A String", |
| 1688 |
}, |
| 1689 |
"targetComponentVersions": { # A mapping of components to their target versions or other appropriate |
| 1690 |
# identifiers. |
| 1691 |
"a_key": "A String", |
| 1692 |
}, |
| 1693 |
}, |
| 1694 |
}, |
| 1695 |
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error |
| 1696 |
# message that was returned, such as `NOT FOUND`. |
| 1697 |
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error |
| 1698 |
# status code that was returned. For example, a `404` means the |
| 1699 |
# resource was not found. |
| 1700 |
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is |
| 1701 |
# defined by the server. |
| 1702 |
"insertTime": "A String", # [Output Only] The time that this operation was requested. |
| 1703 |
# This value is inRFC3339 |
| 1704 |
# text format. |
| 1705 |
"instancesBulkInsertOperationMetadata": { |
| 1706 |
"perLocationStatus": { # Status information per location (location name is key). |
| 1707 |
# Example key: zones/us-central1-a |
| 1708 |
"a_key": { |
| 1709 |
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| 1710 |
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| 1711 |
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| 1712 |
# error. |
| 1713 |
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| 1714 |
# if the flow is rolling forward or rolling back. |
| 1715 |
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| 1716 |
}, |
| 1717 |
}, |
| 1718 |
}, |
| 1719 |
"kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| 1720 |
# Operation resources. |
| 1721 |
"name": "A String", # [Output Only] Name of the operation. |
| 1722 |
"operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| 1723 |
# group of operations results from a `bulkInsert` API request. |
| 1724 |
"operationType": "A String", # [Output Only] The type of operation, such as `insert`, |
| 1725 |
# `update`, or `delete`, and so on. |
| 1726 |
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. |
| 1727 |
# There is no requirement that this be linear or support any granularity of |
| 1728 |
# operations. This should not be used to guess when the operation will be |
| 1729 |
# complete. This number should monotonically increase as the operation |
| 1730 |
# progresses. |
| 1731 |
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only |
| 1732 |
# applicable when performing regional operations. |
| 1733 |
"selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 1734 |
"setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| 1735 |
# this field will contain information on all underlying zonal actions and |
| 1736 |
# their state. |
| 1737 |
"clientOperationId": "A String", # [Output Only] The client operation id. |
| 1738 |
"perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| 1739 |
# Example key: zones/us-central1-a |
| 1740 |
"a_key": { |
| 1741 |
"error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| 1742 |
# populated. |
| 1743 |
# different programming environments, including REST APIs and RPC APIs. It is |
| 1744 |
# used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 1745 |
# three pieces of data: error code, error message, and error details. |
| 1746 |
# |
| 1747 |
# You can find out more about this error model and how to work with it in the |
| 1748 |
# [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 1749 |
"code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1750 |
"details": [ # A list of messages that carry the error details. There is a common set of |
| 1751 |
# message types for APIs to use. |
| 1752 |
{ |
| 1753 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1754 |
}, |
| 1755 |
], |
| 1756 |
"message": "A String", # A developer-facing error message, which should be in English. Any |
| 1757 |
# user-facing error message should be localized and sent in the |
| 1758 |
# google.rpc.Status.details field, or localized by the client. |
| 1759 |
}, |
| 1760 |
"state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| 1761 |
# `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| 1762 |
}, |
| 1763 |
}, |
| 1764 |
}, |
| 1765 |
"startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| 1766 |
# This value is inRFC3339 |
| 1767 |
# text format. |
| 1768 |
"status": "A String", # [Output Only] The status of the operation, which can be one of the |
| 1769 |
# following: |
| 1770 |
# `PENDING`, `RUNNING`, or `DONE`. |
| 1771 |
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the |
| 1772 |
# operation. |
| 1773 |
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation |
| 1774 |
# of the target resource. |
| 1775 |
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For |
| 1776 |
# operations related to creating a snapshot, this points to the disk |
| 1777 |
# that the snapshot was created from. |
| 1778 |
"user": "A String", # [Output Only] User who requested the operation, for example: |
| 1779 |
# `[email protected]` or |
| 1780 |
# `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| 1781 |
"warnings": [ # [Output Only] If warning messages are generated during processing of the |
| 1782 |
# operation, this field will be populated. |
| 1783 |
{ |
| 1784 |
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| 1785 |
# Engine returns NO_RESULTS_ON_PAGE if there |
| 1786 |
# are no results in the response. |
| 1787 |
"data": [ # [Output Only] Metadata about this warning in key: |
| 1788 |
# value format. For example: |
| 1789 |
# |
| 1790 |
# "data": [ |
| 1791 |
# { |
| 1792 |
# "key": "scope", |
| 1793 |
# "value": "zones/us-east1-d" |
| 1794 |
# } |
| 1795 |
{ |
| 1796 |
"key": "A String", # [Output Only] A key that provides more detail on the warning being |
| 1797 |
# returned. For example, for warnings where there are no results in a list |
| 1798 |
# request for a particular zone, this key might be scope and |
| 1799 |
# the key value might be the zone name. Other examples might be a key |
| 1800 |
# indicating a deprecated resource and a suggested replacement, or a |
| 1801 |
# warning about invalid network settings (for example, if an instance |
| 1802 |
# attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 1803 |
"value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 1804 |
}, |
| 1805 |
], |
| 1806 |
"message": "A String", # [Output Only] A human-readable description of the warning code. |
| 1807 |
}, |
| 1808 |
], |
| 1809 |
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only |
| 1810 |
# applicable when performing per-zone operations. |
| 1811 |
}</pre> |
| 1812 |
</div> |
| 1813 |
|
| 1814 |
</body></html> |