Method: googleapis.compute.v1.routers.preview

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

Arguments

Parameters
project

string

Required. Project ID for this request.

region

string

Required. Name of the region for this request.

router

string

Required. Name of the Router resource to query.

body

object (Router)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of RoutersPreviewResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- preview:
    call: googleapis.compute.v1.routers.preview
    args:
        project: ...
        region: ...
        router: ...
        body:
            bgp:
                advertiseMode: ...
                advertisedGroups: ...
                advertisedIpRanges: ...
                asn: ...
                keepaliveInterval: ...
            bgpPeers: ...
            description: ...
            encryptedInterconnectRouter: ...
            interfaces: ...
            md5AuthenticationKeys: ...
            name: ...
            nats: ...
            network: ...
    result: previewResult

JSON

[
  {
    "preview": {
      "call": "googleapis.compute.v1.routers.preview",
      "args": {
        "project": "...",
        "region": "...",
        "router": "...",
        "body": {
          "bgp": {
            "advertiseMode": "...",
            "advertisedGroups": "...",
            "advertisedIpRanges": "...",
            "asn": "...",
            "keepaliveInterval": "..."
          },
          "bgpPeers": "...",
          "description": "...",
          "encryptedInterconnectRouter": "...",
          "interfaces": "...",
          "md5AuthenticationKeys": "...",
          "name": "...",
          "nats": "...",
          "network": "..."
        }
      },
      "result": "previewResult"
    }
  }
]