| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.routers.html">routers</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves an aggregated list of routers.</p> | |
| <p class="toc_element"> | |
| <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(project, region, router, etag=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes the specified Router resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="#deleteNamedSet">deleteNamedSet(project, region, router, namedSet=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes Named Set</p> | |
| <p class="toc_element"> | |
| <code><a href="#deleteRoutePolicy">deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes Route Policy</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(project, region, router, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Returns the specified Router resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="#getNamedSet">getNamedSet(project, region, router, namedSet=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Returns specified Named Set</p> | |
| <p class="toc_element"> | |
| <code><a href="#getNatIpInfo">getNatIpInfo(project, region, router, natName=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves runtime NAT IP information.</p> | |
| <p class="toc_element"> | |
| <code><a href="#getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, natName=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves runtime Nat mapping information of VM endpoints.</p> | |
| <p class="toc_element"> | |
| <code><a href="#getNatMappingInfo_next">getNatMappingInfo_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#getRoutePolicy">getRoutePolicy(project, region, router, policy=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Returns specified Route Policy</p> | |
| <p class="toc_element"> | |
| <code><a href="#getRouterStatus">getRouterStatus(project, region, router, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves runtime information of the specified router.</p> | |
| <p class="toc_element"> | |
| <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates a Router resource in the specified project and region using</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves a list of Router resources available to the specified project.</p> | |
| <p class="toc_element"> | |
| <code><a href="#listBgpRoutes">listBgpRoutes(project, region, router, addressFamily=None, destinationPrefix=None, filter=None, maxResults=None, orderBy=None, pageToken=None, peer=None, policyApplied=None, returnPartialSuccess=None, routeType=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves a list of router bgp routes available to the specified project.</p> | |
| <p class="toc_element"> | |
| <code><a href="#listBgpRoutes_next">listBgpRoutes_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#listNamedSets">listNamedSets(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves a list of router named set subresources available to the</p> | |
| <p class="toc_element"> | |
| <code><a href="#listNamedSets_next">listNamedSets_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#listRoutePolicies">listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves a list of router route policy subresources available to the</p> | |
| <p class="toc_element"> | |
| <code><a href="#listRoutePolicies_next">listRoutePolicies_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#patch">patch(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Patches the specified Router resource with the data included in the</p> | |
| <p class="toc_element"> | |
| <code><a href="#patchNamedSet">patchNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Patches Named Set</p> | |
| <p class="toc_element"> | |
| <code><a href="#patchRoutePolicy">patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Patches Route Policy</p> | |
| <p class="toc_element"> | |
| <code><a href="#preview">preview(project, region, router, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Preview fields auto-generated during router create andupdate operations.</p> | |
| <p class="toc_element"> | |
| <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Returns permissions that a caller has on the specified resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="#update">update(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Updates the specified Router resource with the data included in the</p> | |
| <p class="toc_element"> | |
| <code><a href="#updateNamedSet">updateNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Updates or creates new Named Set</p> | |
| <p class="toc_element"> | |
| <code><a href="#updateRoutePolicy">updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Updates or creates new Route Policy</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code> | |
| <pre>Retrieves an aggregated list of routers. | |
| To prevent failure, Google recommends that you set the | |
| `returnPartialSuccess` parameter to `true`. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| filter: string, A filter expression that filters resources listed in the response. Most | |
| Compute resources support two types of filter expressions: | |
| expressions that support regular expressions and expressions that follow | |
| API improvement proposal AIP-160. | |
| These two types of filter expressions cannot be mixed in one request. | |
| If you want to use AIP-160, your expression must specify the field name, an | |
| operator, and the value that you want to use for filtering. The value | |
| must be a string, a number, or a boolean. The operator | |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. | |
| For example, if you are filtering Compute Engine instances, you can | |
| exclude instances named `example-instance` by specifying | |
| `name != example-instance`. | |
| The `:*` comparison can be used to test whether a key has been defined. | |
| For example, to find all objects with `owner` label use: | |
| ``` | |
| labels.owner:* | |
| ``` | |
| You can also filter nested fields. For example, you could specify | |
| `scheduling.automaticRestart = false` to include instances only | |
| if they are not scheduled for automatic restarts. You can use filtering | |
| on nested fields to filter based onresource labels. | |
| To filter on multiple expressions, provide each separate expression within | |
| parentheses. For example: | |
| ``` | |
| (scheduling.automaticRestart = true) | |
| (cpuPlatform = "Intel Skylake") | |
| ``` | |
| By default, each expression is an `AND` expression. However, you | |
| can include `AND` and `OR` expressions explicitly. | |
| For example: | |
| ``` | |
| (cpuPlatform = "Intel Skylake") OR | |
| (cpuPlatform = "Intel Broadwell") AND | |
| (scheduling.automaticRestart = true) | |
| ``` | |
| If you want to use a regular expression, use the `eq` (equal) or `ne` | |
| (not equal) operator against a single un-parenthesized expression with or | |
| without quotes or against multiple parenthesized expressions. Examples: | |
| `fieldname eq unquoted literal` | |
| `fieldname eq 'single quoted literal'` | |
| `fieldname eq "double quoted literal"` | |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` | |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. | |
| The literal value must match the entire field. | |
| For example, to filter for instances that do not end with name "instance", | |
| you would use `name ne .*instance`. | |
| You cannot combine constraints on multiple fields using regular | |
| expressions. | |
| includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, | |
| global) should be included in the response. For new resource types added | |
| after this field, the flag has no effect as new resource types will always | |
| include every visible scope for each scope type in response. For resource | |
| types which predate this field, if this flag is omitted or false, only | |
| scopes of the scope types where the resource type is expected to be found | |
| will be included. | |
| maxResults: integer, The maximum number of results per page that should be returned. | |
| If the number of available results is larger than `maxResults`, | |
| Compute Engine returns a `nextPageToken` that can be used to get | |
| the next page of results in subsequent list requests. Acceptable values are | |
| `0` to `500`, inclusive. (Default: `500`) | |
| orderBy: string, Sorts list results by a certain order. By default, results | |
| are returned in alphanumerical order based on the resource name. | |
| You can also sort results in descending order based on the creation | |
| timestamp using `orderBy="creationTimestamp desc"`. This sorts | |
| results based on the `creationTimestamp` field in | |
| reverse chronological order (newest result first). Use this to sort | |
| resources like operations so that the newest operation is returned first. | |
| Currently, only sorting by `name` or | |
| `creationTimestamp desc` is supported. | |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the | |
| `nextPageToken` returned by a previous list request to get | |
| the next page of results. | |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case | |
| of failure. The default value is false. | |
| For example, when partial success behavior is enabled, aggregatedList for a | |
| single zone scope either returns all resources in the zone or no resources, | |
| with an error code. | |
| serviceProjectNumber: string, The Shared VPC service project id or service project number for which | |
| aggregated list request is invoked for subnetworks list-usable api. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Contains a list of routers. | |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. | |
| "items": { # A list of Router resources. | |
| "a_key": { # Name of the scope containing this set of routers. | |
| "routers": [ # A list of routers contained in this scope. | |
| { # Represents a Cloud Router resource. | |
| # | |
| # For more information about Cloud Router, read theCloud | |
| # Router overview. | |
| "bgp": { # BGP information specific to this router. | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| # The options are DEFAULT or CUSTOM. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These groups will be advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These IP ranges will be advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "asn": 42, # Local BGP Autonomous System Number (ASN). | |
| # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The | |
| # value will be fixed for this router resource. All VPN tunnels that link | |
| # to this router will have the same local ASN. | |
| "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It | |
| # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at | |
| # least /30, even if the BGP sessions are over IPv6. It must not overlap | |
| # with any IPv4 BGP session ranges. | |
| # | |
| # | |
| # Other vendors commonly call this "router ID". | |
| "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are | |
| # sent to the peer. | |
| # | |
| # | |
| # Hold time is three times the interval at which keepalive messages are | |
| # sent, and the hold time is the maximum number of seconds allowed to | |
| # elapse between successive keepalive messages that BGP receives from a | |
| # peer. | |
| # | |
| # | |
| # BGP will use the smaller of either the local hold time value or the | |
| # peer's hold time value as the hold time for the BGP connection between | |
| # the two peers. | |
| # | |
| # | |
| # If set, this value must be between 20 and 60. The default is 20. | |
| }, | |
| "bgpPeers": [ # BGP information that must be configured into the routing stack to | |
| # establish BGP peering. This information must specify the peer ASN and | |
| # either the interface name, IP address, or peer IP address. Please refer toRFC4273. | |
| { | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, | |
| # which currently supports the following option: | |
| # | |
| # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This | |
| # excludes any routes learned for subnets that use | |
| # VPC Network Peering. | |
| # | |
| # | |
| # Note that this field can only be populated if advertise_mode is CUSTOM | |
| # and overrides the list defined for the router (in the "bgp" message). | |
| # These groups are advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # overrides the list defined for the router (in the "bgp" message). | |
| # These IP ranges are advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more | |
| # than one matching route of maximum length, the routes with the lowest | |
| # priority value win. | |
| "bfd": { # BFD configuration for the BGP peering. | |
| "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # received from the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # transmit interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # corresponding receive interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "mode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. | |
| "multiplier": 42, # The number of consecutive BFD packets that must be missed | |
| # before BFD declares that a peer is unavailable. | |
| # | |
| # | |
| # If set, the value must be a value between 5 and 16. | |
| # | |
| # | |
| # The default is 5. | |
| "packetMode": "A String", # The BFD packet mode for this BGP peer. | |
| # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. | |
| # In this mode, if the peer router also has BFD echo mode enabled, BFD | |
| # echo packets will be sent to the other router. If the peer router does | |
| # not have BFD echo mode enabled, only control packets will be sent. If | |
| # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If | |
| # this router and the peer router have a multihop connection, this should | |
| # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop | |
| # connections. The default is CONTROL_AND_ECHO. | |
| "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # | |
| # | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. | |
| "slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to and received from the peer router when BFD echo mode is | |
| # enabled on both routers. The actual transmit and receive intervals are | |
| # negotiated between the two routers and are equal to the greater of this | |
| # value and the corresponding interval on the other router. | |
| # If set, this value must be between 1000 and 30000. | |
| # The default is 5000. | |
| }, | |
| "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP | |
| # session. | |
| { | |
| "range": "A String", # The custom learned route IP address range. Must be a valid | |
| # CIDR-formatted prefix. If an IP address is provided without a subnet | |
| # mask, it is interpreted as, for IPv4, a `/32` singular IP address | |
| # range, and, for IPv6, `/128`. | |
| }, | |
| ], | |
| "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This | |
| # value is applied to all custom learned route ranges for the session. | |
| # You can choose a value from `0` to `65335`. If you don't provide a | |
| # value, Google Cloud assigns a priority of `100` to the ranges. | |
| "enable": "A String", # The status of the BGP peer connection. | |
| # | |
| # | |
| # If set to FALSE, any active session with the peer is terminated and | |
| # all associated routing information is removed. If set to TRUE, the | |
| # peer connection can be established with routing information. The default | |
| # is TRUE. | |
| "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if | |
| # the peerIpAddress is version 4. | |
| "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the | |
| # peerIpAddress is version 6. | |
| "exportPolicies": [ # List of export policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_EXPORT type. | |
| "A String", | |
| ], | |
| "importPolicies": [ # List of import policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_IMPORT type. | |
| "A String", | |
| ], | |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. | |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. | |
| "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. | |
| "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. | |
| "linkedCustomHardware": "A String", # The linked custom hardware resource. | |
| # The URI of the custom hardware link attachment | |
| # is where you will establish the BGP session from the Cloud Router. | |
| # This link attachment must reside in the same subnetwork as the associated | |
| # router interface. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed by you | |
| # or other users | |
| # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed | |
| # by Cloud Interconnect, specifically by an InterconnectAttachment of type | |
| # PARTNER. Google automatically creates, updates, and deletes this type of | |
| # BGP peer when the PARTNER InterconnectAttachment is created, updated, | |
| # or deleted. | |
| "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the | |
| # name of one of the entries in the Router.md5_authentication_keys. The | |
| # field must comply with RFC1035. | |
| "name": "A String", # Name of this BGP peer. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use | |
| # a different value. | |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. | |
| "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router | |
| # appliances such as Next Gen Firewalls, Virtual Routers, or Router | |
| # Appliances. The VM instance must be located in zones contained in the | |
| # same region as this Cloud Router. | |
| # The VM instance is the peer side of the BGP session. | |
| }, | |
| ], | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN | |
| # attachments (interconnectAttachments). | |
| "etag": "A String", # ETag for optimistic concurrency control as described by AIP 154. Used to | |
| # prevent conflicting updates. If provided, the request will succeed only if | |
| # the etag matches the current etag of the router; otherwise, the request | |
| # fails with an ABORTED error. | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "interfaces": [ # Router interfaces. | |
| # To create a BGP peer that uses a router interface, | |
| # the interface must have one of the following fields specified: | |
| # | |
| # - linkedVpnTunnel | |
| # - linkedInterconnectAttachment | |
| # - subnetwork | |
| # | |
| # | |
| # You can create a router interface without any of these fields specified. | |
| # However, you cannot create a BGP peer that uses that interface. | |
| { | |
| "ipRange": "A String", # IP address and range of the interface. | |
| # | |
| # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must | |
| # be a CIDR-formatted string, for example, 169.254.0.1/30. | |
| # Note: Do not truncate the IP address, as it represents the IP address of | |
| # the interface. | |
| # - For Internet Protocol version 6 (IPv6), the value | |
| # must be a unique local address (ULA) range from fdff:1::/64 | |
| # with a mask length of 126 or less. This value should be a CIDR-formatted | |
| # string, for example, fdff:1::1/112. Within the router's | |
| # VPC, this IPv6 prefix will be reserved exclusively for this connection | |
| # and cannot be used for any other purpose. | |
| "ipVersion": "A String", # IP version of this interface. | |
| "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region | |
| # as the router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the | |
| # router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed directly | |
| # by users. | |
| # - MANAGED_BY_ATTACHMENT is an interface that is configured and | |
| # managed by Cloud Interconnect, specifically, by an InterconnectAttachment | |
| # of type PARTNER. Google automatically creates, updates, and deletes | |
| # this type of interface when the PARTNER InterconnectAttachment is | |
| # created, updated, or deleted. | |
| "name": "A String", # Name of this interface entry. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "privateIpAddress": "A String", # The regional private internal IP address that is used to establish | |
| # BGP sessions to a VM instance acting as a third-party | |
| # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or | |
| # an SD-WAN VM. | |
| "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface | |
| # you are creating. The redundantInterface must belong to the same Cloud | |
| # Router as the interface here. To establish the BGP session to a Router | |
| # Appliance VM, you must create two BGP peers. The two BGP peers must be | |
| # attached to two separate interfaces that are redundant with each other. | |
| # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must | |
| # be 1-63 characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which | |
| # must be in the same region as the Cloud Router. | |
| # When you establish a BGP session to a VM instance using this interface, | |
| # the VM instance must belong to the same subnetwork as the subnetwork | |
| # specified here. | |
| }, | |
| ], | |
| "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for | |
| # routers. | |
| "md5AuthenticationKeys": [ # Keys used for MD5 authentication. | |
| { | |
| "key": "A String", # [Input only] Value of the key. | |
| # | |
| # For patch and update calls, it can be skipped to | |
| # copy the value from the previous configuration. This is allowed if the | |
| # key with the same name existed before the operation. Maximum length is 80 | |
| # characters. Can only contain printable ASCII characters. | |
| "name": "A String", # Name used to identify the key. | |
| # | |
| # Must be unique within a router. Must be referenced by exactly | |
| # one bgpPeer. Must comply withRFC1035. | |
| }, | |
| ], | |
| "name": "A String", # Name of the resource. Provided by the client when the resource is created. | |
| # The name must be 1-63 characters long, and comply withRFC1035. | |
| # Specifically, the name must be 1-63 characters long and match the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first | |
| # character must be a lowercase letter, and all following characters must | |
| # be a dash, lowercase letter, or digit, except the last character, which | |
| # cannot be a dash. | |
| "nats": [ # A list of NAT services created in this router. | |
| { # Represents a Nat resource. It enables the VMs within the specified | |
| # subnetworks to access Internet without external IP addresses. It specifies | |
| # a list of subnetworks (and the ranges within) that want to use NAT. | |
| # Customers can also provide the external IPs that would be used for NAT. GCP | |
| # would auto-allocate ephemeral IPs if no external IPs are provided. | |
| "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. | |
| # Must be one of: PREMIUM, STANDARD. | |
| # If not specified, then the current | |
| # project-level default tier is used. | |
| "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT only. | |
| "A String", | |
| ], | |
| "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT | |
| # state. This value is equal to tcp_time_wait_timeout_sec. | |
| # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or | |
| # 120s. The field is output only. | |
| "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. | |
| # | |
| # | |
| # If not specified, it is disabled by default. | |
| # | |
| # | |
| # If set to true, | |
| # | |
| # - Dynamic Port Allocation will be enabled on this NAT | |
| # config. | |
| # - enableEndpointIndependentMapping cannot be set to true. | |
| # - If minPorts is set, minPortsPerVm must be set to a | |
| # power of two greater than or equal to 32. If minPortsPerVm is not set, a | |
| # minimum of 32 ports will be allocated to a VM from this NAT | |
| # config. | |
| "enableEndpointIndependentMapping": True or False, | |
| "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list | |
| # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM | |
| "A String", | |
| ], | |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. | |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. | |
| "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, | |
| # logs are exported for all connections handled by this NAT. | |
| # This option can take one of the following values: | |
| # | |
| # - ERRORS_ONLY: Export logs only for connection failures. | |
| # - TRANSLATIONS_ONLY: Export logs only for successful | |
| # connections. | |
| # - ALL: Export logs for all connections, successful and | |
| # unsuccessful. | |
| }, | |
| "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when | |
| # Dynamic Port Allocation is enabled. | |
| # | |
| # | |
| # If Dynamic Port Allocation is not enabled, this field has no effect. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled, and this field is set, it must be | |
| # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm | |
| # is not set. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled and this field is not set, | |
| # a maximum of 65536 ports will be allocated to a VM from this NAT | |
| # config. | |
| "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not | |
| # set, a default number of ports is allocated to a VM. This is rounded | |
| # up to the nearest power of 2. For example, if the value of this field is | |
| # 50, at least 64 ports are allocated to a VM. | |
| "name": "A String", # Unique name of this Nat service. | |
| # The name must be 1-63 characters long and comply withRFC1035. | |
| "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64 | |
| # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is | |
| # selected for the SubnetworkIpRangeToNat64Option above. | |
| { # Specifies a subnetwork to enable NAT64. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT64. | |
| }, | |
| ], | |
| "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following | |
| # values: | |
| # | |
| # - MANUAL_ONLY: Uses only Nat IP addresses provided by | |
| # customers. When there are not enough specified Nat IPs, the Nat service | |
| # fails for new VMs. | |
| # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers | |
| # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should | |
| # be empty. | |
| "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| "A String", | |
| ], | |
| "rules": [ # A list of rules associated with this NAT. | |
| { | |
| "action": { # The action to be enforced for traffic that matches this rule. | |
| "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this | |
| # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT rule only. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be | |
| # drained. This is only supported on patch/update, and these | |
| # subnetworks must have previously been used as active ranges in this | |
| # NAT Rule. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| }, | |
| "description": "A String", # An optional description of this rule. | |
| "match": "A String", # CEL expression that specifies the match condition that egress traffic | |
| # from a VM is evaluated against. If it evaluates to true, the | |
| # corresponding `action` is enforced. | |
| # | |
| # The following examples are valid match expressions for public NAT: | |
| # | |
| # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, | |
| # '2.2.0.0/16')` | |
| # | |
| # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` | |
| # | |
| # The following examples are valid match expressions for private NAT: | |
| # | |
| # (NAT 44) | |
| # `nexthop.hub == | |
| # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` | |
| # | |
| # `nexthop.is_hybrid` | |
| # | |
| # (NAT 64) | |
| # `isIPv6(source.ip)` | |
| "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number | |
| # must be a positive value between 0 and 65000, and | |
| # must be unique among rules within a NAT. | |
| "sourceWorkloadIdentities": [ # A list of source workload identities. | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: | |
| # | |
| # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every | |
| # Subnetwork are allowed to Nat. | |
| # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges | |
| # in every Subnetwork are allowed to Nat. | |
| # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field subnetwork below) | |
| # | |
| # | |
| # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. | |
| # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there | |
| # should not be any other Router.Nat section in any Router for this network | |
| # in this region. | |
| "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following | |
| # values: | |
| # | |
| # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in | |
| # every Subnetwork are allowed to Nat. | |
| # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field nat64_subnetwork below) | |
| # | |
| # | |
| # The default is NAT64_OPTION_UNSPECIFIED. | |
| # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other | |
| # Router.Nat section in this region can also enable NAT64 for any | |
| # Subnetworks in this network. Other Router.Nat sections can still be | |
| # present to enable NAT44 only. | |
| "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT | |
| # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the | |
| # SubnetworkIpRangeToNatOption above. | |
| { # Defines the IP ranges that want to use NAT for a subnetwork. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT. | |
| "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to | |
| # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" | |
| # is one of the values in source_ip_ranges_to_nat. | |
| "A String", | |
| ], | |
| "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All | |
| # options of a single value are valid except | |
| # NAT_IP_RANGE_OPTION_UNSPECIFIED. | |
| # The only valid option with multiple values is: ["PRIMARY_IP_RANGE", | |
| # "LIST_OF_SECONDARY_IP_RANGES"] | |
| # Default: [ALL_IP_RANGES] | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s | |
| # if not set. | |
| "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. | |
| # Defaults to 120s if not set. | |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if | |
| # not set. | |
| "type": "A String", # Indicates whether this NAT is used for public or private IP | |
| # translation. If unspecified, it defaults to PUBLIC. | |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. | |
| }, | |
| ], | |
| "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. | |
| "network": "A String", # URI of the network to which this router belongs. | |
| "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted | |
| # as part of resource payload. | |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. | |
| # The field is allowed for INSERT | |
| # only. The keys/values to set on the resource should be specified in | |
| # either ID { : } or Namespaced format | |
| # { : }. | |
| # For example the following are valid inputs: | |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} | |
| # * {"123/environment" : "production", "345/abc" : "xyz"} | |
| # Note: | |
| # * Invalid combinations of ID & namespaced format is not supported. For | |
| # instance: {"123/environment" : "tagValues/444"} is invalid. | |
| # * Inconsistent format is not supported. For instance: | |
| # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| "region": "A String", # [Output Only] URI of the region where the router resides. | |
| # You must specify this field as part of the HTTP request URL. It is | |
| # not settable as a field in the request body. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| }, | |
| ], | |
| "warning": { # Informational warning which replaces the list of routers when | |
| # the list is empty. | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| }, | |
| }, | |
| "kind": "compute#routerAggregatedList", # Output only. Type of resource. | |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for | |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for | |
| # the query parameter pageToken in the next list request. | |
| # Subsequent list requests will have their own nextPageToken to | |
| # continue paging through the results. | |
| "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. | |
| "unreachables": [ # Output only. [Output Only] Unreachable resources. | |
| "A String", | |
| ], | |
| "warning": { # [Output Only] Informational warning message. | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(project, region, router, etag=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Deletes the specified Router resource. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource to delete. (required) | |
| etag: string, ETag for optimistic concurrency control as described by AIP 154. Used to | |
| prevent conflicting updates. If provided, the request will succeed only if | |
| the etag matches the current etag of the router; otherwise, the request | |
| fails with an ABORTED error. | |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so | |
| that if you must retry your request, the server will know to ignore the | |
| request if it has already been completed. | |
| For example, consider a situation where you make an initial request and | |
| the request times out. If you make the request again with the same | |
| request ID, the server can check if original operation with the same | |
| request ID was received, and if so, will ignore the second request. This | |
| prevents clients from accidentally creating duplicate commitments. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the | |
| # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule | |
| # methods if not explicitly provided by the user. | |
| "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query | |
| # parameters specified minPriority/maxPriority. | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error | |
| # status code that was returned. For example, a `404` means the | |
| # resource was not found. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. | |
| # There is no requirement that this be linear or support any granularity of | |
| # operations. This should not be used to guess when the operation will be | |
| # complete. This number should monotonically increase as the operation | |
| # progresses. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For | |
| # operations related to creating a snapshot, this points to the disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="deleteNamedSet">deleteNamedSet(project, region, router, namedSet=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Deletes Named Set | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource where Named Set is defined. (required) | |
| namedSet: string, The Named Set name for this request. Name must conform to RFC1035 | |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so | |
| that if you must retry your request, the server will know to ignore the | |
| request if it has already been completed. | |
| For example, consider a situation where you make an initial request and | |
| the request times out. If you make the request again with the same | |
| request ID, the server can check if original operation with the same | |
| request ID was received, and if so, will ignore the second request. This | |
| prevents clients from accidentally creating duplicate commitments. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the | |
| # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule | |
| # methods if not explicitly provided by the user. | |
| "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query | |
| # parameters specified minPriority/maxPriority. | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error | |
| # status code that was returned. For example, a `404` means the | |
| # resource was not found. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. | |
| # There is no requirement that this be linear or support any granularity of | |
| # operations. This should not be used to guess when the operation will be | |
| # complete. This number should monotonically increase as the operation | |
| # progresses. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For | |
| # operations related to creating a snapshot, this points to the disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="deleteRoutePolicy">deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Deletes Route Policy | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource where Route Policy is defined. (required) | |
| policy: string, The Policy name for this request. Name must conform to RFC1035 | |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so | |
| that if you must retry your request, the server will know to ignore the | |
| request if it has already been completed. | |
| For example, consider a situation where you make an initial request and | |
| the request times out. If you make the request again with the same | |
| request ID, the server can check if original operation with the same | |
| request ID was received, and if so, will ignore the second request. This | |
| prevents clients from accidentally creating duplicate commitments. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the | |
| # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule | |
| # methods if not explicitly provided by the user. | |
| "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query | |
| # parameters specified minPriority/maxPriority. | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error | |
| # status code that was returned. For example, a `404` means the | |
| # resource was not found. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. | |
| # There is no requirement that this be linear or support any granularity of | |
| # operations. This should not be used to guess when the operation will be | |
| # complete. This number should monotonically increase as the operation | |
| # progresses. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For | |
| # operations related to creating a snapshot, this points to the disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(project, region, router, x__xgafv=None)</code> | |
| <pre>Returns the specified Router resource. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource to return. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents a Cloud Router resource. | |
| # | |
| # For more information about Cloud Router, read theCloud | |
| # Router overview. | |
| "bgp": { # BGP information specific to this router. | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| # The options are DEFAULT or CUSTOM. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These groups will be advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These IP ranges will be advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "asn": 42, # Local BGP Autonomous System Number (ASN). | |
| # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The | |
| # value will be fixed for this router resource. All VPN tunnels that link | |
| # to this router will have the same local ASN. | |
| "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It | |
| # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at | |
| # least /30, even if the BGP sessions are over IPv6. It must not overlap | |
| # with any IPv4 BGP session ranges. | |
| # | |
| # | |
| # Other vendors commonly call this "router ID". | |
| "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are | |
| # sent to the peer. | |
| # | |
| # | |
| # Hold time is three times the interval at which keepalive messages are | |
| # sent, and the hold time is the maximum number of seconds allowed to | |
| # elapse between successive keepalive messages that BGP receives from a | |
| # peer. | |
| # | |
| # | |
| # BGP will use the smaller of either the local hold time value or the | |
| # peer's hold time value as the hold time for the BGP connection between | |
| # the two peers. | |
| # | |
| # | |
| # If set, this value must be between 20 and 60. The default is 20. | |
| }, | |
| "bgpPeers": [ # BGP information that must be configured into the routing stack to | |
| # establish BGP peering. This information must specify the peer ASN and | |
| # either the interface name, IP address, or peer IP address. Please refer toRFC4273. | |
| { | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, | |
| # which currently supports the following option: | |
| # | |
| # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This | |
| # excludes any routes learned for subnets that use | |
| # VPC Network Peering. | |
| # | |
| # | |
| # Note that this field can only be populated if advertise_mode is CUSTOM | |
| # and overrides the list defined for the router (in the "bgp" message). | |
| # These groups are advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # overrides the list defined for the router (in the "bgp" message). | |
| # These IP ranges are advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more | |
| # than one matching route of maximum length, the routes with the lowest | |
| # priority value win. | |
| "bfd": { # BFD configuration for the BGP peering. | |
| "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # received from the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # transmit interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # corresponding receive interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "mode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. | |
| "multiplier": 42, # The number of consecutive BFD packets that must be missed | |
| # before BFD declares that a peer is unavailable. | |
| # | |
| # | |
| # If set, the value must be a value between 5 and 16. | |
| # | |
| # | |
| # The default is 5. | |
| "packetMode": "A String", # The BFD packet mode for this BGP peer. | |
| # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. | |
| # In this mode, if the peer router also has BFD echo mode enabled, BFD | |
| # echo packets will be sent to the other router. If the peer router does | |
| # not have BFD echo mode enabled, only control packets will be sent. If | |
| # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If | |
| # this router and the peer router have a multihop connection, this should | |
| # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop | |
| # connections. The default is CONTROL_AND_ECHO. | |
| "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # | |
| # | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. | |
| "slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to and received from the peer router when BFD echo mode is | |
| # enabled on both routers. The actual transmit and receive intervals are | |
| # negotiated between the two routers and are equal to the greater of this | |
| # value and the corresponding interval on the other router. | |
| # If set, this value must be between 1000 and 30000. | |
| # The default is 5000. | |
| }, | |
| "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP | |
| # session. | |
| { | |
| "range": "A String", # The custom learned route IP address range. Must be a valid | |
| # CIDR-formatted prefix. If an IP address is provided without a subnet | |
| # mask, it is interpreted as, for IPv4, a `/32` singular IP address | |
| # range, and, for IPv6, `/128`. | |
| }, | |
| ], | |
| "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This | |
| # value is applied to all custom learned route ranges for the session. | |
| # You can choose a value from `0` to `65335`. If you don't provide a | |
| # value, Google Cloud assigns a priority of `100` to the ranges. | |
| "enable": "A String", # The status of the BGP peer connection. | |
| # | |
| # | |
| # If set to FALSE, any active session with the peer is terminated and | |
| # all associated routing information is removed. If set to TRUE, the | |
| # peer connection can be established with routing information. The default | |
| # is TRUE. | |
| "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if | |
| # the peerIpAddress is version 4. | |
| "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the | |
| # peerIpAddress is version 6. | |
| "exportPolicies": [ # List of export policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_EXPORT type. | |
| "A String", | |
| ], | |
| "importPolicies": [ # List of import policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_IMPORT type. | |
| "A String", | |
| ], | |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. | |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. | |
| "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. | |
| "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. | |
| "linkedCustomHardware": "A String", # The linked custom hardware resource. | |
| # The URI of the custom hardware link attachment | |
| # is where you will establish the BGP session from the Cloud Router. | |
| # This link attachment must reside in the same subnetwork as the associated | |
| # router interface. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed by you | |
| # or other users | |
| # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed | |
| # by Cloud Interconnect, specifically by an InterconnectAttachment of type | |
| # PARTNER. Google automatically creates, updates, and deletes this type of | |
| # BGP peer when the PARTNER InterconnectAttachment is created, updated, | |
| # or deleted. | |
| "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the | |
| # name of one of the entries in the Router.md5_authentication_keys. The | |
| # field must comply with RFC1035. | |
| "name": "A String", # Name of this BGP peer. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use | |
| # a different value. | |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. | |
| "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router | |
| # appliances such as Next Gen Firewalls, Virtual Routers, or Router | |
| # Appliances. The VM instance must be located in zones contained in the | |
| # same region as this Cloud Router. | |
| # The VM instance is the peer side of the BGP session. | |
| }, | |
| ], | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN | |
| # attachments (interconnectAttachments). | |
| "etag": "A String", # ETag for optimistic concurrency control as described by AIP 154. Used to | |
| # prevent conflicting updates. If provided, the request will succeed only if | |
| # the etag matches the current etag of the router; otherwise, the request | |
| # fails with an ABORTED error. | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "interfaces": [ # Router interfaces. | |
| # To create a BGP peer that uses a router interface, | |
| # the interface must have one of the following fields specified: | |
| # | |
| # - linkedVpnTunnel | |
| # - linkedInterconnectAttachment | |
| # - subnetwork | |
| # | |
| # | |
| # You can create a router interface without any of these fields specified. | |
| # However, you cannot create a BGP peer that uses that interface. | |
| { | |
| "ipRange": "A String", # IP address and range of the interface. | |
| # | |
| # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must | |
| # be a CIDR-formatted string, for example, 169.254.0.1/30. | |
| # Note: Do not truncate the IP address, as it represents the IP address of | |
| # the interface. | |
| # - For Internet Protocol version 6 (IPv6), the value | |
| # must be a unique local address (ULA) range from fdff:1::/64 | |
| # with a mask length of 126 or less. This value should be a CIDR-formatted | |
| # string, for example, fdff:1::1/112. Within the router's | |
| # VPC, this IPv6 prefix will be reserved exclusively for this connection | |
| # and cannot be used for any other purpose. | |
| "ipVersion": "A String", # IP version of this interface. | |
| "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region | |
| # as the router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the | |
| # router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed directly | |
| # by users. | |
| # - MANAGED_BY_ATTACHMENT is an interface that is configured and | |
| # managed by Cloud Interconnect, specifically, by an InterconnectAttachment | |
| # of type PARTNER. Google automatically creates, updates, and deletes | |
| # this type of interface when the PARTNER InterconnectAttachment is | |
| # created, updated, or deleted. | |
| "name": "A String", # Name of this interface entry. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "privateIpAddress": "A String", # The regional private internal IP address that is used to establish | |
| # BGP sessions to a VM instance acting as a third-party | |
| # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or | |
| # an SD-WAN VM. | |
| "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface | |
| # you are creating. The redundantInterface must belong to the same Cloud | |
| # Router as the interface here. To establish the BGP session to a Router | |
| # Appliance VM, you must create two BGP peers. The two BGP peers must be | |
| # attached to two separate interfaces that are redundant with each other. | |
| # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must | |
| # be 1-63 characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which | |
| # must be in the same region as the Cloud Router. | |
| # When you establish a BGP session to a VM instance using this interface, | |
| # the VM instance must belong to the same subnetwork as the subnetwork | |
| # specified here. | |
| }, | |
| ], | |
| "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for | |
| # routers. | |
| "md5AuthenticationKeys": [ # Keys used for MD5 authentication. | |
| { | |
| "key": "A String", # [Input only] Value of the key. | |
| # | |
| # For patch and update calls, it can be skipped to | |
| # copy the value from the previous configuration. This is allowed if the | |
| # key with the same name existed before the operation. Maximum length is 80 | |
| # characters. Can only contain printable ASCII characters. | |
| "name": "A String", # Name used to identify the key. | |
| # | |
| # Must be unique within a router. Must be referenced by exactly | |
| # one bgpPeer. Must comply withRFC1035. | |
| }, | |
| ], | |
| "name": "A String", # Name of the resource. Provided by the client when the resource is created. | |
| # The name must be 1-63 characters long, and comply withRFC1035. | |
| # Specifically, the name must be 1-63 characters long and match the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first | |
| # character must be a lowercase letter, and all following characters must | |
| # be a dash, lowercase letter, or digit, except the last character, which | |
| # cannot be a dash. | |
| "nats": [ # A list of NAT services created in this router. | |
| { # Represents a Nat resource. It enables the VMs within the specified | |
| # subnetworks to access Internet without external IP addresses. It specifies | |
| # a list of subnetworks (and the ranges within) that want to use NAT. | |
| # Customers can also provide the external IPs that would be used for NAT. GCP | |
| # would auto-allocate ephemeral IPs if no external IPs are provided. | |
| "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. | |
| # Must be one of: PREMIUM, STANDARD. | |
| # If not specified, then the current | |
| # project-level default tier is used. | |
| "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT only. | |
| "A String", | |
| ], | |
| "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT | |
| # state. This value is equal to tcp_time_wait_timeout_sec. | |
| # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or | |
| # 120s. The field is output only. | |
| "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. | |
| # | |
| # | |
| # If not specified, it is disabled by default. | |
| # | |
| # | |
| # If set to true, | |
| # | |
| # - Dynamic Port Allocation will be enabled on this NAT | |
| # config. | |
| # - enableEndpointIndependentMapping cannot be set to true. | |
| # - If minPorts is set, minPortsPerVm must be set to a | |
| # power of two greater than or equal to 32. If minPortsPerVm is not set, a | |
| # minimum of 32 ports will be allocated to a VM from this NAT | |
| # config. | |
| "enableEndpointIndependentMapping": True or False, | |
| "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list | |
| # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM | |
| "A String", | |
| ], | |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. | |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. | |
| "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, | |
| # logs are exported for all connections handled by this NAT. | |
| # This option can take one of the following values: | |
| # | |
| # - ERRORS_ONLY: Export logs only for connection failures. | |
| # - TRANSLATIONS_ONLY: Export logs only for successful | |
| # connections. | |
| # - ALL: Export logs for all connections, successful and | |
| # unsuccessful. | |
| }, | |
| "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when | |
| # Dynamic Port Allocation is enabled. | |
| # | |
| # | |
| # If Dynamic Port Allocation is not enabled, this field has no effect. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled, and this field is set, it must be | |
| # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm | |
| # is not set. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled and this field is not set, | |
| # a maximum of 65536 ports will be allocated to a VM from this NAT | |
| # config. | |
| "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not | |
| # set, a default number of ports is allocated to a VM. This is rounded | |
| # up to the nearest power of 2. For example, if the value of this field is | |
| # 50, at least 64 ports are allocated to a VM. | |
| "name": "A String", # Unique name of this Nat service. | |
| # The name must be 1-63 characters long and comply withRFC1035. | |
| "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64 | |
| # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is | |
| # selected for the SubnetworkIpRangeToNat64Option above. | |
| { # Specifies a subnetwork to enable NAT64. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT64. | |
| }, | |
| ], | |
| "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following | |
| # values: | |
| # | |
| # - MANUAL_ONLY: Uses only Nat IP addresses provided by | |
| # customers. When there are not enough specified Nat IPs, the Nat service | |
| # fails for new VMs. | |
| # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers | |
| # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should | |
| # be empty. | |
| "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| "A String", | |
| ], | |
| "rules": [ # A list of rules associated with this NAT. | |
| { | |
| "action": { # The action to be enforced for traffic that matches this rule. | |
| "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this | |
| # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT rule only. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be | |
| # drained. This is only supported on patch/update, and these | |
| # subnetworks must have previously been used as active ranges in this | |
| # NAT Rule. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| }, | |
| "description": "A String", # An optional description of this rule. | |
| "match": "A String", # CEL expression that specifies the match condition that egress traffic | |
| # from a VM is evaluated against. If it evaluates to true, the | |
| # corresponding `action` is enforced. | |
| # | |
| # The following examples are valid match expressions for public NAT: | |
| # | |
| # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, | |
| # '2.2.0.0/16')` | |
| # | |
| # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` | |
| # | |
| # The following examples are valid match expressions for private NAT: | |
| # | |
| # (NAT 44) | |
| # `nexthop.hub == | |
| # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` | |
| # | |
| # `nexthop.is_hybrid` | |
| # | |
| # (NAT 64) | |
| # `isIPv6(source.ip)` | |
| "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number | |
| # must be a positive value between 0 and 65000, and | |
| # must be unique among rules within a NAT. | |
| "sourceWorkloadIdentities": [ # A list of source workload identities. | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: | |
| # | |
| # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every | |
| # Subnetwork are allowed to Nat. | |
| # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges | |
| # in every Subnetwork are allowed to Nat. | |
| # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field subnetwork below) | |
| # | |
| # | |
| # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. | |
| # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there | |
| # should not be any other Router.Nat section in any Router for this network | |
| # in this region. | |
| "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following | |
| # values: | |
| # | |
| # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in | |
| # every Subnetwork are allowed to Nat. | |
| # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field nat64_subnetwork below) | |
| # | |
| # | |
| # The default is NAT64_OPTION_UNSPECIFIED. | |
| # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other | |
| # Router.Nat section in this region can also enable NAT64 for any | |
| # Subnetworks in this network. Other Router.Nat sections can still be | |
| # present to enable NAT44 only. | |
| "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT | |
| # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the | |
| # SubnetworkIpRangeToNatOption above. | |
| { # Defines the IP ranges that want to use NAT for a subnetwork. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT. | |
| "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to | |
| # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" | |
| # is one of the values in source_ip_ranges_to_nat. | |
| "A String", | |
| ], | |
| "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All | |
| # options of a single value are valid except | |
| # NAT_IP_RANGE_OPTION_UNSPECIFIED. | |
| # The only valid option with multiple values is: ["PRIMARY_IP_RANGE", | |
| # "LIST_OF_SECONDARY_IP_RANGES"] | |
| # Default: [ALL_IP_RANGES] | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s | |
| # if not set. | |
| "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. | |
| # Defaults to 120s if not set. | |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if | |
| # not set. | |
| "type": "A String", # Indicates whether this NAT is used for public or private IP | |
| # translation. If unspecified, it defaults to PUBLIC. | |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. | |
| }, | |
| ], | |
| "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. | |
| "network": "A String", # URI of the network to which this router belongs. | |
| "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted | |
| # as part of resource payload. | |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. | |
| # The field is allowed for INSERT | |
| # only. The keys/values to set on the resource should be specified in | |
| # either ID { : } or Namespaced format | |
| # { : }. | |
| # For example the following are valid inputs: | |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} | |
| # * {"123/environment" : "production", "345/abc" : "xyz"} | |
| # Note: | |
| # * Invalid combinations of ID & namespaced format is not supported. For | |
| # instance: {"123/environment" : "tagValues/444"} is invalid. | |
| # * Inconsistent format is not supported. For instance: | |
| # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| "region": "A String", # [Output Only] URI of the region where the router resides. | |
| # You must specify this field as part of the HTTP request URL. It is | |
| # not settable as a field in the request body. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="getNamedSet">getNamedSet(project, region, router, namedSet=None, x__xgafv=None)</code> | |
| <pre>Returns specified Named Set | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource to query for the named set. The name should | |
| conform to RFC1035. (required) | |
| namedSet: string, The Named Set name for this request. Name must conform to RFC1035 | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "etag": "A String", # end_interface: MixerGetResponseWithEtagBuilder | |
| "resource": { | |
| "description": "A String", # An optional description of named set. | |
| "elements": [ # CEL expressions that are comparable to constructs of this set's type | |
| # (see Policy Language). | |
| { # Represents a textual expression in the Common Expression Language (CEL) | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| ], | |
| "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is | |
| # essentially a hash of the Named Set used for optimistic locking. | |
| # The fingerprint is initially generated by Compute Engine and changes | |
| # after every request to modify or update the Named Set. You must always | |
| # provide an up-to-date fingerprint hash in order to update or change | |
| # labels. | |
| # | |
| # To see the latest fingerprint, make a getNamedSet() request | |
| # to retrieve a Named Set. | |
| "name": "A String", # This set's name, which must be a resource ID segment and unique within all | |
| # named sets owned by the Router. Name should conform to RFC1035. | |
| "type": "A String", # This named set's type | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="getNatIpInfo">getNatIpInfo(project, region, router, natName=None, x__xgafv=None)</code> | |
| <pre>Retrieves runtime NAT IP information. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource to query for Nat IP information. The name | |
| should conform to RFC1035. (required) | |
| natName: string, Name of the nat service to filter the NAT IP information. | |
| If it is omitted, all nats for this router will be returned. | |
| Name should conform to RFC1035. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "result": [ # [Output Only] A list of NAT IP information. | |
| { # Contains NAT IP information of a NAT config (i.e. usage status, mode). | |
| "natIpInfoMappings": [ # Output only. A list of all NAT IPs assigned to this NAT config. | |
| { # Contains information of a NAT IP. | |
| "mode": "A String", # Output only. Specifies whether NAT IP is auto or manual. | |
| "natIp": "A String", # Output only. NAT IP address. For example: 203.0.113.11. | |
| "usage": "A String", # Output only. Specifies whether NAT IP is currently serving at least one endpoint or | |
| # not. | |
| }, | |
| ], | |
| "natName": "A String", # Output only. Name of the NAT config which the NAT IP belongs to. | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, natName=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> | |
| <pre>Retrieves runtime Nat mapping information of VM endpoints. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource to query for Nat Mapping information of | |
| VM endpoints. (required) | |
| filter: string, A filter expression that filters resources listed in the response. Most | |
| Compute resources support two types of filter expressions: | |
| expressions that support regular expressions and expressions that follow | |
| API improvement proposal AIP-160. | |
| These two types of filter expressions cannot be mixed in one request. | |
| If you want to use AIP-160, your expression must specify the field name, an | |
| operator, and the value that you want to use for filtering. The value | |
| must be a string, a number, or a boolean. The operator | |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. | |
| For example, if you are filtering Compute Engine instances, you can | |
| exclude instances named `example-instance` by specifying | |
| `name != example-instance`. | |
| The `:*` comparison can be used to test whether a key has been defined. | |
| For example, to find all objects with `owner` label use: | |
| ``` | |
| labels.owner:* | |
| ``` | |
| You can also filter nested fields. For example, you could specify | |
| `scheduling.automaticRestart = false` to include instances only | |
| if they are not scheduled for automatic restarts. You can use filtering | |
| on nested fields to filter based onresource labels. | |
| To filter on multiple expressions, provide each separate expression within | |
| parentheses. For example: | |
| ``` | |
| (scheduling.automaticRestart = true) | |
| (cpuPlatform = "Intel Skylake") | |
| ``` | |
| By default, each expression is an `AND` expression. However, you | |
| can include `AND` and `OR` expressions explicitly. | |
| For example: | |
| ``` | |
| (cpuPlatform = "Intel Skylake") OR | |
| (cpuPlatform = "Intel Broadwell") AND | |
| (scheduling.automaticRestart = true) | |
| ``` | |
| If you want to use a regular expression, use the `eq` (equal) or `ne` | |
| (not equal) operator against a single un-parenthesized expression with or | |
| without quotes or against multiple parenthesized expressions. Examples: | |
| `fieldname eq unquoted literal` | |
| `fieldname eq 'single quoted literal'` | |
| `fieldname eq "double quoted literal"` | |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` | |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. | |
| The literal value must match the entire field. | |
| For example, to filter for instances that do not end with name "instance", | |
| you would use `name ne .*instance`. | |
| You cannot combine constraints on multiple fields using regular | |
| expressions. | |
| maxResults: integer, The maximum number of results per page that should be returned. | |
| If the number of available results is larger than `maxResults`, | |
| Compute Engine returns a `nextPageToken` that can be used to get | |
| the next page of results in subsequent list requests. Acceptable values are | |
| `0` to `500`, inclusive. (Default: `500`) | |
| natName: string, Name of the nat service to filter the Nat Mapping information. | |
| If it is omitted, all nats for this router will be returned. | |
| Name should conform to RFC1035. | |
| orderBy: string, Sorts list results by a certain order. By default, results | |
| are returned in alphanumerical order based on the resource name. | |
| You can also sort results in descending order based on the creation | |
| timestamp using `orderBy="creationTimestamp desc"`. This sorts | |
| results based on the `creationTimestamp` field in | |
| reverse chronological order (newest result first). Use this to sort | |
| resources like operations so that the newest operation is returned first. | |
| Currently, only sorting by `name` or | |
| `creationTimestamp desc` is supported. | |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the | |
| `nextPageToken` returned by a previous list request to get | |
| the next page of results. | |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case | |
| of failure. The default value is false. | |
| For example, when partial success behavior is enabled, aggregatedList for a | |
| single zone scope either returns all resources in the zone or no resources, | |
| with an error code. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Contains a list of VmEndpointNatMappings. | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "kind": "compute#vmEndpointNatMappingsList", # Output only. [Output Only] Type of resource. Alwayscompute#vmEndpointNatMappingsList for lists of Nat mappings of | |
| # VM endpoints. | |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for | |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for | |
| # the query parameter pageToken in the next list request. | |
| # Subsequent list requests will have their own nextPageToken to | |
| # continue paging through the results. | |
| "result": [ # [Output Only] A list of Nat mapping information of VM endpoints. | |
| { # Contain information of Nat mapping for a VM endpoint (i.e., NIC). | |
| "instanceName": "A String", # Output only. Name of the VM instance which the endpoint belongs to | |
| "interfaceNatMappings": [ | |
| { # Contain information of Nat mapping for an interface of this endpoint. | |
| "drainNatIpPortRanges": [ # Output only. List of all drain IP:port-range mappings assigned to this interface. | |
| # These ranges are inclusive, that is, both the first and the last | |
| # ports can be used for NAT. Example: ["2.2.2.2:12345-12355", | |
| # "1.1.1.1:2234-2234"]. | |
| "A String", | |
| ], | |
| "natIpPortRanges": [ # Output only. A list of all IP:port-range mappings assigned to this interface. | |
| # These ranges are inclusive, that is, both the first and the last | |
| # ports can be used for NAT. Example: ["2.2.2.2:12345-12355", | |
| # "1.1.1.1:2234-2234"]. | |
| "A String", | |
| ], | |
| "numTotalDrainNatPorts": 42, # Output only. Total number of drain ports across all NAT IPs allocated to this | |
| # interface. It equals to the aggregated port number in the field | |
| # drain_nat_ip_port_ranges. | |
| "numTotalNatPorts": 42, # Output only. Total number of ports across all NAT IPs allocated to this interface. | |
| # It equals to the aggregated port number in the field nat_ip_port_ranges. | |
| "ruleMappings": [ # Output only. Information about mappings provided by rules in this NAT. | |
| { # Contains information of NAT Mappings provided by a NAT Rule. | |
| "drainNatIpPortRanges": [ # Output only. List of all drain IP:port-range mappings assigned to this interface | |
| # by this rule. | |
| # These ranges are inclusive, that is, both the first and the last | |
| # ports can be used for NAT. Example: ["2.2.2.2:12345-12355", | |
| # "1.1.1.1:2234-2234"]. | |
| "A String", | |
| ], | |
| "natIpPortRanges": [ # Output only. A list of all IP:port-range mappings assigned to this interface by this | |
| # rule. | |
| # These ranges are inclusive, that is, both the first and the last | |
| # ports can be used for NAT. Example: ["2.2.2.2:12345-12355", | |
| # "1.1.1.1:2234-2234"]. | |
| "A String", | |
| ], | |
| "numTotalDrainNatPorts": 42, # Output only. Total number of drain ports across all NAT IPs allocated to this | |
| # interface by this rule. | |
| # It equals the aggregated port number in the field | |
| # drain_nat_ip_port_ranges. | |
| "numTotalNatPorts": 42, # Output only. Total number of ports across all NAT IPs allocated to this interface | |
| # by this rule. | |
| # It equals the aggregated port number in the field nat_ip_port_ranges. | |
| "ruleNumber": 42, # Output only. Rule number of the NAT Rule. | |
| }, | |
| ], | |
| "sourceAliasIpRange": "A String", # Output only. Alias IP range for this interface endpoint. | |
| # It will be a private (RFC 1918) IP range. | |
| # Examples: "10.33.4.55/32", or "192.168.5.0/24". | |
| "sourceVirtualIp": "A String", # Output only. Primary IP of the VM for this NIC. | |
| }, | |
| ], | |
| }, | |
| ], | |
| "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. | |
| "warning": { # [Output Only] Informational warning message. | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="getNatMappingInfo_next">getNatMappingInfo_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="getRoutePolicy">getRoutePolicy(project, region, router, policy=None, x__xgafv=None)</code> | |
| <pre>Returns specified Route Policy | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource to query for the route policy. The name should | |
| conform to RFC1035. (required) | |
| policy: string, The Policy name for this request. Name must conform to RFC1035 | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "etag": "A String", # end_interface: MixerGetResponseWithEtagBuilder | |
| "resource": { | |
| "description": "A String", # An optional description of route policy. | |
| "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is | |
| # essentially a hash of the Route Policy used for optimistic locking. | |
| # The fingerprint is initially generated by Compute Engine and changes | |
| # after every request to modify or update Route Policy. You must always | |
| # provide an up-to-date fingerprint hash in order to update or change | |
| # labels. | |
| # | |
| # To see the latest fingerprint, make a getRoutePolicy() request | |
| # to retrieve a Route Policy. | |
| "name": "A String", # Route Policy name, which must be a resource ID segment and unique | |
| # within all the router's Route Policies. Name should conform to RFC1035. | |
| "terms": [ # List of terms (the order in the list is not important, they are evaluated | |
| # in order of priority). Order of policies is not retained and might change | |
| # when getting policy later. | |
| { | |
| "actions": [ # CEL expressions to evaluate to modify a route when this term matches. | |
| { # Represents a textual expression in the Common Expression Language (CEL) | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| ], | |
| "match": { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term | |
| # applies. When not set, the term applies to all | |
| # routes. | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| "priority": 42, # The evaluation priority for this term, which must be between 0 | |
| # (inclusive) and 2^31 (exclusive), and unique within the list. | |
| }, | |
| ], | |
| "type": "A String", | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="getRouterStatus">getRouterStatus(project, region, router, x__xgafv=None)</code> | |
| <pre>Retrieves runtime information of the specified router. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource to query. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "kind": "compute#routerStatusResponse", # Output only. Type of resource. | |
| "result": { | |
| "bestRoutes": [ # A list of the best dynamic routes for this Cloud Router's Virtual Private | |
| # Cloud (VPC) network in the same region as this Cloud Router. | |
| # | |
| # Lists all of the best routes per prefix that are programmed into this | |
| # region's VPC data plane. | |
| # | |
| # When global dynamic routing mode is turned on in the VPC network, this list | |
| # can include cross-region dynamic routes from Cloud Routers in other | |
| # regions. | |
| { # Represents a Route resource. | |
| # | |
| # A route defines a path from VM instances in the VPC network to a specific | |
| # destination. This destination can be inside or outside the VPC network. | |
| # For more information, read theRoutes overview. | |
| "allowConflictingSubnetworks": True or False, # Whether this route can conflict with existing subnetworks. Setting this to | |
| # true allows this route to conflict with subnetworks that have already been | |
| # configured on the corresponding network. | |
| "asPaths": [ # Output only. [Output Only] AS path. | |
| { | |
| "asLists": [ # [Output Only] The AS numbers of the AS Path. | |
| 42, | |
| ], | |
| "pathSegmentType": "A String", # [Output Only] The type of the AS Path, which can be one of the following | |
| # values: | |
| # - 'AS_SET': unordered set of autonomous systems that the route | |
| # in has traversed | |
| # - 'AS_SEQUENCE': ordered set of autonomous | |
| # systems that the route has traversed | |
| # - 'AS_CONFED_SEQUENCE': | |
| # ordered set of Member Autonomous Systems in the local confederation that | |
| # the route has traversed | |
| # - 'AS_CONFED_SET': unordered set of | |
| # Member Autonomous Systems in the local confederation that the route has | |
| # traversed | |
| }, | |
| ], | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this field when you | |
| # create the resource. | |
| "destRange": "A String", # The destination range of outgoing packets that this route applies to. Both | |
| # IPv4 and IPv6 are supported. | |
| # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 | |
| # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 | |
| # compressed format. | |
| "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "ilbRouteBehaviorOnUnhealthy": "A String", # ILB route behavior when ILB is deemed unhealthy based on user specified | |
| # threshold on the Backend Service of the internal load balancing. | |
| "kind": "compute#route", # Output only. [Output Only] Type of this resource. Always compute#routes for | |
| # Route resources. | |
| "name": "A String", # Name of the resource. Provided by the client when the resource is created. | |
| # The name must be 1-63 characters long, and comply withRFC1035. | |
| # Specifically, the name must be 1-63 characters long and match the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a | |
| # lowercase letter, and all following characters (except for the last | |
| # character) must be a dash, lowercase letter, or digit. The last character | |
| # must be a lowercase letter or digit. | |
| "network": "A String", # Fully-qualified URL of the network that this route applies to. | |
| "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. | |
| # You can only specify the internet gateway using a full or | |
| # partial valid URL: projects/project/global/gateways/default-internet-gateway | |
| "nextHopHub": "A String", # Output only. [Output Only] The full resource name of the Network Connectivity Center hub | |
| # that will handle matching packets. | |
| "nextHopIlb": "A String", # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching | |
| # packets or the IP address of the forwarding Rule. | |
| # For example, the following are all valid URLs: | |
| # | |
| # | |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule | |
| # - regions/region/forwardingRules/forwardingRule | |
| # | |
| # | |
| # If an IP address is provided, must specify an IPv4 address in dot-decimal | |
| # notation or an IPv6 address in RFC 4291 format. For example, the following | |
| # are all valid IP addresses: | |
| # | |
| # | |
| # - 10.128.0.56 | |
| # - 2001:db8::2d9:51:0:0 | |
| # - 2001:db8:0:0:2d9:51:0:0 | |
| # | |
| # | |
| # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. | |
| # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. | |
| "nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify | |
| # this as a full or partial URL. | |
| # For example: | |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ | |
| "nextHopInterRegionCost": 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud | |
| # calculates based on factors such as network performance, distance, and | |
| # available bandwidth between regions. | |
| "nextHopInterconnectAttachment": "A String", # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop | |
| # for the route. | |
| # This field will only be populated for dynamic routes generated by | |
| # Cloud Router with a linked interconnectAttachment or the static route | |
| # generated by each L2 Interconnect Attachment. | |
| "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. | |
| # Both IPv6 address and IPv4 addresses are supported. | |
| # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or | |
| # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or | |
| # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 | |
| # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an | |
| # IPv4-mapped IPv6 address. | |
| "nextHopMed": 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates | |
| # the desirability of a particular route in a network. | |
| "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets. | |
| "nextHopOrigin": "A String", # Output only. [Output Only] Indicates the origin of the route. Can be IGP | |
| # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), | |
| # or INCOMPLETE. | |
| "nextHopPeering": "A String", # Output only. [Output Only] The network peering name that should handle matching packets, | |
| # which should conform to RFC1035. | |
| "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets. | |
| "params": { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted | |
| # as part of resource payload. | |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. | |
| # Tag keys and values have the same definition as resource | |
| # manager tags. The field is allowed for INSERT | |
| # only. The keys/values to set on the resource should be specified in | |
| # either ID { : } or Namespaced format | |
| # { : }. | |
| # For example the following are valid inputs: | |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} | |
| # * {"123/environment" : "production", "345/abc" : "xyz"} | |
| # Note: | |
| # * Invalid combinations of ID & namespaced format is not supported. For | |
| # instance: {"123/environment" : "tagValues/444"} is invalid. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| "priority": 42, # The priority of this route. Priority is used to break ties in cases | |
| # where there is more than one matching route of equal prefix length. In | |
| # cases where multiple routes have equal prefix length, the one with the | |
| # lowest-numbered priority value wins. The default value is `1000`. The | |
| # priority value must be from `0` to `65535`, inclusive. | |
| "routeStatus": "A String", # [Output only] The status of the route. This status applies to | |
| # dynamic routes learned by Cloud Routers. It is also applicable to routes | |
| # undergoing migration. | |
| "routeType": "A String", # Output only. [Output Only] The type of this route, which can be one of the following | |
| # values: | |
| # - 'TRANSIT' for a transit route that this router learned from | |
| # another Cloud Router and will readvertise to one of its BGP peers | |
| # - 'SUBNET' for a route from a subnet of the VPC | |
| # - 'BGP' for a route learned from a BGP peer of this router | |
| # - 'STATIC' for a static route | |
| "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "tags": [ # A list of instance tags to which this route applies. | |
| "A String", | |
| ], | |
| "warnings": [ # Output only. [Output Only] If potential misconfigurations are detected for this | |
| # route, this field will be populated with warning messages. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| }, | |
| ], | |
| "bestRoutesForRouter": [ # A list of the best BGP routes learned by this Cloud Router. | |
| # | |
| # It is possible that routes listed might not be programmed into the data | |
| # plane, if the Google Cloud control plane finds a more optimal route for a | |
| # prefix than a route learned by this Cloud Router. | |
| { # Represents a Route resource. | |
| # | |
| # A route defines a path from VM instances in the VPC network to a specific | |
| # destination. This destination can be inside or outside the VPC network. | |
| # For more information, read theRoutes overview. | |
| "allowConflictingSubnetworks": True or False, # Whether this route can conflict with existing subnetworks. Setting this to | |
| # true allows this route to conflict with subnetworks that have already been | |
| # configured on the corresponding network. | |
| "asPaths": [ # Output only. [Output Only] AS path. | |
| { | |
| "asLists": [ # [Output Only] The AS numbers of the AS Path. | |
| 42, | |
| ], | |
| "pathSegmentType": "A String", # [Output Only] The type of the AS Path, which can be one of the following | |
| # values: | |
| # - 'AS_SET': unordered set of autonomous systems that the route | |
| # in has traversed | |
| # - 'AS_SEQUENCE': ordered set of autonomous | |
| # systems that the route has traversed | |
| # - 'AS_CONFED_SEQUENCE': | |
| # ordered set of Member Autonomous Systems in the local confederation that | |
| # the route has traversed | |
| # - 'AS_CONFED_SET': unordered set of | |
| # Member Autonomous Systems in the local confederation that the route has | |
| # traversed | |
| }, | |
| ], | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this field when you | |
| # create the resource. | |
| "destRange": "A String", # The destination range of outgoing packets that this route applies to. Both | |
| # IPv4 and IPv6 are supported. | |
| # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 | |
| # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 | |
| # compressed format. | |
| "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "ilbRouteBehaviorOnUnhealthy": "A String", # ILB route behavior when ILB is deemed unhealthy based on user specified | |
| # threshold on the Backend Service of the internal load balancing. | |
| "kind": "compute#route", # Output only. [Output Only] Type of this resource. Always compute#routes for | |
| # Route resources. | |
| "name": "A String", # Name of the resource. Provided by the client when the resource is created. | |
| # The name must be 1-63 characters long, and comply withRFC1035. | |
| # Specifically, the name must be 1-63 characters long and match the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a | |
| # lowercase letter, and all following characters (except for the last | |
| # character) must be a dash, lowercase letter, or digit. The last character | |
| # must be a lowercase letter or digit. | |
| "network": "A String", # Fully-qualified URL of the network that this route applies to. | |
| "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. | |
| # You can only specify the internet gateway using a full or | |
| # partial valid URL: projects/project/global/gateways/default-internet-gateway | |
| "nextHopHub": "A String", # Output only. [Output Only] The full resource name of the Network Connectivity Center hub | |
| # that will handle matching packets. | |
| "nextHopIlb": "A String", # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching | |
| # packets or the IP address of the forwarding Rule. | |
| # For example, the following are all valid URLs: | |
| # | |
| # | |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule | |
| # - regions/region/forwardingRules/forwardingRule | |
| # | |
| # | |
| # If an IP address is provided, must specify an IPv4 address in dot-decimal | |
| # notation or an IPv6 address in RFC 4291 format. For example, the following | |
| # are all valid IP addresses: | |
| # | |
| # | |
| # - 10.128.0.56 | |
| # - 2001:db8::2d9:51:0:0 | |
| # - 2001:db8:0:0:2d9:51:0:0 | |
| # | |
| # | |
| # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. | |
| # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. | |
| "nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify | |
| # this as a full or partial URL. | |
| # For example: | |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ | |
| "nextHopInterRegionCost": 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud | |
| # calculates based on factors such as network performance, distance, and | |
| # available bandwidth between regions. | |
| "nextHopInterconnectAttachment": "A String", # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop | |
| # for the route. | |
| # This field will only be populated for dynamic routes generated by | |
| # Cloud Router with a linked interconnectAttachment or the static route | |
| # generated by each L2 Interconnect Attachment. | |
| "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. | |
| # Both IPv6 address and IPv4 addresses are supported. | |
| # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or | |
| # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or | |
| # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 | |
| # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an | |
| # IPv4-mapped IPv6 address. | |
| "nextHopMed": 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates | |
| # the desirability of a particular route in a network. | |
| "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets. | |
| "nextHopOrigin": "A String", # Output only. [Output Only] Indicates the origin of the route. Can be IGP | |
| # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), | |
| # or INCOMPLETE. | |
| "nextHopPeering": "A String", # Output only. [Output Only] The network peering name that should handle matching packets, | |
| # which should conform to RFC1035. | |
| "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets. | |
| "params": { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted | |
| # as part of resource payload. | |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. | |
| # Tag keys and values have the same definition as resource | |
| # manager tags. The field is allowed for INSERT | |
| # only. The keys/values to set on the resource should be specified in | |
| # either ID { : } or Namespaced format | |
| # { : }. | |
| # For example the following are valid inputs: | |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} | |
| # * {"123/environment" : "production", "345/abc" : "xyz"} | |
| # Note: | |
| # * Invalid combinations of ID & namespaced format is not supported. For | |
| # instance: {"123/environment" : "tagValues/444"} is invalid. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| "priority": 42, # The priority of this route. Priority is used to break ties in cases | |
| # where there is more than one matching route of equal prefix length. In | |
| # cases where multiple routes have equal prefix length, the one with the | |
| # lowest-numbered priority value wins. The default value is `1000`. The | |
| # priority value must be from `0` to `65535`, inclusive. | |
| "routeStatus": "A String", # [Output only] The status of the route. This status applies to | |
| # dynamic routes learned by Cloud Routers. It is also applicable to routes | |
| # undergoing migration. | |
| "routeType": "A String", # Output only. [Output Only] The type of this route, which can be one of the following | |
| # values: | |
| # - 'TRANSIT' for a transit route that this router learned from | |
| # another Cloud Router and will readvertise to one of its BGP peers | |
| # - 'SUBNET' for a route from a subnet of the VPC | |
| # - 'BGP' for a route learned from a BGP peer of this router | |
| # - 'STATIC' for a static route | |
| "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "tags": [ # A list of instance tags to which this route applies. | |
| "A String", | |
| ], | |
| "warnings": [ # Output only. [Output Only] If potential misconfigurations are detected for this | |
| # route, this field will be populated with warning messages. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| }, | |
| ], | |
| "bgpPeerStatus": [ | |
| { | |
| "advertisedRoutes": [ # Routes that were advertised to the remote BGP peer | |
| { # Represents a Route resource. | |
| # | |
| # A route defines a path from VM instances in the VPC network to a specific | |
| # destination. This destination can be inside or outside the VPC network. | |
| # For more information, read theRoutes overview. | |
| "allowConflictingSubnetworks": True or False, # Whether this route can conflict with existing subnetworks. Setting this to | |
| # true allows this route to conflict with subnetworks that have already been | |
| # configured on the corresponding network. | |
| "asPaths": [ # Output only. [Output Only] AS path. | |
| { | |
| "asLists": [ # [Output Only] The AS numbers of the AS Path. | |
| 42, | |
| ], | |
| "pathSegmentType": "A String", # [Output Only] The type of the AS Path, which can be one of the following | |
| # values: | |
| # - 'AS_SET': unordered set of autonomous systems that the route | |
| # in has traversed | |
| # - 'AS_SEQUENCE': ordered set of autonomous | |
| # systems that the route has traversed | |
| # - 'AS_CONFED_SEQUENCE': | |
| # ordered set of Member Autonomous Systems in the local confederation that | |
| # the route has traversed | |
| # - 'AS_CONFED_SET': unordered set of | |
| # Member Autonomous Systems in the local confederation that the route has | |
| # traversed | |
| }, | |
| ], | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this field when you | |
| # create the resource. | |
| "destRange": "A String", # The destination range of outgoing packets that this route applies to. Both | |
| # IPv4 and IPv6 are supported. | |
| # Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 | |
| # format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 | |
| # compressed format. | |
| "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "ilbRouteBehaviorOnUnhealthy": "A String", # ILB route behavior when ILB is deemed unhealthy based on user specified | |
| # threshold on the Backend Service of the internal load balancing. | |
| "kind": "compute#route", # Output only. [Output Only] Type of this resource. Always compute#routes for | |
| # Route resources. | |
| "name": "A String", # Name of the resource. Provided by the client when the resource is created. | |
| # The name must be 1-63 characters long, and comply withRFC1035. | |
| # Specifically, the name must be 1-63 characters long and match the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a | |
| # lowercase letter, and all following characters (except for the last | |
| # character) must be a dash, lowercase letter, or digit. The last character | |
| # must be a lowercase letter or digit. | |
| "network": "A String", # Fully-qualified URL of the network that this route applies to. | |
| "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. | |
| # You can only specify the internet gateway using a full or | |
| # partial valid URL: projects/project/global/gateways/default-internet-gateway | |
| "nextHopHub": "A String", # Output only. [Output Only] The full resource name of the Network Connectivity Center hub | |
| # that will handle matching packets. | |
| "nextHopIlb": "A String", # The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching | |
| # packets or the IP address of the forwarding Rule. | |
| # For example, the following are all valid URLs: | |
| # | |
| # | |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule | |
| # - regions/region/forwardingRules/forwardingRule | |
| # | |
| # | |
| # If an IP address is provided, must specify an IPv4 address in dot-decimal | |
| # notation or an IPv6 address in RFC 4291 format. For example, the following | |
| # are all valid IP addresses: | |
| # | |
| # | |
| # - 10.128.0.56 | |
| # - 2001:db8::2d9:51:0:0 | |
| # - 2001:db8:0:0:2d9:51:0:0 | |
| # | |
| # | |
| # IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. | |
| # 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. | |
| "nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify | |
| # this as a full or partial URL. | |
| # For example: | |
| # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ | |
| "nextHopInterRegionCost": 42, # Output only. [Output only] Internal fixed region-to-region cost that Google Cloud | |
| # calculates based on factors such as network performance, distance, and | |
| # available bandwidth between regions. | |
| "nextHopInterconnectAttachment": "A String", # Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop | |
| # for the route. | |
| # This field will only be populated for dynamic routes generated by | |
| # Cloud Router with a linked interconnectAttachment or the static route | |
| # generated by each L2 Interconnect Attachment. | |
| "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. | |
| # Both IPv6 address and IPv4 addresses are supported. | |
| # Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or | |
| # an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or | |
| # 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 | |
| # compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an | |
| # IPv4-mapped IPv6 address. | |
| "nextHopMed": 42, # Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates | |
| # the desirability of a particular route in a network. | |
| "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets. | |
| "nextHopOrigin": "A String", # Output only. [Output Only] Indicates the origin of the route. Can be IGP | |
| # (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), | |
| # or INCOMPLETE. | |
| "nextHopPeering": "A String", # Output only. [Output Only] The network peering name that should handle matching packets, | |
| # which should conform to RFC1035. | |
| "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets. | |
| "params": { # Additional route parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted | |
| # as part of resource payload. | |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. | |
| # Tag keys and values have the same definition as resource | |
| # manager tags. The field is allowed for INSERT | |
| # only. The keys/values to set on the resource should be specified in | |
| # either ID { : } or Namespaced format | |
| # { : }. | |
| # For example the following are valid inputs: | |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} | |
| # * {"123/environment" : "production", "345/abc" : "xyz"} | |
| # Note: | |
| # * Invalid combinations of ID & namespaced format is not supported. For | |
| # instance: {"123/environment" : "tagValues/444"} is invalid. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| "priority": 42, # The priority of this route. Priority is used to break ties in cases | |
| # where there is more than one matching route of equal prefix length. In | |
| # cases where multiple routes have equal prefix length, the one with the | |
| # lowest-numbered priority value wins. The default value is `1000`. The | |
| # priority value must be from `0` to `65535`, inclusive. | |
| "routeStatus": "A String", # [Output only] The status of the route. This status applies to | |
| # dynamic routes learned by Cloud Routers. It is also applicable to routes | |
| # undergoing migration. | |
| "routeType": "A String", # Output only. [Output Only] The type of this route, which can be one of the following | |
| # values: | |
| # - 'TRANSIT' for a transit route that this router learned from | |
| # another Cloud Router and will readvertise to one of its BGP peers | |
| # - 'SUBNET' for a route from a subnet of the VPC | |
| # - 'BGP' for a route learned from a BGP peer of this router | |
| # - 'STATIC' for a static route | |
| "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "tags": [ # A list of instance tags to which this route applies. | |
| "A String", | |
| ], | |
| "warnings": [ # Output only. [Output Only] If potential misconfigurations are detected for this | |
| # route, this field will be populated with warning messages. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| }, | |
| ], | |
| "bfdStatus": { # Next free: 15 | |
| "bfdSessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. | |
| "configUpdateTimestampMicros": "A String", # Unix timestamp of the most recent config update. | |
| "controlPacketCounts": { # Control packet counts for the current BFD session. | |
| "numRx": 42, # Number of packets received since the beginning of the current BFD | |
| # session. | |
| "numRxRejected": 42, # Number of packets received that were rejected because of errors since the | |
| # beginning of the current BFD session. | |
| "numRxSuccessful": 42, # Number of packets received that were successfully processed since the | |
| # beginning of the current BFD session. | |
| "numTx": 42, # Number of packets transmitted since the beginning of the current BFD | |
| # session. | |
| }, | |
| "controlPacketIntervals": [ # Inter-packet time interval statistics for control packets. | |
| { # Next free: 7 | |
| "avgMs": "A String", # Average observed inter-packet interval in milliseconds. | |
| "duration": "A String", # From how long ago in the past these intervals were observed. | |
| "maxMs": "A String", # Maximum observed inter-packet interval in milliseconds. | |
| "minMs": "A String", # Minimum observed inter-packet interval in milliseconds. | |
| "numIntervals": "A String", # Number of inter-packet intervals from which these statistics were derived. | |
| "type": "A String", # The type of packets for which inter-packet intervals were computed. | |
| }, | |
| ], | |
| "echoPacketCounts": { # Echo packet counts for the current BFD session. | |
| "numRx": 42, # Number of packets received since the beginning of the current BFD | |
| # session. | |
| "numRxRejected": 42, # Number of packets received that were rejected because of errors since the | |
| # beginning of the current BFD session. | |
| "numRxSuccessful": 42, # Number of packets received that were successfully processed since the | |
| # beginning of the current BFD session. | |
| "numTx": 42, # Number of packets transmitted since the beginning of the current BFD | |
| # session. | |
| }, | |
| "echoPacketIntervals": [ # Inter-packet time interval statistics for echo packets. | |
| { # Next free: 7 | |
| "avgMs": "A String", # Average observed inter-packet interval in milliseconds. | |
| "duration": "A String", # From how long ago in the past these intervals were observed. | |
| "maxMs": "A String", # Maximum observed inter-packet interval in milliseconds. | |
| "minMs": "A String", # Minimum observed inter-packet interval in milliseconds. | |
| "numIntervals": "A String", # Number of inter-packet intervals from which these statistics were derived. | |
| "type": "A String", # The type of packets for which inter-packet intervals were computed. | |
| }, | |
| ], | |
| "localDiagnostic": "A String", # The diagnostic code specifies the local system's reason for the last change | |
| # in session state. This allows remote systems to determine the reason that | |
| # the previous session failed, for example. These diagnostic codes are | |
| # specified in section 4.1 ofRFC5880 | |
| "localState": "A String", # The current BFD session state as seen by the transmitting system. These | |
| # states are specified in section 4.1 ofRFC5880 | |
| "negotiatedLocalControlTxIntervalMs": 42, # Negotiated transmit interval for control packets. | |
| "negotiatedLocalEchoTxIntervalMs": 42, # Negotiated transmit interval for echo packets. | |
| "rxPacket": { # The most recent Rx control packet for this BFD session. | |
| "authenticationPresent": True or False, # The Authentication Present bit of the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| "controlPlaneIndependent": True or False, # The Control Plane Independent bit of the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| "demand": True or False, # The demand bit of the BFD packet. This is specified in section 4.1 ofRFC5880 | |
| "diagnostic": "A String", # The diagnostic code specifies the local system's reason for the last change | |
| # in session state. This allows remote systems to determine the reason that | |
| # the previous session failed, for example. These diagnostic codes are | |
| # specified in section 4.1 ofRFC5880 | |
| "final": True or False, # The Final bit of the BFD packet. This is specified in section 4.1 ofRFC5880 | |
| "length": 42, # The length of the BFD Control packet in bytes. This is specified in section | |
| # 4.1 ofRFC5880 | |
| "minEchoRxIntervalMs": 42, # The Required Min Echo RX Interval value in the BFD packet. This is | |
| # specified in section 4.1 ofRFC5880 | |
| "minRxIntervalMs": 42, # The Required Min RX Interval value in the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| "minTxIntervalMs": 42, # The Desired Min TX Interval value in the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| "multiplier": 42, # The detection time multiplier of the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| "multipoint": True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 ofRFC5880 | |
| "myDiscriminator": 42, # The My Discriminator value in the BFD packet. This is specified in section | |
| # 4.1 ofRFC5880 | |
| "poll": True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 ofRFC5880 | |
| "state": "A String", # The current BFD session state as seen by the transmitting system. These | |
| # states are specified in section 4.1 ofRFC5880 | |
| "version": 42, # The version number of the BFD protocol, as specified in section 4.1 ofRFC5880. | |
| "yourDiscriminator": 42, # The Your Discriminator value in the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| }, | |
| "txPacket": { # The most recent Tx control packet for this BFD session. | |
| "authenticationPresent": True or False, # The Authentication Present bit of the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| "controlPlaneIndependent": True or False, # The Control Plane Independent bit of the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| "demand": True or False, # The demand bit of the BFD packet. This is specified in section 4.1 ofRFC5880 | |
| "diagnostic": "A String", # The diagnostic code specifies the local system's reason for the last change | |
| # in session state. This allows remote systems to determine the reason that | |
| # the previous session failed, for example. These diagnostic codes are | |
| # specified in section 4.1 ofRFC5880 | |
| "final": True or False, # The Final bit of the BFD packet. This is specified in section 4.1 ofRFC5880 | |
| "length": 42, # The length of the BFD Control packet in bytes. This is specified in section | |
| # 4.1 ofRFC5880 | |
| "minEchoRxIntervalMs": 42, # The Required Min Echo RX Interval value in the BFD packet. This is | |
| # specified in section 4.1 ofRFC5880 | |
| "minRxIntervalMs": 42, # The Required Min RX Interval value in the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| "minTxIntervalMs": 42, # The Desired Min TX Interval value in the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| "multiplier": 42, # The detection time multiplier of the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| "multipoint": True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 ofRFC5880 | |
| "myDiscriminator": 42, # The My Discriminator value in the BFD packet. This is specified in section | |
| # 4.1 ofRFC5880 | |
| "poll": True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 ofRFC5880 | |
| "state": "A String", # The current BFD session state as seen by the transmitting system. These | |
| # states are specified in section 4.1 ofRFC5880 | |
| "version": 42, # The version number of the BFD protocol, as specified in section 4.1 ofRFC5880. | |
| "yourDiscriminator": 42, # The Your Discriminator value in the BFD packet. This is specified in | |
| # section 4.1 ofRFC5880 | |
| }, | |
| "uptimeMs": "A String", # Session uptime in milliseconds. Value will be 0 if session is not up. | |
| "usingEchoMode": True or False, # Indicates if echo mode is currently being used. | |
| }, | |
| "depreferenced": True or False, # Output only. [Output Only] Indicates whether the BGP peer is in a depreferenced state. | |
| "enableIpv4": True or False, # Output only. Enable IPv4 traffic over BGP Peer. | |
| # It is enabled by default if the peerIpAddress is version 4. | |
| "enableIpv6": True or False, # Output only. Enable IPv6 traffic over BGP Peer. | |
| # It is enabled by default if the peerIpAddress is version 6. | |
| "ipAddress": "A String", # Output only. IP address of the local BGP interface. | |
| "ipv4NexthopAddress": "A String", # Output only. IPv4 address of the local BGP interface. | |
| "ipv6NexthopAddress": "A String", # Output only. IPv6 address of the local BGP interface. | |
| "linkedCustomHardware": "A String", # Output only. The URI of the linked custom hardware resource, | |
| # CustomHardwareLinkAttachment. This CustomHardwareLinkAttachment resource | |
| # is the one that will establish the BGP session from the Cloud Router. | |
| "linkedVpnTunnel": "A String", # Output only. URL of the VPN tunnel that this BGP peer controls. | |
| "md5AuthEnabled": True or False, # Informs whether MD5 authentication is enabled on this BGP peer. | |
| "name": "A String", # Output only. Name of this BGP peer. Unique within the Routers resource. | |
| "numLearnedRoutes": 42, # Output only. Number of routes learned from the remote BGP Peer. | |
| "peerIpAddress": "A String", # Output only. IP address of the remote BGP interface. | |
| "peerIpv4NexthopAddress": "A String", # Output only. IPv4 address of the remote BGP interface. | |
| "peerIpv6NexthopAddress": "A String", # Output only. IPv6 address of the remote BGP interface. | |
| "routerApplianceInstance": "A String", # Output only. [Output only] URI of the VM instance that is used as third-party router | |
| # appliances such as Next Gen Firewalls, Virtual Routers, or Router | |
| # Appliances. | |
| # The VM instance is the peer side of the BGP session. | |
| "state": "A String", # Output only. The state of the BGP session. For a list of possible values for this | |
| # field, seeBGP session states. | |
| "status": "A String", # Output only. Status of the BGP peer: {UP, DOWN} | |
| "statusReason": "A String", # Indicates why particular status was returned. | |
| "uptime": "A String", # Output only. Time this session has been up. | |
| # Format: | |
| # 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds | |
| "uptimeSeconds": "A String", # Output only. Time this session has been up, in seconds. | |
| # Format: | |
| # 145 | |
| }, | |
| ], | |
| "natStatus": [ | |
| { # Status of a NAT contained in this router. | |
| "autoAllocatedNatIps": [ # Output only. A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"] | |
| "A String", | |
| ], | |
| "drainAutoAllocatedNatIps": [ # Output only. A list of IPs auto-allocated for NAT that are in drain mode. | |
| # Example: ["1.1.1.1", "179.12.26.133"]. | |
| "A String", | |
| ], | |
| "drainUserAllocatedNatIps": [ # Output only. A list of IPs user-allocated for NAT that are in drain mode. | |
| # Example: ["1.1.1.1", "179.12.26.133"]. | |
| "A String", | |
| ], | |
| "minExtraNatIpsNeeded": 42, # Output only. The number of extra IPs to allocate. This will be greater than 0 only if | |
| # user-specified IPs are NOT enough to allow all configured VMs to use NAT. | |
| # This value is meaningful only when auto-allocation of NAT IPs is *not* | |
| # used. | |
| "name": "A String", # Output only. Unique name of this NAT. | |
| "numVmEndpointsWithNatMappings": 42, # Output only. Number of VM endpoints (i.e., Nics) that can use NAT. | |
| "ruleStatus": [ # Status of rules in this NAT. | |
| { # Status of a NAT Rule contained in this NAT. | |
| "activeNatIps": [ # Output only. A list of active IPs for NAT. | |
| # Example: ["1.1.1.1", "179.12.26.133"]. | |
| "A String", | |
| ], | |
| "drainNatIps": [ # Output only. A list of IPs for NAT that are in drain mode. | |
| # Example: ["1.1.1.1", "179.12.26.133"]. | |
| "A String", | |
| ], | |
| "minExtraIpsNeeded": 42, # Output only. The number of extra IPs to allocate. This will be greater than 0 only | |
| # if the existing IPs in this NAT Rule are NOT enough to allow all | |
| # configured VMs to use NAT. | |
| "numVmEndpointsWithNatMappings": 42, # Output only. Number of VM endpoints (i.e., NICs) that have NAT Mappings from this | |
| # NAT Rule. | |
| "ruleNumber": 42, # Output only. Rule number of the rule. | |
| }, | |
| ], | |
| "userAllocatedNatIpResources": [ # Output only. A list of fully qualified URLs of reserved IP address resources. | |
| "A String", | |
| ], | |
| "userAllocatedNatIps": [ # Output only. A list of IPs user-allocated for NAT. | |
| # They will be raw IP strings like "179.12.26.133". | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. | |
| "network": "A String", # URI of the network to which this router belongs. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Creates a Router resource in the specified project and region using | |
| the data included in the request. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Represents a Cloud Router resource. | |
| # | |
| # For more information about Cloud Router, read theCloud | |
| # Router overview. | |
| "bgp": { # BGP information specific to this router. | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| # The options are DEFAULT or CUSTOM. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These groups will be advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These IP ranges will be advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "asn": 42, # Local BGP Autonomous System Number (ASN). | |
| # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The | |
| # value will be fixed for this router resource. All VPN tunnels that link | |
| # to this router will have the same local ASN. | |
| "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It | |
| # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at | |
| # least /30, even if the BGP sessions are over IPv6. It must not overlap | |
| # with any IPv4 BGP session ranges. | |
| # | |
| # | |
| # Other vendors commonly call this "router ID". | |
| "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are | |
| # sent to the peer. | |
| # | |
| # | |
| # Hold time is three times the interval at which keepalive messages are | |
| # sent, and the hold time is the maximum number of seconds allowed to | |
| # elapse between successive keepalive messages that BGP receives from a | |
| # peer. | |
| # | |
| # | |
| # BGP will use the smaller of either the local hold time value or the | |
| # peer's hold time value as the hold time for the BGP connection between | |
| # the two peers. | |
| # | |
| # | |
| # If set, this value must be between 20 and 60. The default is 20. | |
| }, | |
| "bgpPeers": [ # BGP information that must be configured into the routing stack to | |
| # establish BGP peering. This information must specify the peer ASN and | |
| # either the interface name, IP address, or peer IP address. Please refer toRFC4273. | |
| { | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, | |
| # which currently supports the following option: | |
| # | |
| # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This | |
| # excludes any routes learned for subnets that use | |
| # VPC Network Peering. | |
| # | |
| # | |
| # Note that this field can only be populated if advertise_mode is CUSTOM | |
| # and overrides the list defined for the router (in the "bgp" message). | |
| # These groups are advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # overrides the list defined for the router (in the "bgp" message). | |
| # These IP ranges are advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more | |
| # than one matching route of maximum length, the routes with the lowest | |
| # priority value win. | |
| "bfd": { # BFD configuration for the BGP peering. | |
| "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # received from the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # transmit interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # corresponding receive interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "mode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. | |
| "multiplier": 42, # The number of consecutive BFD packets that must be missed | |
| # before BFD declares that a peer is unavailable. | |
| # | |
| # | |
| # If set, the value must be a value between 5 and 16. | |
| # | |
| # | |
| # The default is 5. | |
| "packetMode": "A String", # The BFD packet mode for this BGP peer. | |
| # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. | |
| # In this mode, if the peer router also has BFD echo mode enabled, BFD | |
| # echo packets will be sent to the other router. If the peer router does | |
| # not have BFD echo mode enabled, only control packets will be sent. If | |
| # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If | |
| # this router and the peer router have a multihop connection, this should | |
| # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop | |
| # connections. The default is CONTROL_AND_ECHO. | |
| "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # | |
| # | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. | |
| "slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to and received from the peer router when BFD echo mode is | |
| # enabled on both routers. The actual transmit and receive intervals are | |
| # negotiated between the two routers and are equal to the greater of this | |
| # value and the corresponding interval on the other router. | |
| # If set, this value must be between 1000 and 30000. | |
| # The default is 5000. | |
| }, | |
| "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP | |
| # session. | |
| { | |
| "range": "A String", # The custom learned route IP address range. Must be a valid | |
| # CIDR-formatted prefix. If an IP address is provided without a subnet | |
| # mask, it is interpreted as, for IPv4, a `/32` singular IP address | |
| # range, and, for IPv6, `/128`. | |
| }, | |
| ], | |
| "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This | |
| # value is applied to all custom learned route ranges for the session. | |
| # You can choose a value from `0` to `65335`. If you don't provide a | |
| # value, Google Cloud assigns a priority of `100` to the ranges. | |
| "enable": "A String", # The status of the BGP peer connection. | |
| # | |
| # | |
| # If set to FALSE, any active session with the peer is terminated and | |
| # all associated routing information is removed. If set to TRUE, the | |
| # peer connection can be established with routing information. The default | |
| # is TRUE. | |
| "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if | |
| # the peerIpAddress is version 4. | |
| "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the | |
| # peerIpAddress is version 6. | |
| "exportPolicies": [ # List of export policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_EXPORT type. | |
| "A String", | |
| ], | |
| "importPolicies": [ # List of import policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_IMPORT type. | |
| "A String", | |
| ], | |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. | |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. | |
| "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. | |
| "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. | |
| "linkedCustomHardware": "A String", # The linked custom hardware resource. | |
| # The URI of the custom hardware link attachment | |
| # is where you will establish the BGP session from the Cloud Router. | |
| # This link attachment must reside in the same subnetwork as the associated | |
| # router interface. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed by you | |
| # or other users | |
| # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed | |
| # by Cloud Interconnect, specifically by an InterconnectAttachment of type | |
| # PARTNER. Google automatically creates, updates, and deletes this type of | |
| # BGP peer when the PARTNER InterconnectAttachment is created, updated, | |
| # or deleted. | |
| "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the | |
| # name of one of the entries in the Router.md5_authentication_keys. The | |
| # field must comply with RFC1035. | |
| "name": "A String", # Name of this BGP peer. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use | |
| # a different value. | |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. | |
| "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router | |
| # appliances such as Next Gen Firewalls, Virtual Routers, or Router | |
| # Appliances. The VM instance must be located in zones contained in the | |
| # same region as this Cloud Router. | |
| # The VM instance is the peer side of the BGP session. | |
| }, | |
| ], | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN | |
| # attachments (interconnectAttachments). | |
| "etag": "A String", # ETag for optimistic concurrency control as described by AIP 154. Used to | |
| # prevent conflicting updates. If provided, the request will succeed only if | |
| # the etag matches the current etag of the router; otherwise, the request | |
| # fails with an ABORTED error. | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "interfaces": [ # Router interfaces. | |
| # To create a BGP peer that uses a router interface, | |
| # the interface must have one of the following fields specified: | |
| # | |
| # - linkedVpnTunnel | |
| # - linkedInterconnectAttachment | |
| # - subnetwork | |
| # | |
| # | |
| # You can create a router interface without any of these fields specified. | |
| # However, you cannot create a BGP peer that uses that interface. | |
| { | |
| "ipRange": "A String", # IP address and range of the interface. | |
| # | |
| # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must | |
| # be a CIDR-formatted string, for example, 169.254.0.1/30. | |
| # Note: Do not truncate the IP address, as it represents the IP address of | |
| # the interface. | |
| # - For Internet Protocol version 6 (IPv6), the value | |
| # must be a unique local address (ULA) range from fdff:1::/64 | |
| # with a mask length of 126 or less. This value should be a CIDR-formatted | |
| # string, for example, fdff:1::1/112. Within the router's | |
| # VPC, this IPv6 prefix will be reserved exclusively for this connection | |
| # and cannot be used for any other purpose. | |
| "ipVersion": "A String", # IP version of this interface. | |
| "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region | |
| # as the router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the | |
| # router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed directly | |
| # by users. | |
| # - MANAGED_BY_ATTACHMENT is an interface that is configured and | |
| # managed by Cloud Interconnect, specifically, by an InterconnectAttachment | |
| # of type PARTNER. Google automatically creates, updates, and deletes | |
| # this type of interface when the PARTNER InterconnectAttachment is | |
| # created, updated, or deleted. | |
| "name": "A String", # Name of this interface entry. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "privateIpAddress": "A String", # The regional private internal IP address that is used to establish | |
| # BGP sessions to a VM instance acting as a third-party | |
| # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or | |
| # an SD-WAN VM. | |
| "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface | |
| # you are creating. The redundantInterface must belong to the same Cloud | |
| # Router as the interface here. To establish the BGP session to a Router | |
| # Appliance VM, you must create two BGP peers. The two BGP peers must be | |
| # attached to two separate interfaces that are redundant with each other. | |
| # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must | |
| # be 1-63 characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which | |
| # must be in the same region as the Cloud Router. | |
| # When you establish a BGP session to a VM instance using this interface, | |
| # the VM instance must belong to the same subnetwork as the subnetwork | |
| # specified here. | |
| }, | |
| ], | |
| "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for | |
| # routers. | |
| "md5AuthenticationKeys": [ # Keys used for MD5 authentication. | |
| { | |
| "key": "A String", # [Input only] Value of the key. | |
| # | |
| # For patch and update calls, it can be skipped to | |
| # copy the value from the previous configuration. This is allowed if the | |
| # key with the same name existed before the operation. Maximum length is 80 | |
| # characters. Can only contain printable ASCII characters. | |
| "name": "A String", # Name used to identify the key. | |
| # | |
| # Must be unique within a router. Must be referenced by exactly | |
| # one bgpPeer. Must comply withRFC1035. | |
| }, | |
| ], | |
| "name": "A String", # Name of the resource. Provided by the client when the resource is created. | |
| # The name must be 1-63 characters long, and comply withRFC1035. | |
| # Specifically, the name must be 1-63 characters long and match the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first | |
| # character must be a lowercase letter, and all following characters must | |
| # be a dash, lowercase letter, or digit, except the last character, which | |
| # cannot be a dash. | |
| "nats": [ # A list of NAT services created in this router. | |
| { # Represents a Nat resource. It enables the VMs within the specified | |
| # subnetworks to access Internet without external IP addresses. It specifies | |
| # a list of subnetworks (and the ranges within) that want to use NAT. | |
| # Customers can also provide the external IPs that would be used for NAT. GCP | |
| # would auto-allocate ephemeral IPs if no external IPs are provided. | |
| "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. | |
| # Must be one of: PREMIUM, STANDARD. | |
| # If not specified, then the current | |
| # project-level default tier is used. | |
| "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT only. | |
| "A String", | |
| ], | |
| "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT | |
| # state. This value is equal to tcp_time_wait_timeout_sec. | |
| # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or | |
| # 120s. The field is output only. | |
| "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. | |
| # | |
| # | |
| # If not specified, it is disabled by default. | |
| # | |
| # | |
| # If set to true, | |
| # | |
| # - Dynamic Port Allocation will be enabled on this NAT | |
| # config. | |
| # - enableEndpointIndependentMapping cannot be set to true. | |
| # - If minPorts is set, minPortsPerVm must be set to a | |
| # power of two greater than or equal to 32. If minPortsPerVm is not set, a | |
| # minimum of 32 ports will be allocated to a VM from this NAT | |
| # config. | |
| "enableEndpointIndependentMapping": True or False, | |
| "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list | |
| # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM | |
| "A String", | |
| ], | |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. | |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. | |
| "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, | |
| # logs are exported for all connections handled by this NAT. | |
| # This option can take one of the following values: | |
| # | |
| # - ERRORS_ONLY: Export logs only for connection failures. | |
| # - TRANSLATIONS_ONLY: Export logs only for successful | |
| # connections. | |
| # - ALL: Export logs for all connections, successful and | |
| # unsuccessful. | |
| }, | |
| "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when | |
| # Dynamic Port Allocation is enabled. | |
| # | |
| # | |
| # If Dynamic Port Allocation is not enabled, this field has no effect. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled, and this field is set, it must be | |
| # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm | |
| # is not set. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled and this field is not set, | |
| # a maximum of 65536 ports will be allocated to a VM from this NAT | |
| # config. | |
| "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not | |
| # set, a default number of ports is allocated to a VM. This is rounded | |
| # up to the nearest power of 2. For example, if the value of this field is | |
| # 50, at least 64 ports are allocated to a VM. | |
| "name": "A String", # Unique name of this Nat service. | |
| # The name must be 1-63 characters long and comply withRFC1035. | |
| "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64 | |
| # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is | |
| # selected for the SubnetworkIpRangeToNat64Option above. | |
| { # Specifies a subnetwork to enable NAT64. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT64. | |
| }, | |
| ], | |
| "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following | |
| # values: | |
| # | |
| # - MANUAL_ONLY: Uses only Nat IP addresses provided by | |
| # customers. When there are not enough specified Nat IPs, the Nat service | |
| # fails for new VMs. | |
| # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers | |
| # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should | |
| # be empty. | |
| "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| "A String", | |
| ], | |
| "rules": [ # A list of rules associated with this NAT. | |
| { | |
| "action": { # The action to be enforced for traffic that matches this rule. | |
| "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this | |
| # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT rule only. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be | |
| # drained. This is only supported on patch/update, and these | |
| # subnetworks must have previously been used as active ranges in this | |
| # NAT Rule. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| }, | |
| "description": "A String", # An optional description of this rule. | |
| "match": "A String", # CEL expression that specifies the match condition that egress traffic | |
| # from a VM is evaluated against. If it evaluates to true, the | |
| # corresponding `action` is enforced. | |
| # | |
| # The following examples are valid match expressions for public NAT: | |
| # | |
| # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, | |
| # '2.2.0.0/16')` | |
| # | |
| # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` | |
| # | |
| # The following examples are valid match expressions for private NAT: | |
| # | |
| # (NAT 44) | |
| # `nexthop.hub == | |
| # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` | |
| # | |
| # `nexthop.is_hybrid` | |
| # | |
| # (NAT 64) | |
| # `isIPv6(source.ip)` | |
| "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number | |
| # must be a positive value between 0 and 65000, and | |
| # must be unique among rules within a NAT. | |
| "sourceWorkloadIdentities": [ # A list of source workload identities. | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: | |
| # | |
| # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every | |
| # Subnetwork are allowed to Nat. | |
| # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges | |
| # in every Subnetwork are allowed to Nat. | |
| # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field subnetwork below) | |
| # | |
| # | |
| # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. | |
| # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there | |
| # should not be any other Router.Nat section in any Router for this network | |
| # in this region. | |
| "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following | |
| # values: | |
| # | |
| # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in | |
| # every Subnetwork are allowed to Nat. | |
| # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field nat64_subnetwork below) | |
| # | |
| # | |
| # The default is NAT64_OPTION_UNSPECIFIED. | |
| # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other | |
| # Router.Nat section in this region can also enable NAT64 for any | |
| # Subnetworks in this network. Other Router.Nat sections can still be | |
| # present to enable NAT44 only. | |
| "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT | |
| # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the | |
| # SubnetworkIpRangeToNatOption above. | |
| { # Defines the IP ranges that want to use NAT for a subnetwork. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT. | |
| "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to | |
| # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" | |
| # is one of the values in source_ip_ranges_to_nat. | |
| "A String", | |
| ], | |
| "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All | |
| # options of a single value are valid except | |
| # NAT_IP_RANGE_OPTION_UNSPECIFIED. | |
| # The only valid option with multiple values is: ["PRIMARY_IP_RANGE", | |
| # "LIST_OF_SECONDARY_IP_RANGES"] | |
| # Default: [ALL_IP_RANGES] | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s | |
| # if not set. | |
| "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. | |
| # Defaults to 120s if not set. | |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if | |
| # not set. | |
| "type": "A String", # Indicates whether this NAT is used for public or private IP | |
| # translation. If unspecified, it defaults to PUBLIC. | |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. | |
| }, | |
| ], | |
| "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. | |
| "network": "A String", # URI of the network to which this router belongs. | |
| "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted | |
| # as part of resource payload. | |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. | |
| # The field is allowed for INSERT | |
| # only. The keys/values to set on the resource should be specified in | |
| # either ID { : } or Namespaced format | |
| # { : }. | |
| # For example the following are valid inputs: | |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} | |
| # * {"123/environment" : "production", "345/abc" : "xyz"} | |
| # Note: | |
| # * Invalid combinations of ID & namespaced format is not supported. For | |
| # instance: {"123/environment" : "tagValues/444"} is invalid. | |
| # * Inconsistent format is not supported. For instance: | |
| # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| "region": "A String", # [Output Only] URI of the region where the router resides. | |
| # You must specify this field as part of the HTTP request URL. It is | |
| # not settable as a field in the request body. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| } | |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so | |
| that if you must retry your request, the server will know to ignore the | |
| request if it has already been completed. | |
| For example, consider a situation where you make an initial request and | |
| the request times out. If you make the request again with the same | |
| request ID, the server can check if original operation with the same | |
| request ID was received, and if so, will ignore the second request. This | |
| prevents clients from accidentally creating duplicate commitments. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the | |
| # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule | |
| # methods if not explicitly provided by the user. | |
| "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query | |
| # parameters specified minPriority/maxPriority. | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error | |
| # status code that was returned. For example, a `404` means the | |
| # resource was not found. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. | |
| # There is no requirement that this be linear or support any granularity of | |
| # operations. This should not be used to guess when the operation will be | |
| # complete. This number should monotonically increase as the operation | |
| # progresses. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For | |
| # operations related to creating a snapshot, this points to the disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> | |
| <pre>Retrieves a list of Router resources available to the specified project. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| filter: string, A filter expression that filters resources listed in the response. Most | |
| Compute resources support two types of filter expressions: | |
| expressions that support regular expressions and expressions that follow | |
| API improvement proposal AIP-160. | |
| These two types of filter expressions cannot be mixed in one request. | |
| If you want to use AIP-160, your expression must specify the field name, an | |
| operator, and the value that you want to use for filtering. The value | |
| must be a string, a number, or a boolean. The operator | |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. | |
| For example, if you are filtering Compute Engine instances, you can | |
| exclude instances named `example-instance` by specifying | |
| `name != example-instance`. | |
| The `:*` comparison can be used to test whether a key has been defined. | |
| For example, to find all objects with `owner` label use: | |
| ``` | |
| labels.owner:* | |
| ``` | |
| You can also filter nested fields. For example, you could specify | |
| `scheduling.automaticRestart = false` to include instances only | |
| if they are not scheduled for automatic restarts. You can use filtering | |
| on nested fields to filter based onresource labels. | |
| To filter on multiple expressions, provide each separate expression within | |
| parentheses. For example: | |
| ``` | |
| (scheduling.automaticRestart = true) | |
| (cpuPlatform = "Intel Skylake") | |
| ``` | |
| By default, each expression is an `AND` expression. However, you | |
| can include `AND` and `OR` expressions explicitly. | |
| For example: | |
| ``` | |
| (cpuPlatform = "Intel Skylake") OR | |
| (cpuPlatform = "Intel Broadwell") AND | |
| (scheduling.automaticRestart = true) | |
| ``` | |
| If you want to use a regular expression, use the `eq` (equal) or `ne` | |
| (not equal) operator against a single un-parenthesized expression with or | |
| without quotes or against multiple parenthesized expressions. Examples: | |
| `fieldname eq unquoted literal` | |
| `fieldname eq 'single quoted literal'` | |
| `fieldname eq "double quoted literal"` | |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` | |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. | |
| The literal value must match the entire field. | |
| For example, to filter for instances that do not end with name "instance", | |
| you would use `name ne .*instance`. | |
| You cannot combine constraints on multiple fields using regular | |
| expressions. | |
| maxResults: integer, The maximum number of results per page that should be returned. | |
| If the number of available results is larger than `maxResults`, | |
| Compute Engine returns a `nextPageToken` that can be used to get | |
| the next page of results in subsequent list requests. Acceptable values are | |
| `0` to `500`, inclusive. (Default: `500`) | |
| orderBy: string, Sorts list results by a certain order. By default, results | |
| are returned in alphanumerical order based on the resource name. | |
| You can also sort results in descending order based on the creation | |
| timestamp using `orderBy="creationTimestamp desc"`. This sorts | |
| results based on the `creationTimestamp` field in | |
| reverse chronological order (newest result first). Use this to sort | |
| resources like operations so that the newest operation is returned first. | |
| Currently, only sorting by `name` or | |
| `creationTimestamp desc` is supported. | |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the | |
| `nextPageToken` returned by a previous list request to get | |
| the next page of results. | |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case | |
| of failure. The default value is false. | |
| For example, when partial success behavior is enabled, aggregatedList for a | |
| single zone scope either returns all resources in the zone or no resources, | |
| with an error code. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Contains a list of Router resources. | |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. | |
| "items": [ # A list of Router resources. | |
| { # Represents a Cloud Router resource. | |
| # | |
| # For more information about Cloud Router, read theCloud | |
| # Router overview. | |
| "bgp": { # BGP information specific to this router. | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| # The options are DEFAULT or CUSTOM. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These groups will be advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These IP ranges will be advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "asn": 42, # Local BGP Autonomous System Number (ASN). | |
| # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The | |
| # value will be fixed for this router resource. All VPN tunnels that link | |
| # to this router will have the same local ASN. | |
| "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It | |
| # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at | |
| # least /30, even if the BGP sessions are over IPv6. It must not overlap | |
| # with any IPv4 BGP session ranges. | |
| # | |
| # | |
| # Other vendors commonly call this "router ID". | |
| "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are | |
| # sent to the peer. | |
| # | |
| # | |
| # Hold time is three times the interval at which keepalive messages are | |
| # sent, and the hold time is the maximum number of seconds allowed to | |
| # elapse between successive keepalive messages that BGP receives from a | |
| # peer. | |
| # | |
| # | |
| # BGP will use the smaller of either the local hold time value or the | |
| # peer's hold time value as the hold time for the BGP connection between | |
| # the two peers. | |
| # | |
| # | |
| # If set, this value must be between 20 and 60. The default is 20. | |
| }, | |
| "bgpPeers": [ # BGP information that must be configured into the routing stack to | |
| # establish BGP peering. This information must specify the peer ASN and | |
| # either the interface name, IP address, or peer IP address. Please refer toRFC4273. | |
| { | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, | |
| # which currently supports the following option: | |
| # | |
| # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This | |
| # excludes any routes learned for subnets that use | |
| # VPC Network Peering. | |
| # | |
| # | |
| # Note that this field can only be populated if advertise_mode is CUSTOM | |
| # and overrides the list defined for the router (in the "bgp" message). | |
| # These groups are advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # overrides the list defined for the router (in the "bgp" message). | |
| # These IP ranges are advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more | |
| # than one matching route of maximum length, the routes with the lowest | |
| # priority value win. | |
| "bfd": { # BFD configuration for the BGP peering. | |
| "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # received from the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # transmit interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # corresponding receive interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "mode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. | |
| "multiplier": 42, # The number of consecutive BFD packets that must be missed | |
| # before BFD declares that a peer is unavailable. | |
| # | |
| # | |
| # If set, the value must be a value between 5 and 16. | |
| # | |
| # | |
| # The default is 5. | |
| "packetMode": "A String", # The BFD packet mode for this BGP peer. | |
| # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. | |
| # In this mode, if the peer router also has BFD echo mode enabled, BFD | |
| # echo packets will be sent to the other router. If the peer router does | |
| # not have BFD echo mode enabled, only control packets will be sent. If | |
| # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If | |
| # this router and the peer router have a multihop connection, this should | |
| # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop | |
| # connections. The default is CONTROL_AND_ECHO. | |
| "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # | |
| # | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. | |
| "slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to and received from the peer router when BFD echo mode is | |
| # enabled on both routers. The actual transmit and receive intervals are | |
| # negotiated between the two routers and are equal to the greater of this | |
| # value and the corresponding interval on the other router. | |
| # If set, this value must be between 1000 and 30000. | |
| # The default is 5000. | |
| }, | |
| "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP | |
| # session. | |
| { | |
| "range": "A String", # The custom learned route IP address range. Must be a valid | |
| # CIDR-formatted prefix. If an IP address is provided without a subnet | |
| # mask, it is interpreted as, for IPv4, a `/32` singular IP address | |
| # range, and, for IPv6, `/128`. | |
| }, | |
| ], | |
| "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This | |
| # value is applied to all custom learned route ranges for the session. | |
| # You can choose a value from `0` to `65335`. If you don't provide a | |
| # value, Google Cloud assigns a priority of `100` to the ranges. | |
| "enable": "A String", # The status of the BGP peer connection. | |
| # | |
| # | |
| # If set to FALSE, any active session with the peer is terminated and | |
| # all associated routing information is removed. If set to TRUE, the | |
| # peer connection can be established with routing information. The default | |
| # is TRUE. | |
| "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if | |
| # the peerIpAddress is version 4. | |
| "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the | |
| # peerIpAddress is version 6. | |
| "exportPolicies": [ # List of export policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_EXPORT type. | |
| "A String", | |
| ], | |
| "importPolicies": [ # List of import policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_IMPORT type. | |
| "A String", | |
| ], | |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. | |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. | |
| "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. | |
| "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. | |
| "linkedCustomHardware": "A String", # The linked custom hardware resource. | |
| # The URI of the custom hardware link attachment | |
| # is where you will establish the BGP session from the Cloud Router. | |
| # This link attachment must reside in the same subnetwork as the associated | |
| # router interface. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed by you | |
| # or other users | |
| # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed | |
| # by Cloud Interconnect, specifically by an InterconnectAttachment of type | |
| # PARTNER. Google automatically creates, updates, and deletes this type of | |
| # BGP peer when the PARTNER InterconnectAttachment is created, updated, | |
| # or deleted. | |
| "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the | |
| # name of one of the entries in the Router.md5_authentication_keys. The | |
| # field must comply with RFC1035. | |
| "name": "A String", # Name of this BGP peer. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use | |
| # a different value. | |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. | |
| "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router | |
| # appliances such as Next Gen Firewalls, Virtual Routers, or Router | |
| # Appliances. The VM instance must be located in zones contained in the | |
| # same region as this Cloud Router. | |
| # The VM instance is the peer side of the BGP session. | |
| }, | |
| ], | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN | |
| # attachments (interconnectAttachments). | |
| "etag": "A String", # ETag for optimistic concurrency control as described by AIP 154. Used to | |
| # prevent conflicting updates. If provided, the request will succeed only if | |
| # the etag matches the current etag of the router; otherwise, the request | |
| # fails with an ABORTED error. | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "interfaces": [ # Router interfaces. | |
| # To create a BGP peer that uses a router interface, | |
| # the interface must have one of the following fields specified: | |
| # | |
| # - linkedVpnTunnel | |
| # - linkedInterconnectAttachment | |
| # - subnetwork | |
| # | |
| # | |
| # You can create a router interface without any of these fields specified. | |
| # However, you cannot create a BGP peer that uses that interface. | |
| { | |
| "ipRange": "A String", # IP address and range of the interface. | |
| # | |
| # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must | |
| # be a CIDR-formatted string, for example, 169.254.0.1/30. | |
| # Note: Do not truncate the IP address, as it represents the IP address of | |
| # the interface. | |
| # - For Internet Protocol version 6 (IPv6), the value | |
| # must be a unique local address (ULA) range from fdff:1::/64 | |
| # with a mask length of 126 or less. This value should be a CIDR-formatted | |
| # string, for example, fdff:1::1/112. Within the router's | |
| # VPC, this IPv6 prefix will be reserved exclusively for this connection | |
| # and cannot be used for any other purpose. | |
| "ipVersion": "A String", # IP version of this interface. | |
| "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region | |
| # as the router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the | |
| # router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed directly | |
| # by users. | |
| # - MANAGED_BY_ATTACHMENT is an interface that is configured and | |
| # managed by Cloud Interconnect, specifically, by an InterconnectAttachment | |
| # of type PARTNER. Google automatically creates, updates, and deletes | |
| # this type of interface when the PARTNER InterconnectAttachment is | |
| # created, updated, or deleted. | |
| "name": "A String", # Name of this interface entry. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "privateIpAddress": "A String", # The regional private internal IP address that is used to establish | |
| # BGP sessions to a VM instance acting as a third-party | |
| # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or | |
| # an SD-WAN VM. | |
| "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface | |
| # you are creating. The redundantInterface must belong to the same Cloud | |
| # Router as the interface here. To establish the BGP session to a Router | |
| # Appliance VM, you must create two BGP peers. The two BGP peers must be | |
| # attached to two separate interfaces that are redundant with each other. | |
| # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must | |
| # be 1-63 characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which | |
| # must be in the same region as the Cloud Router. | |
| # When you establish a BGP session to a VM instance using this interface, | |
| # the VM instance must belong to the same subnetwork as the subnetwork | |
| # specified here. | |
| }, | |
| ], | |
| "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for | |
| # routers. | |
| "md5AuthenticationKeys": [ # Keys used for MD5 authentication. | |
| { | |
| "key": "A String", # [Input only] Value of the key. | |
| # | |
| # For patch and update calls, it can be skipped to | |
| # copy the value from the previous configuration. This is allowed if the | |
| # key with the same name existed before the operation. Maximum length is 80 | |
| # characters. Can only contain printable ASCII characters. | |
| "name": "A String", # Name used to identify the key. | |
| # | |
| # Must be unique within a router. Must be referenced by exactly | |
| # one bgpPeer. Must comply withRFC1035. | |
| }, | |
| ], | |
| "name": "A String", # Name of the resource. Provided by the client when the resource is created. | |
| # The name must be 1-63 characters long, and comply withRFC1035. | |
| # Specifically, the name must be 1-63 characters long and match the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first | |
| # character must be a lowercase letter, and all following characters must | |
| # be a dash, lowercase letter, or digit, except the last character, which | |
| # cannot be a dash. | |
| "nats": [ # A list of NAT services created in this router. | |
| { # Represents a Nat resource. It enables the VMs within the specified | |
| # subnetworks to access Internet without external IP addresses. It specifies | |
| # a list of subnetworks (and the ranges within) that want to use NAT. | |
| # Customers can also provide the external IPs that would be used for NAT. GCP | |
| # would auto-allocate ephemeral IPs if no external IPs are provided. | |
| "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. | |
| # Must be one of: PREMIUM, STANDARD. | |
| # If not specified, then the current | |
| # project-level default tier is used. | |
| "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT only. | |
| "A String", | |
| ], | |
| "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT | |
| # state. This value is equal to tcp_time_wait_timeout_sec. | |
| # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or | |
| # 120s. The field is output only. | |
| "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. | |
| # | |
| # | |
| # If not specified, it is disabled by default. | |
| # | |
| # | |
| # If set to true, | |
| # | |
| # - Dynamic Port Allocation will be enabled on this NAT | |
| # config. | |
| # - enableEndpointIndependentMapping cannot be set to true. | |
| # - If minPorts is set, minPortsPerVm must be set to a | |
| # power of two greater than or equal to 32. If minPortsPerVm is not set, a | |
| # minimum of 32 ports will be allocated to a VM from this NAT | |
| # config. | |
| "enableEndpointIndependentMapping": True or False, | |
| "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list | |
| # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM | |
| "A String", | |
| ], | |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. | |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. | |
| "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, | |
| # logs are exported for all connections handled by this NAT. | |
| # This option can take one of the following values: | |
| # | |
| # - ERRORS_ONLY: Export logs only for connection failures. | |
| # - TRANSLATIONS_ONLY: Export logs only for successful | |
| # connections. | |
| # - ALL: Export logs for all connections, successful and | |
| # unsuccessful. | |
| }, | |
| "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when | |
| # Dynamic Port Allocation is enabled. | |
| # | |
| # | |
| # If Dynamic Port Allocation is not enabled, this field has no effect. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled, and this field is set, it must be | |
| # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm | |
| # is not set. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled and this field is not set, | |
| # a maximum of 65536 ports will be allocated to a VM from this NAT | |
| # config. | |
| "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not | |
| # set, a default number of ports is allocated to a VM. This is rounded | |
| # up to the nearest power of 2. For example, if the value of this field is | |
| # 50, at least 64 ports are allocated to a VM. | |
| "name": "A String", # Unique name of this Nat service. | |
| # The name must be 1-63 characters long and comply withRFC1035. | |
| "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64 | |
| # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is | |
| # selected for the SubnetworkIpRangeToNat64Option above. | |
| { # Specifies a subnetwork to enable NAT64. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT64. | |
| }, | |
| ], | |
| "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following | |
| # values: | |
| # | |
| # - MANUAL_ONLY: Uses only Nat IP addresses provided by | |
| # customers. When there are not enough specified Nat IPs, the Nat service | |
| # fails for new VMs. | |
| # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers | |
| # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should | |
| # be empty. | |
| "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| "A String", | |
| ], | |
| "rules": [ # A list of rules associated with this NAT. | |
| { | |
| "action": { # The action to be enforced for traffic that matches this rule. | |
| "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this | |
| # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT rule only. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be | |
| # drained. This is only supported on patch/update, and these | |
| # subnetworks must have previously been used as active ranges in this | |
| # NAT Rule. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| }, | |
| "description": "A String", # An optional description of this rule. | |
| "match": "A String", # CEL expression that specifies the match condition that egress traffic | |
| # from a VM is evaluated against. If it evaluates to true, the | |
| # corresponding `action` is enforced. | |
| # | |
| # The following examples are valid match expressions for public NAT: | |
| # | |
| # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, | |
| # '2.2.0.0/16')` | |
| # | |
| # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` | |
| # | |
| # The following examples are valid match expressions for private NAT: | |
| # | |
| # (NAT 44) | |
| # `nexthop.hub == | |
| # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` | |
| # | |
| # `nexthop.is_hybrid` | |
| # | |
| # (NAT 64) | |
| # `isIPv6(source.ip)` | |
| "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number | |
| # must be a positive value between 0 and 65000, and | |
| # must be unique among rules within a NAT. | |
| "sourceWorkloadIdentities": [ # A list of source workload identities. | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: | |
| # | |
| # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every | |
| # Subnetwork are allowed to Nat. | |
| # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges | |
| # in every Subnetwork are allowed to Nat. | |
| # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field subnetwork below) | |
| # | |
| # | |
| # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. | |
| # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there | |
| # should not be any other Router.Nat section in any Router for this network | |
| # in this region. | |
| "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following | |
| # values: | |
| # | |
| # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in | |
| # every Subnetwork are allowed to Nat. | |
| # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field nat64_subnetwork below) | |
| # | |
| # | |
| # The default is NAT64_OPTION_UNSPECIFIED. | |
| # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other | |
| # Router.Nat section in this region can also enable NAT64 for any | |
| # Subnetworks in this network. Other Router.Nat sections can still be | |
| # present to enable NAT44 only. | |
| "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT | |
| # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the | |
| # SubnetworkIpRangeToNatOption above. | |
| { # Defines the IP ranges that want to use NAT for a subnetwork. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT. | |
| "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to | |
| # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" | |
| # is one of the values in source_ip_ranges_to_nat. | |
| "A String", | |
| ], | |
| "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All | |
| # options of a single value are valid except | |
| # NAT_IP_RANGE_OPTION_UNSPECIFIED. | |
| # The only valid option with multiple values is: ["PRIMARY_IP_RANGE", | |
| # "LIST_OF_SECONDARY_IP_RANGES"] | |
| # Default: [ALL_IP_RANGES] | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s | |
| # if not set. | |
| "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. | |
| # Defaults to 120s if not set. | |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if | |
| # not set. | |
| "type": "A String", # Indicates whether this NAT is used for public or private IP | |
| # translation. If unspecified, it defaults to PUBLIC. | |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. | |
| }, | |
| ], | |
| "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. | |
| "network": "A String", # URI of the network to which this router belongs. | |
| "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted | |
| # as part of resource payload. | |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. | |
| # The field is allowed for INSERT | |
| # only. The keys/values to set on the resource should be specified in | |
| # either ID { : } or Namespaced format | |
| # { : }. | |
| # For example the following are valid inputs: | |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} | |
| # * {"123/environment" : "production", "345/abc" : "xyz"} | |
| # Note: | |
| # * Invalid combinations of ID & namespaced format is not supported. For | |
| # instance: {"123/environment" : "tagValues/444"} is invalid. | |
| # * Inconsistent format is not supported. For instance: | |
| # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| "region": "A String", # [Output Only] URI of the region where the router resides. | |
| # You must specify this field as part of the HTTP request URL. It is | |
| # not settable as a field in the request body. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| }, | |
| ], | |
| "kind": "compute#routerList", # Output only. [Output Only] Type of resource. Always compute#router for | |
| # routers. | |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for | |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for | |
| # the query parameter pageToken in the next list request. | |
| # Subsequent list requests will have their own nextPageToken to | |
| # continue paging through the results. | |
| "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. | |
| "warning": { # [Output Only] Informational warning message. | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="listBgpRoutes">listBgpRoutes(project, region, router, addressFamily=None, destinationPrefix=None, filter=None, maxResults=None, orderBy=None, pageToken=None, peer=None, policyApplied=None, returnPartialSuccess=None, routeType=None, x__xgafv=None)</code> | |
| <pre>Retrieves a list of router bgp routes available to the specified project. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name or id of the resource for this request. | |
| Name should conform to RFC1035. (required) | |
| addressFamily: string, (Required) limit results to this address family (either IPv4 or IPv6) | |
| Allowed values | |
| IPV4 - | |
| IPV6 - | |
| UNSPECIFIED_IP_VERSION - | |
| destinationPrefix: string, Limit results to destinations that are subnets of this CIDR range | |
| filter: string, A filter expression that filters resources listed in the response. Most | |
| Compute resources support two types of filter expressions: | |
| expressions that support regular expressions and expressions that follow | |
| API improvement proposal AIP-160. | |
| These two types of filter expressions cannot be mixed in one request. | |
| If you want to use AIP-160, your expression must specify the field name, an | |
| operator, and the value that you want to use for filtering. The value | |
| must be a string, a number, or a boolean. The operator | |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. | |
| For example, if you are filtering Compute Engine instances, you can | |
| exclude instances named `example-instance` by specifying | |
| `name != example-instance`. | |
| The `:*` comparison can be used to test whether a key has been defined. | |
| For example, to find all objects with `owner` label use: | |
| ``` | |
| labels.owner:* | |
| ``` | |
| You can also filter nested fields. For example, you could specify | |
| `scheduling.automaticRestart = false` to include instances only | |
| if they are not scheduled for automatic restarts. You can use filtering | |
| on nested fields to filter based onresource labels. | |
| To filter on multiple expressions, provide each separate expression within | |
| parentheses. For example: | |
| ``` | |
| (scheduling.automaticRestart = true) | |
| (cpuPlatform = "Intel Skylake") | |
| ``` | |
| By default, each expression is an `AND` expression. However, you | |
| can include `AND` and `OR` expressions explicitly. | |
| For example: | |
| ``` | |
| (cpuPlatform = "Intel Skylake") OR | |
| (cpuPlatform = "Intel Broadwell") AND | |
| (scheduling.automaticRestart = true) | |
| ``` | |
| If you want to use a regular expression, use the `eq` (equal) or `ne` | |
| (not equal) operator against a single un-parenthesized expression with or | |
| without quotes or against multiple parenthesized expressions. Examples: | |
| `fieldname eq unquoted literal` | |
| `fieldname eq 'single quoted literal'` | |
| `fieldname eq "double quoted literal"` | |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` | |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. | |
| The literal value must match the entire field. | |
| For example, to filter for instances that do not end with name "instance", | |
| you would use `name ne .*instance`. | |
| You cannot combine constraints on multiple fields using regular | |
| expressions. | |
| maxResults: integer, The maximum number of results per page that should be returned. | |
| If the number of available results is larger than `maxResults`, | |
| Compute Engine returns a `nextPageToken` that can be used to get | |
| the next page of results in subsequent list requests. Acceptable values are | |
| `0` to `500`, inclusive. (Default: `500`) | |
| orderBy: string, Sorts list results by a certain order. By default, results | |
| are returned in alphanumerical order based on the resource name. | |
| You can also sort results in descending order based on the creation | |
| timestamp using `orderBy="creationTimestamp desc"`. This sorts | |
| results based on the `creationTimestamp` field in | |
| reverse chronological order (newest result first). Use this to sort | |
| resources like operations so that the newest operation is returned first. | |
| Currently, only sorting by `name` or | |
| `creationTimestamp desc` is supported. | |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the | |
| `nextPageToken` returned by a previous list request to get | |
| the next page of results. | |
| peer: string, (Required) limit results to the BGP peer with the given name. | |
| Name should conform to RFC1035. | |
| policyApplied: boolean, When true, the method returns post-policy routes. Otherwise, it returns | |
| pre-policy routes. | |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case | |
| of failure. The default value is false. | |
| For example, when partial success behavior is enabled, aggregatedList for a | |
| single zone scope either returns all resources in the zone or no resources, | |
| with an error code. | |
| routeType: string, (Required) limit results to this type of route (either LEARNED or | |
| ADVERTISED) | |
| Allowed values | |
| ADVERTISED - | |
| LEARNED - | |
| UNSPECIFIED_ROUTE_TYPE - | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "etag": "A String", | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "kind": "compute#routersListBgpRoutes", # Output only. [Output Only] Type of resource. Alwayscompute#routersListBgpRoutes for lists of bgp routes. | |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for | |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for | |
| # the query parameter pageToken in the next list request. | |
| # Subsequent list requests will have their own nextPageToken to | |
| # continue paging through the results. | |
| "result": [ # [Output Only] A list of bgp routes. | |
| { | |
| "asPaths": [ # Output only. [Output only] AS-PATH for the route | |
| { | |
| "asns": [ # Output only. [Output only] ASNs in the path segment. When type is SEQUENCE, these are | |
| # ordered. | |
| 42, | |
| ], | |
| "asns32": [ # Output only. [Output only] ASNs in the path segment. This field is for better | |
| # support of 32 bit ASNs as the other asns field suffers from overflow when | |
| # the ASN is larger. When type is SEQUENCE, these are ordered. | |
| 42, | |
| ], | |
| "type": "A String", # Output only. [Output only] Type of AS-PATH segment (SEQUENCE or SET) | |
| }, | |
| ], | |
| "communities": [ # Output only. [Output only] BGP communities in human-readable A:B format. | |
| "A String", | |
| ], | |
| "destination": { # Network Layer Reachability Information (NLRI) for a route. # Output only. [Output only] Destination IP range for the route, in human-readable CIDR | |
| # format | |
| "pathId": 42, # If the BGP session supports multiple paths (RFC 7911), the path | |
| # identifier for this route. | |
| "prefix": "A String", # Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16. | |
| }, | |
| "med": 42, # Output only. [Output only] BGP multi-exit discriminator | |
| "origin": "A String", # Output only. [Output only] BGP origin (EGP, IGP or INCOMPLETE) | |
| }, | |
| ], | |
| "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. | |
| "unreachables": [ # Output only. [Output Only] Unreachable resources. | |
| "A String", | |
| ], | |
| "warning": { # [Output Only] Informational warning message. | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="listBgpRoutes_next">listBgpRoutes_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="listNamedSets">listNamedSets(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> | |
| <pre>Retrieves a list of router named set subresources available to the | |
| specified project. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name or id of the resource for this request. | |
| Name should conform to RFC1035. (required) | |
| filter: string, A filter expression that filters resources listed in the response. Most | |
| Compute resources support two types of filter expressions: | |
| expressions that support regular expressions and expressions that follow | |
| API improvement proposal AIP-160. | |
| These two types of filter expressions cannot be mixed in one request. | |
| If you want to use AIP-160, your expression must specify the field name, an | |
| operator, and the value that you want to use for filtering. The value | |
| must be a string, a number, or a boolean. The operator | |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. | |
| For example, if you are filtering Compute Engine instances, you can | |
| exclude instances named `example-instance` by specifying | |
| `name != example-instance`. | |
| The `:*` comparison can be used to test whether a key has been defined. | |
| For example, to find all objects with `owner` label use: | |
| ``` | |
| labels.owner:* | |
| ``` | |
| You can also filter nested fields. For example, you could specify | |
| `scheduling.automaticRestart = false` to include instances only | |
| if they are not scheduled for automatic restarts. You can use filtering | |
| on nested fields to filter based onresource labels. | |
| To filter on multiple expressions, provide each separate expression within | |
| parentheses. For example: | |
| ``` | |
| (scheduling.automaticRestart = true) | |
| (cpuPlatform = "Intel Skylake") | |
| ``` | |
| By default, each expression is an `AND` expression. However, you | |
| can include `AND` and `OR` expressions explicitly. | |
| For example: | |
| ``` | |
| (cpuPlatform = "Intel Skylake") OR | |
| (cpuPlatform = "Intel Broadwell") AND | |
| (scheduling.automaticRestart = true) | |
| ``` | |
| If you want to use a regular expression, use the `eq` (equal) or `ne` | |
| (not equal) operator against a single un-parenthesized expression with or | |
| without quotes or against multiple parenthesized expressions. Examples: | |
| `fieldname eq unquoted literal` | |
| `fieldname eq 'single quoted literal'` | |
| `fieldname eq "double quoted literal"` | |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` | |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. | |
| The literal value must match the entire field. | |
| For example, to filter for instances that do not end with name "instance", | |
| you would use `name ne .*instance`. | |
| You cannot combine constraints on multiple fields using regular | |
| expressions. | |
| maxResults: integer, The maximum number of results per page that should be returned. | |
| If the number of available results is larger than `maxResults`, | |
| Compute Engine returns a `nextPageToken` that can be used to get | |
| the next page of results in subsequent list requests. Acceptable values are | |
| `0` to `500`, inclusive. (Default: `500`) | |
| orderBy: string, Sorts list results by a certain order. By default, results | |
| are returned in alphanumerical order based on the resource name. | |
| You can also sort results in descending order based on the creation | |
| timestamp using `orderBy="creationTimestamp desc"`. This sorts | |
| results based on the `creationTimestamp` field in | |
| reverse chronological order (newest result first). Use this to sort | |
| resources like operations so that the newest operation is returned first. | |
| Currently, only sorting by `name` or | |
| `creationTimestamp desc` is supported. | |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the | |
| `nextPageToken` returned by a previous list request to get | |
| the next page of results. | |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case | |
| of failure. The default value is false. | |
| For example, when partial success behavior is enabled, aggregatedList for a | |
| single zone scope either returns all resources in the zone or no resources, | |
| with an error code. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "etag": "A String", | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "kind": "compute#routersListNamedSets", # Output only. [Output Only] Type of resource. Alwayscompute#routersListNamedSets for lists of named sets. | |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for | |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for | |
| # the query parameter pageToken in the next list request. | |
| # Subsequent list requests will have their own nextPageToken to | |
| # continue paging through the results. | |
| "result": [ # [Output Only] A list of named sets. | |
| { | |
| "description": "A String", # An optional description of named set. | |
| "elements": [ # CEL expressions that are comparable to constructs of this set's type | |
| # (see Policy Language). | |
| { # Represents a textual expression in the Common Expression Language (CEL) | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| ], | |
| "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is | |
| # essentially a hash of the Named Set used for optimistic locking. | |
| # The fingerprint is initially generated by Compute Engine and changes | |
| # after every request to modify or update the Named Set. You must always | |
| # provide an up-to-date fingerprint hash in order to update or change | |
| # labels. | |
| # | |
| # To see the latest fingerprint, make a getNamedSet() request | |
| # to retrieve a Named Set. | |
| "name": "A String", # This set's name, which must be a resource ID segment and unique within all | |
| # named sets owned by the Router. Name should conform to RFC1035. | |
| "type": "A String", # This named set's type | |
| }, | |
| ], | |
| "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. | |
| "unreachables": [ # Output only. [Output Only] Unreachable resources. | |
| "A String", | |
| ], | |
| "warning": { # [Output Only] Informational warning message. | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="listNamedSets_next">listNamedSets_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="listRoutePolicies">listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> | |
| <pre>Retrieves a list of router route policy subresources available to the | |
| specified project. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name or id of the resource for this request. | |
| Name should conform to RFC1035. (required) | |
| filter: string, A filter expression that filters resources listed in the response. Most | |
| Compute resources support two types of filter expressions: | |
| expressions that support regular expressions and expressions that follow | |
| API improvement proposal AIP-160. | |
| These two types of filter expressions cannot be mixed in one request. | |
| If you want to use AIP-160, your expression must specify the field name, an | |
| operator, and the value that you want to use for filtering. The value | |
| must be a string, a number, or a boolean. The operator | |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. | |
| For example, if you are filtering Compute Engine instances, you can | |
| exclude instances named `example-instance` by specifying | |
| `name != example-instance`. | |
| The `:*` comparison can be used to test whether a key has been defined. | |
| For example, to find all objects with `owner` label use: | |
| ``` | |
| labels.owner:* | |
| ``` | |
| You can also filter nested fields. For example, you could specify | |
| `scheduling.automaticRestart = false` to include instances only | |
| if they are not scheduled for automatic restarts. You can use filtering | |
| on nested fields to filter based onresource labels. | |
| To filter on multiple expressions, provide each separate expression within | |
| parentheses. For example: | |
| ``` | |
| (scheduling.automaticRestart = true) | |
| (cpuPlatform = "Intel Skylake") | |
| ``` | |
| By default, each expression is an `AND` expression. However, you | |
| can include `AND` and `OR` expressions explicitly. | |
| For example: | |
| ``` | |
| (cpuPlatform = "Intel Skylake") OR | |
| (cpuPlatform = "Intel Broadwell") AND | |
| (scheduling.automaticRestart = true) | |
| ``` | |
| If you want to use a regular expression, use the `eq` (equal) or `ne` | |
| (not equal) operator against a single un-parenthesized expression with or | |
| without quotes or against multiple parenthesized expressions. Examples: | |
| `fieldname eq unquoted literal` | |
| `fieldname eq 'single quoted literal'` | |
| `fieldname eq "double quoted literal"` | |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` | |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. | |
| The literal value must match the entire field. | |
| For example, to filter for instances that do not end with name "instance", | |
| you would use `name ne .*instance`. | |
| You cannot combine constraints on multiple fields using regular | |
| expressions. | |
| maxResults: integer, The maximum number of results per page that should be returned. | |
| If the number of available results is larger than `maxResults`, | |
| Compute Engine returns a `nextPageToken` that can be used to get | |
| the next page of results in subsequent list requests. Acceptable values are | |
| `0` to `500`, inclusive. (Default: `500`) | |
| orderBy: string, Sorts list results by a certain order. By default, results | |
| are returned in alphanumerical order based on the resource name. | |
| You can also sort results in descending order based on the creation | |
| timestamp using `orderBy="creationTimestamp desc"`. This sorts | |
| results based on the `creationTimestamp` field in | |
| reverse chronological order (newest result first). Use this to sort | |
| resources like operations so that the newest operation is returned first. | |
| Currently, only sorting by `name` or | |
| `creationTimestamp desc` is supported. | |
| pageToken: string, Specifies a page token to use. Set `pageToken` to the | |
| `nextPageToken` returned by a previous list request to get | |
| the next page of results. | |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case | |
| of failure. The default value is false. | |
| For example, when partial success behavior is enabled, aggregatedList for a | |
| single zone scope either returns all resources in the zone or no resources, | |
| with an error code. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "etag": "A String", | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "kind": "compute#routersListRoutePolicies", # Output only. [Output Only] Type of resource. Alwayscompute#routersListRoutePolicies for lists of route policies. | |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for | |
| # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for | |
| # the query parameter pageToken in the next list request. | |
| # Subsequent list requests will have their own nextPageToken to | |
| # continue paging through the results. | |
| "result": [ # [Output Only] A list of route policies. | |
| { | |
| "description": "A String", # An optional description of route policy. | |
| "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is | |
| # essentially a hash of the Route Policy used for optimistic locking. | |
| # The fingerprint is initially generated by Compute Engine and changes | |
| # after every request to modify or update Route Policy. You must always | |
| # provide an up-to-date fingerprint hash in order to update or change | |
| # labels. | |
| # | |
| # To see the latest fingerprint, make a getRoutePolicy() request | |
| # to retrieve a Route Policy. | |
| "name": "A String", # Route Policy name, which must be a resource ID segment and unique | |
| # within all the router's Route Policies. Name should conform to RFC1035. | |
| "terms": [ # List of terms (the order in the list is not important, they are evaluated | |
| # in order of priority). Order of policies is not retained and might change | |
| # when getting policy later. | |
| { | |
| "actions": [ # CEL expressions to evaluate to modify a route when this term matches. | |
| { # Represents a textual expression in the Common Expression Language (CEL) | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| ], | |
| "match": { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term | |
| # applies. When not set, the term applies to all | |
| # routes. | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| "priority": 42, # The evaluation priority for this term, which must be between 0 | |
| # (inclusive) and 2^31 (exclusive), and unique within the list. | |
| }, | |
| ], | |
| "type": "A String", | |
| }, | |
| ], | |
| "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. | |
| "unreachables": [ # Output only. [Output Only] Unreachable resources. | |
| "A String", | |
| ], | |
| "warning": { # [Output Only] Informational warning message. | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="listRoutePolicies_next">listRoutePolicies_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="patch">patch(project, region, router, body=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Patches the specified Router resource with the data included in the | |
| request. This method supportsPATCH | |
| semantics and usesJSON merge | |
| patch format and processing rules. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource to patch. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Represents a Cloud Router resource. | |
| # | |
| # For more information about Cloud Router, read theCloud | |
| # Router overview. | |
| "bgp": { # BGP information specific to this router. | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| # The options are DEFAULT or CUSTOM. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These groups will be advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These IP ranges will be advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "asn": 42, # Local BGP Autonomous System Number (ASN). | |
| # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The | |
| # value will be fixed for this router resource. All VPN tunnels that link | |
| # to this router will have the same local ASN. | |
| "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It | |
| # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at | |
| # least /30, even if the BGP sessions are over IPv6. It must not overlap | |
| # with any IPv4 BGP session ranges. | |
| # | |
| # | |
| # Other vendors commonly call this "router ID". | |
| "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are | |
| # sent to the peer. | |
| # | |
| # | |
| # Hold time is three times the interval at which keepalive messages are | |
| # sent, and the hold time is the maximum number of seconds allowed to | |
| # elapse between successive keepalive messages that BGP receives from a | |
| # peer. | |
| # | |
| # | |
| # BGP will use the smaller of either the local hold time value or the | |
| # peer's hold time value as the hold time for the BGP connection between | |
| # the two peers. | |
| # | |
| # | |
| # If set, this value must be between 20 and 60. The default is 20. | |
| }, | |
| "bgpPeers": [ # BGP information that must be configured into the routing stack to | |
| # establish BGP peering. This information must specify the peer ASN and | |
| # either the interface name, IP address, or peer IP address. Please refer toRFC4273. | |
| { | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, | |
| # which currently supports the following option: | |
| # | |
| # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This | |
| # excludes any routes learned for subnets that use | |
| # VPC Network Peering. | |
| # | |
| # | |
| # Note that this field can only be populated if advertise_mode is CUSTOM | |
| # and overrides the list defined for the router (in the "bgp" message). | |
| # These groups are advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # overrides the list defined for the router (in the "bgp" message). | |
| # These IP ranges are advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more | |
| # than one matching route of maximum length, the routes with the lowest | |
| # priority value win. | |
| "bfd": { # BFD configuration for the BGP peering. | |
| "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # received from the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # transmit interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # corresponding receive interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "mode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. | |
| "multiplier": 42, # The number of consecutive BFD packets that must be missed | |
| # before BFD declares that a peer is unavailable. | |
| # | |
| # | |
| # If set, the value must be a value between 5 and 16. | |
| # | |
| # | |
| # The default is 5. | |
| "packetMode": "A String", # The BFD packet mode for this BGP peer. | |
| # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. | |
| # In this mode, if the peer router also has BFD echo mode enabled, BFD | |
| # echo packets will be sent to the other router. If the peer router does | |
| # not have BFD echo mode enabled, only control packets will be sent. If | |
| # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If | |
| # this router and the peer router have a multihop connection, this should | |
| # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop | |
| # connections. The default is CONTROL_AND_ECHO. | |
| "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # | |
| # | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. | |
| "slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to and received from the peer router when BFD echo mode is | |
| # enabled on both routers. The actual transmit and receive intervals are | |
| # negotiated between the two routers and are equal to the greater of this | |
| # value and the corresponding interval on the other router. | |
| # If set, this value must be between 1000 and 30000. | |
| # The default is 5000. | |
| }, | |
| "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP | |
| # session. | |
| { | |
| "range": "A String", # The custom learned route IP address range. Must be a valid | |
| # CIDR-formatted prefix. If an IP address is provided without a subnet | |
| # mask, it is interpreted as, for IPv4, a `/32` singular IP address | |
| # range, and, for IPv6, `/128`. | |
| }, | |
| ], | |
| "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This | |
| # value is applied to all custom learned route ranges for the session. | |
| # You can choose a value from `0` to `65335`. If you don't provide a | |
| # value, Google Cloud assigns a priority of `100` to the ranges. | |
| "enable": "A String", # The status of the BGP peer connection. | |
| # | |
| # | |
| # If set to FALSE, any active session with the peer is terminated and | |
| # all associated routing information is removed. If set to TRUE, the | |
| # peer connection can be established with routing information. The default | |
| # is TRUE. | |
| "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if | |
| # the peerIpAddress is version 4. | |
| "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the | |
| # peerIpAddress is version 6. | |
| "exportPolicies": [ # List of export policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_EXPORT type. | |
| "A String", | |
| ], | |
| "importPolicies": [ # List of import policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_IMPORT type. | |
| "A String", | |
| ], | |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. | |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. | |
| "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. | |
| "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. | |
| "linkedCustomHardware": "A String", # The linked custom hardware resource. | |
| # The URI of the custom hardware link attachment | |
| # is where you will establish the BGP session from the Cloud Router. | |
| # This link attachment must reside in the same subnetwork as the associated | |
| # router interface. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed by you | |
| # or other users | |
| # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed | |
| # by Cloud Interconnect, specifically by an InterconnectAttachment of type | |
| # PARTNER. Google automatically creates, updates, and deletes this type of | |
| # BGP peer when the PARTNER InterconnectAttachment is created, updated, | |
| # or deleted. | |
| "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the | |
| # name of one of the entries in the Router.md5_authentication_keys. The | |
| # field must comply with RFC1035. | |
| "name": "A String", # Name of this BGP peer. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use | |
| # a different value. | |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. | |
| "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router | |
| # appliances such as Next Gen Firewalls, Virtual Routers, or Router | |
| # Appliances. The VM instance must be located in zones contained in the | |
| # same region as this Cloud Router. | |
| # The VM instance is the peer side of the BGP session. | |
| }, | |
| ], | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN | |
| # attachments (interconnectAttachments). | |
| "etag": "A String", # ETag for optimistic concurrency control as described by AIP 154. Used to | |
| # prevent conflicting updates. If provided, the request will succeed only if | |
| # the etag matches the current etag of the router; otherwise, the request | |
| # fails with an ABORTED error. | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "interfaces": [ # Router interfaces. | |
| # To create a BGP peer that uses a router interface, | |
| # the interface must have one of the following fields specified: | |
| # | |
| # - linkedVpnTunnel | |
| # - linkedInterconnectAttachment | |
| # - subnetwork | |
| # | |
| # | |
| # You can create a router interface without any of these fields specified. | |
| # However, you cannot create a BGP peer that uses that interface. | |
| { | |
| "ipRange": "A String", # IP address and range of the interface. | |
| # | |
| # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must | |
| # be a CIDR-formatted string, for example, 169.254.0.1/30. | |
| # Note: Do not truncate the IP address, as it represents the IP address of | |
| # the interface. | |
| # - For Internet Protocol version 6 (IPv6), the value | |
| # must be a unique local address (ULA) range from fdff:1::/64 | |
| # with a mask length of 126 or less. This value should be a CIDR-formatted | |
| # string, for example, fdff:1::1/112. Within the router's | |
| # VPC, this IPv6 prefix will be reserved exclusively for this connection | |
| # and cannot be used for any other purpose. | |
| "ipVersion": "A String", # IP version of this interface. | |
| "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region | |
| # as the router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the | |
| # router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed directly | |
| # by users. | |
| # - MANAGED_BY_ATTACHMENT is an interface that is configured and | |
| # managed by Cloud Interconnect, specifically, by an InterconnectAttachment | |
| # of type PARTNER. Google automatically creates, updates, and deletes | |
| # this type of interface when the PARTNER InterconnectAttachment is | |
| # created, updated, or deleted. | |
| "name": "A String", # Name of this interface entry. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "privateIpAddress": "A String", # The regional private internal IP address that is used to establish | |
| # BGP sessions to a VM instance acting as a third-party | |
| # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or | |
| # an SD-WAN VM. | |
| "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface | |
| # you are creating. The redundantInterface must belong to the same Cloud | |
| # Router as the interface here. To establish the BGP session to a Router | |
| # Appliance VM, you must create two BGP peers. The two BGP peers must be | |
| # attached to two separate interfaces that are redundant with each other. | |
| # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must | |
| # be 1-63 characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which | |
| # must be in the same region as the Cloud Router. | |
| # When you establish a BGP session to a VM instance using this interface, | |
| # the VM instance must belong to the same subnetwork as the subnetwork | |
| # specified here. | |
| }, | |
| ], | |
| "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for | |
| # routers. | |
| "md5AuthenticationKeys": [ # Keys used for MD5 authentication. | |
| { | |
| "key": "A String", # [Input only] Value of the key. | |
| # | |
| # For patch and update calls, it can be skipped to | |
| # copy the value from the previous configuration. This is allowed if the | |
| # key with the same name existed before the operation. Maximum length is 80 | |
| # characters. Can only contain printable ASCII characters. | |
| "name": "A String", # Name used to identify the key. | |
| # | |
| # Must be unique within a router. Must be referenced by exactly | |
| # one bgpPeer. Must comply withRFC1035. | |
| }, | |
| ], | |
| "name": "A String", # Name of the resource. Provided by the client when the resource is created. | |
| # The name must be 1-63 characters long, and comply withRFC1035. | |
| # Specifically, the name must be 1-63 characters long and match the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first | |
| # character must be a lowercase letter, and all following characters must | |
| # be a dash, lowercase letter, or digit, except the last character, which | |
| # cannot be a dash. | |
| "nats": [ # A list of NAT services created in this router. | |
| { # Represents a Nat resource. It enables the VMs within the specified | |
| # subnetworks to access Internet without external IP addresses. It specifies | |
| # a list of subnetworks (and the ranges within) that want to use NAT. | |
| # Customers can also provide the external IPs that would be used for NAT. GCP | |
| # would auto-allocate ephemeral IPs if no external IPs are provided. | |
| "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. | |
| # Must be one of: PREMIUM, STANDARD. | |
| # If not specified, then the current | |
| # project-level default tier is used. | |
| "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT only. | |
| "A String", | |
| ], | |
| "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT | |
| # state. This value is equal to tcp_time_wait_timeout_sec. | |
| # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or | |
| # 120s. The field is output only. | |
| "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. | |
| # | |
| # | |
| # If not specified, it is disabled by default. | |
| # | |
| # | |
| # If set to true, | |
| # | |
| # - Dynamic Port Allocation will be enabled on this NAT | |
| # config. | |
| # - enableEndpointIndependentMapping cannot be set to true. | |
| # - If minPorts is set, minPortsPerVm must be set to a | |
| # power of two greater than or equal to 32. If minPortsPerVm is not set, a | |
| # minimum of 32 ports will be allocated to a VM from this NAT | |
| # config. | |
| "enableEndpointIndependentMapping": True or False, | |
| "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list | |
| # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM | |
| "A String", | |
| ], | |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. | |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. | |
| "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, | |
| # logs are exported for all connections handled by this NAT. | |
| # This option can take one of the following values: | |
| # | |
| # - ERRORS_ONLY: Export logs only for connection failures. | |
| # - TRANSLATIONS_ONLY: Export logs only for successful | |
| # connections. | |
| # - ALL: Export logs for all connections, successful and | |
| # unsuccessful. | |
| }, | |
| "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when | |
| # Dynamic Port Allocation is enabled. | |
| # | |
| # | |
| # If Dynamic Port Allocation is not enabled, this field has no effect. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled, and this field is set, it must be | |
| # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm | |
| # is not set. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled and this field is not set, | |
| # a maximum of 65536 ports will be allocated to a VM from this NAT | |
| # config. | |
| "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not | |
| # set, a default number of ports is allocated to a VM. This is rounded | |
| # up to the nearest power of 2. For example, if the value of this field is | |
| # 50, at least 64 ports are allocated to a VM. | |
| "name": "A String", # Unique name of this Nat service. | |
| # The name must be 1-63 characters long and comply withRFC1035. | |
| "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64 | |
| # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is | |
| # selected for the SubnetworkIpRangeToNat64Option above. | |
| { # Specifies a subnetwork to enable NAT64. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT64. | |
| }, | |
| ], | |
| "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following | |
| # values: | |
| # | |
| # - MANUAL_ONLY: Uses only Nat IP addresses provided by | |
| # customers. When there are not enough specified Nat IPs, the Nat service | |
| # fails for new VMs. | |
| # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers | |
| # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should | |
| # be empty. | |
| "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| "A String", | |
| ], | |
| "rules": [ # A list of rules associated with this NAT. | |
| { | |
| "action": { # The action to be enforced for traffic that matches this rule. | |
| "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this | |
| # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT rule only. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be | |
| # drained. This is only supported on patch/update, and these | |
| # subnetworks must have previously been used as active ranges in this | |
| # NAT Rule. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| }, | |
| "description": "A String", # An optional description of this rule. | |
| "match": "A String", # CEL expression that specifies the match condition that egress traffic | |
| # from a VM is evaluated against. If it evaluates to true, the | |
| # corresponding `action` is enforced. | |
| # | |
| # The following examples are valid match expressions for public NAT: | |
| # | |
| # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, | |
| # '2.2.0.0/16')` | |
| # | |
| # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` | |
| # | |
| # The following examples are valid match expressions for private NAT: | |
| # | |
| # (NAT 44) | |
| # `nexthop.hub == | |
| # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` | |
| # | |
| # `nexthop.is_hybrid` | |
| # | |
| # (NAT 64) | |
| # `isIPv6(source.ip)` | |
| "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number | |
| # must be a positive value between 0 and 65000, and | |
| # must be unique among rules within a NAT. | |
| "sourceWorkloadIdentities": [ # A list of source workload identities. | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: | |
| # | |
| # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every | |
| # Subnetwork are allowed to Nat. | |
| # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges | |
| # in every Subnetwork are allowed to Nat. | |
| # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field subnetwork below) | |
| # | |
| # | |
| # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. | |
| # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there | |
| # should not be any other Router.Nat section in any Router for this network | |
| # in this region. | |
| "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following | |
| # values: | |
| # | |
| # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in | |
| # every Subnetwork are allowed to Nat. | |
| # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field nat64_subnetwork below) | |
| # | |
| # | |
| # The default is NAT64_OPTION_UNSPECIFIED. | |
| # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other | |
| # Router.Nat section in this region can also enable NAT64 for any | |
| # Subnetworks in this network. Other Router.Nat sections can still be | |
| # present to enable NAT44 only. | |
| "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT | |
| # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the | |
| # SubnetworkIpRangeToNatOption above. | |
| { # Defines the IP ranges that want to use NAT for a subnetwork. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT. | |
| "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to | |
| # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" | |
| # is one of the values in source_ip_ranges_to_nat. | |
| "A String", | |
| ], | |
| "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All | |
| # options of a single value are valid except | |
| # NAT_IP_RANGE_OPTION_UNSPECIFIED. | |
| # The only valid option with multiple values is: ["PRIMARY_IP_RANGE", | |
| # "LIST_OF_SECONDARY_IP_RANGES"] | |
| # Default: [ALL_IP_RANGES] | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s | |
| # if not set. | |
| "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. | |
| # Defaults to 120s if not set. | |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if | |
| # not set. | |
| "type": "A String", # Indicates whether this NAT is used for public or private IP | |
| # translation. If unspecified, it defaults to PUBLIC. | |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. | |
| }, | |
| ], | |
| "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. | |
| "network": "A String", # URI of the network to which this router belongs. | |
| "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted | |
| # as part of resource payload. | |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. | |
| # The field is allowed for INSERT | |
| # only. The keys/values to set on the resource should be specified in | |
| # either ID { : } or Namespaced format | |
| # { : }. | |
| # For example the following are valid inputs: | |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} | |
| # * {"123/environment" : "production", "345/abc" : "xyz"} | |
| # Note: | |
| # * Invalid combinations of ID & namespaced format is not supported. For | |
| # instance: {"123/environment" : "tagValues/444"} is invalid. | |
| # * Inconsistent format is not supported. For instance: | |
| # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| "region": "A String", # [Output Only] URI of the region where the router resides. | |
| # You must specify this field as part of the HTTP request URL. It is | |
| # not settable as a field in the request body. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| } | |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so | |
| that if you must retry your request, the server will know to ignore the | |
| request if it has already been completed. | |
| For example, consider a situation where you make an initial request and | |
| the request times out. If you make the request again with the same | |
| request ID, the server can check if original operation with the same | |
| request ID was received, and if so, will ignore the second request. This | |
| prevents clients from accidentally creating duplicate commitments. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the | |
| # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule | |
| # methods if not explicitly provided by the user. | |
| "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query | |
| # parameters specified minPriority/maxPriority. | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error | |
| # status code that was returned. For example, a `404` means the | |
| # resource was not found. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. | |
| # There is no requirement that this be linear or support any granularity of | |
| # operations. This should not be used to guess when the operation will be | |
| # complete. This number should monotonically increase as the operation | |
| # progresses. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For | |
| # operations related to creating a snapshot, this points to the disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="patchNamedSet">patchNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Patches Named Set | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource where Named Set is defined. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "description": "A String", # An optional description of named set. | |
| "elements": [ # CEL expressions that are comparable to constructs of this set's type | |
| # (see Policy Language). | |
| { # Represents a textual expression in the Common Expression Language (CEL) | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| ], | |
| "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is | |
| # essentially a hash of the Named Set used for optimistic locking. | |
| # The fingerprint is initially generated by Compute Engine and changes | |
| # after every request to modify or update the Named Set. You must always | |
| # provide an up-to-date fingerprint hash in order to update or change | |
| # labels. | |
| # | |
| # To see the latest fingerprint, make a getNamedSet() request | |
| # to retrieve a Named Set. | |
| "name": "A String", # This set's name, which must be a resource ID segment and unique within all | |
| # named sets owned by the Router. Name should conform to RFC1035. | |
| "type": "A String", # This named set's type | |
| } | |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so | |
| that if you must retry your request, the server will know to ignore the | |
| request if it has already been completed. | |
| For example, consider a situation where you make an initial request and | |
| the request times out. If you make the request again with the same | |
| request ID, the server can check if original operation with the same | |
| request ID was received, and if so, will ignore the second request. This | |
| prevents clients from accidentally creating duplicate commitments. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the | |
| # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule | |
| # methods if not explicitly provided by the user. | |
| "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query | |
| # parameters specified minPriority/maxPriority. | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error | |
| # status code that was returned. For example, a `404` means the | |
| # resource was not found. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. | |
| # There is no requirement that this be linear or support any granularity of | |
| # operations. This should not be used to guess when the operation will be | |
| # complete. This number should monotonically increase as the operation | |
| # progresses. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For | |
| # operations related to creating a snapshot, this points to the disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="patchRoutePolicy">patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Patches Route Policy | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource where Route Policy is defined. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "description": "A String", # An optional description of route policy. | |
| "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is | |
| # essentially a hash of the Route Policy used for optimistic locking. | |
| # The fingerprint is initially generated by Compute Engine and changes | |
| # after every request to modify or update Route Policy. You must always | |
| # provide an up-to-date fingerprint hash in order to update or change | |
| # labels. | |
| # | |
| # To see the latest fingerprint, make a getRoutePolicy() request | |
| # to retrieve a Route Policy. | |
| "name": "A String", # Route Policy name, which must be a resource ID segment and unique | |
| # within all the router's Route Policies. Name should conform to RFC1035. | |
| "terms": [ # List of terms (the order in the list is not important, they are evaluated | |
| # in order of priority). Order of policies is not retained and might change | |
| # when getting policy later. | |
| { | |
| "actions": [ # CEL expressions to evaluate to modify a route when this term matches. | |
| { # Represents a textual expression in the Common Expression Language (CEL) | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| ], | |
| "match": { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term | |
| # applies. When not set, the term applies to all | |
| # routes. | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| "priority": 42, # The evaluation priority for this term, which must be between 0 | |
| # (inclusive) and 2^31 (exclusive), and unique within the list. | |
| }, | |
| ], | |
| "type": "A String", | |
| } | |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so | |
| that if you must retry your request, the server will know to ignore the | |
| request if it has already been completed. | |
| For example, consider a situation where you make an initial request and | |
| the request times out. If you make the request again with the same | |
| request ID, the server can check if original operation with the same | |
| request ID was received, and if so, will ignore the second request. This | |
| prevents clients from accidentally creating duplicate commitments. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the | |
| # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule | |
| # methods if not explicitly provided by the user. | |
| "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query | |
| # parameters specified minPriority/maxPriority. | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error | |
| # status code that was returned. For example, a `404` means the | |
| # resource was not found. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. | |
| # There is no requirement that this be linear or support any granularity of | |
| # operations. This should not be used to guess when the operation will be | |
| # complete. This number should monotonically increase as the operation | |
| # progresses. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For | |
| # operations related to creating a snapshot, this points to the disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="preview">preview(project, region, router, body=None, x__xgafv=None)</code> | |
| <pre>Preview fields auto-generated during router create andupdate operations. | |
| Calling this method does NOT create or update the router. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource to query. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Represents a Cloud Router resource. | |
| # | |
| # For more information about Cloud Router, read theCloud | |
| # Router overview. | |
| "bgp": { # BGP information specific to this router. | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| # The options are DEFAULT or CUSTOM. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These groups will be advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These IP ranges will be advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "asn": 42, # Local BGP Autonomous System Number (ASN). | |
| # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The | |
| # value will be fixed for this router resource. All VPN tunnels that link | |
| # to this router will have the same local ASN. | |
| "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It | |
| # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at | |
| # least /30, even if the BGP sessions are over IPv6. It must not overlap | |
| # with any IPv4 BGP session ranges. | |
| # | |
| # | |
| # Other vendors commonly call this "router ID". | |
| "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are | |
| # sent to the peer. | |
| # | |
| # | |
| # Hold time is three times the interval at which keepalive messages are | |
| # sent, and the hold time is the maximum number of seconds allowed to | |
| # elapse between successive keepalive messages that BGP receives from a | |
| # peer. | |
| # | |
| # | |
| # BGP will use the smaller of either the local hold time value or the | |
| # peer's hold time value as the hold time for the BGP connection between | |
| # the two peers. | |
| # | |
| # | |
| # If set, this value must be between 20 and 60. The default is 20. | |
| }, | |
| "bgpPeers": [ # BGP information that must be configured into the routing stack to | |
| # establish BGP peering. This information must specify the peer ASN and | |
| # either the interface name, IP address, or peer IP address. Please refer toRFC4273. | |
| { | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, | |
| # which currently supports the following option: | |
| # | |
| # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This | |
| # excludes any routes learned for subnets that use | |
| # VPC Network Peering. | |
| # | |
| # | |
| # Note that this field can only be populated if advertise_mode is CUSTOM | |
| # and overrides the list defined for the router (in the "bgp" message). | |
| # These groups are advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # overrides the list defined for the router (in the "bgp" message). | |
| # These IP ranges are advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more | |
| # than one matching route of maximum length, the routes with the lowest | |
| # priority value win. | |
| "bfd": { # BFD configuration for the BGP peering. | |
| "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # received from the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # transmit interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # corresponding receive interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "mode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. | |
| "multiplier": 42, # The number of consecutive BFD packets that must be missed | |
| # before BFD declares that a peer is unavailable. | |
| # | |
| # | |
| # If set, the value must be a value between 5 and 16. | |
| # | |
| # | |
| # The default is 5. | |
| "packetMode": "A String", # The BFD packet mode for this BGP peer. | |
| # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. | |
| # In this mode, if the peer router also has BFD echo mode enabled, BFD | |
| # echo packets will be sent to the other router. If the peer router does | |
| # not have BFD echo mode enabled, only control packets will be sent. If | |
| # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If | |
| # this router and the peer router have a multihop connection, this should | |
| # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop | |
| # connections. The default is CONTROL_AND_ECHO. | |
| "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # | |
| # | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. | |
| "slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to and received from the peer router when BFD echo mode is | |
| # enabled on both routers. The actual transmit and receive intervals are | |
| # negotiated between the two routers and are equal to the greater of this | |
| # value and the corresponding interval on the other router. | |
| # If set, this value must be between 1000 and 30000. | |
| # The default is 5000. | |
| }, | |
| "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP | |
| # session. | |
| { | |
| "range": "A String", # The custom learned route IP address range. Must be a valid | |
| # CIDR-formatted prefix. If an IP address is provided without a subnet | |
| # mask, it is interpreted as, for IPv4, a `/32` singular IP address | |
| # range, and, for IPv6, `/128`. | |
| }, | |
| ], | |
| "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This | |
| # value is applied to all custom learned route ranges for the session. | |
| # You can choose a value from `0` to `65335`. If you don't provide a | |
| # value, Google Cloud assigns a priority of `100` to the ranges. | |
| "enable": "A String", # The status of the BGP peer connection. | |
| # | |
| # | |
| # If set to FALSE, any active session with the peer is terminated and | |
| # all associated routing information is removed. If set to TRUE, the | |
| # peer connection can be established with routing information. The default | |
| # is TRUE. | |
| "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if | |
| # the peerIpAddress is version 4. | |
| "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the | |
| # peerIpAddress is version 6. | |
| "exportPolicies": [ # List of export policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_EXPORT type. | |
| "A String", | |
| ], | |
| "importPolicies": [ # List of import policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_IMPORT type. | |
| "A String", | |
| ], | |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. | |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. | |
| "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. | |
| "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. | |
| "linkedCustomHardware": "A String", # The linked custom hardware resource. | |
| # The URI of the custom hardware link attachment | |
| # is where you will establish the BGP session from the Cloud Router. | |
| # This link attachment must reside in the same subnetwork as the associated | |
| # router interface. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed by you | |
| # or other users | |
| # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed | |
| # by Cloud Interconnect, specifically by an InterconnectAttachment of type | |
| # PARTNER. Google automatically creates, updates, and deletes this type of | |
| # BGP peer when the PARTNER InterconnectAttachment is created, updated, | |
| # or deleted. | |
| "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the | |
| # name of one of the entries in the Router.md5_authentication_keys. The | |
| # field must comply with RFC1035. | |
| "name": "A String", # Name of this BGP peer. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use | |
| # a different value. | |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. | |
| "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router | |
| # appliances such as Next Gen Firewalls, Virtual Routers, or Router | |
| # Appliances. The VM instance must be located in zones contained in the | |
| # same region as this Cloud Router. | |
| # The VM instance is the peer side of the BGP session. | |
| }, | |
| ], | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN | |
| # attachments (interconnectAttachments). | |
| "etag": "A String", # ETag for optimistic concurrency control as described by AIP 154. Used to | |
| # prevent conflicting updates. If provided, the request will succeed only if | |
| # the etag matches the current etag of the router; otherwise, the request | |
| # fails with an ABORTED error. | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "interfaces": [ # Router interfaces. | |
| # To create a BGP peer that uses a router interface, | |
| # the interface must have one of the following fields specified: | |
| # | |
| # - linkedVpnTunnel | |
| # - linkedInterconnectAttachment | |
| # - subnetwork | |
| # | |
| # | |
| # You can create a router interface without any of these fields specified. | |
| # However, you cannot create a BGP peer that uses that interface. | |
| { | |
| "ipRange": "A String", # IP address and range of the interface. | |
| # | |
| # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must | |
| # be a CIDR-formatted string, for example, 169.254.0.1/30. | |
| # Note: Do not truncate the IP address, as it represents the IP address of | |
| # the interface. | |
| # - For Internet Protocol version 6 (IPv6), the value | |
| # must be a unique local address (ULA) range from fdff:1::/64 | |
| # with a mask length of 126 or less. This value should be a CIDR-formatted | |
| # string, for example, fdff:1::1/112. Within the router's | |
| # VPC, this IPv6 prefix will be reserved exclusively for this connection | |
| # and cannot be used for any other purpose. | |
| "ipVersion": "A String", # IP version of this interface. | |
| "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region | |
| # as the router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the | |
| # router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed directly | |
| # by users. | |
| # - MANAGED_BY_ATTACHMENT is an interface that is configured and | |
| # managed by Cloud Interconnect, specifically, by an InterconnectAttachment | |
| # of type PARTNER. Google automatically creates, updates, and deletes | |
| # this type of interface when the PARTNER InterconnectAttachment is | |
| # created, updated, or deleted. | |
| "name": "A String", # Name of this interface entry. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "privateIpAddress": "A String", # The regional private internal IP address that is used to establish | |
| # BGP sessions to a VM instance acting as a third-party | |
| # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or | |
| # an SD-WAN VM. | |
| "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface | |
| # you are creating. The redundantInterface must belong to the same Cloud | |
| # Router as the interface here. To establish the BGP session to a Router | |
| # Appliance VM, you must create two BGP peers. The two BGP peers must be | |
| # attached to two separate interfaces that are redundant with each other. | |
| # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must | |
| # be 1-63 characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which | |
| # must be in the same region as the Cloud Router. | |
| # When you establish a BGP session to a VM instance using this interface, | |
| # the VM instance must belong to the same subnetwork as the subnetwork | |
| # specified here. | |
| }, | |
| ], | |
| "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for | |
| # routers. | |
| "md5AuthenticationKeys": [ # Keys used for MD5 authentication. | |
| { | |
| "key": "A String", # [Input only] Value of the key. | |
| # | |
| # For patch and update calls, it can be skipped to | |
| # copy the value from the previous configuration. This is allowed if the | |
| # key with the same name existed before the operation. Maximum length is 80 | |
| # characters. Can only contain printable ASCII characters. | |
| "name": "A String", # Name used to identify the key. | |
| # | |
| # Must be unique within a router. Must be referenced by exactly | |
| # one bgpPeer. Must comply withRFC1035. | |
| }, | |
| ], | |
| "name": "A String", # Name of the resource. Provided by the client when the resource is created. | |
| # The name must be 1-63 characters long, and comply withRFC1035. | |
| # Specifically, the name must be 1-63 characters long and match the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first | |
| # character must be a lowercase letter, and all following characters must | |
| # be a dash, lowercase letter, or digit, except the last character, which | |
| # cannot be a dash. | |
| "nats": [ # A list of NAT services created in this router. | |
| { # Represents a Nat resource. It enables the VMs within the specified | |
| # subnetworks to access Internet without external IP addresses. It specifies | |
| # a list of subnetworks (and the ranges within) that want to use NAT. | |
| # Customers can also provide the external IPs that would be used for NAT. GCP | |
| # would auto-allocate ephemeral IPs if no external IPs are provided. | |
| "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. | |
| # Must be one of: PREMIUM, STANDARD. | |
| # If not specified, then the current | |
| # project-level default tier is used. | |
| "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT only. | |
| "A String", | |
| ], | |
| "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT | |
| # state. This value is equal to tcp_time_wait_timeout_sec. | |
| # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or | |
| # 120s. The field is output only. | |
| "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. | |
| # | |
| # | |
| # If not specified, it is disabled by default. | |
| # | |
| # | |
| # If set to true, | |
| # | |
| # - Dynamic Port Allocation will be enabled on this NAT | |
| # config. | |
| # - enableEndpointIndependentMapping cannot be set to true. | |
| # - If minPorts is set, minPortsPerVm must be set to a | |
| # power of two greater than or equal to 32. If minPortsPerVm is not set, a | |
| # minimum of 32 ports will be allocated to a VM from this NAT | |
| # config. | |
| "enableEndpointIndependentMapping": True or False, | |
| "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list | |
| # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM | |
| "A String", | |
| ], | |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. | |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. | |
| "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, | |
| # logs are exported for all connections handled by this NAT. | |
| # This option can take one of the following values: | |
| # | |
| # - ERRORS_ONLY: Export logs only for connection failures. | |
| # - TRANSLATIONS_ONLY: Export logs only for successful | |
| # connections. | |
| # - ALL: Export logs for all connections, successful and | |
| # unsuccessful. | |
| }, | |
| "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when | |
| # Dynamic Port Allocation is enabled. | |
| # | |
| # | |
| # If Dynamic Port Allocation is not enabled, this field has no effect. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled, and this field is set, it must be | |
| # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm | |
| # is not set. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled and this field is not set, | |
| # a maximum of 65536 ports will be allocated to a VM from this NAT | |
| # config. | |
| "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not | |
| # set, a default number of ports is allocated to a VM. This is rounded | |
| # up to the nearest power of 2. For example, if the value of this field is | |
| # 50, at least 64 ports are allocated to a VM. | |
| "name": "A String", # Unique name of this Nat service. | |
| # The name must be 1-63 characters long and comply withRFC1035. | |
| "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64 | |
| # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is | |
| # selected for the SubnetworkIpRangeToNat64Option above. | |
| { # Specifies a subnetwork to enable NAT64. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT64. | |
| }, | |
| ], | |
| "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following | |
| # values: | |
| # | |
| # - MANUAL_ONLY: Uses only Nat IP addresses provided by | |
| # customers. When there are not enough specified Nat IPs, the Nat service | |
| # fails for new VMs. | |
| # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers | |
| # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should | |
| # be empty. | |
| "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| "A String", | |
| ], | |
| "rules": [ # A list of rules associated with this NAT. | |
| { | |
| "action": { # The action to be enforced for traffic that matches this rule. | |
| "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this | |
| # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT rule only. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be | |
| # drained. This is only supported on patch/update, and these | |
| # subnetworks must have previously been used as active ranges in this | |
| # NAT Rule. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| }, | |
| "description": "A String", # An optional description of this rule. | |
| "match": "A String", # CEL expression that specifies the match condition that egress traffic | |
| # from a VM is evaluated against. If it evaluates to true, the | |
| # corresponding `action` is enforced. | |
| # | |
| # The following examples are valid match expressions for public NAT: | |
| # | |
| # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, | |
| # '2.2.0.0/16')` | |
| # | |
| # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` | |
| # | |
| # The following examples are valid match expressions for private NAT: | |
| # | |
| # (NAT 44) | |
| # `nexthop.hub == | |
| # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` | |
| # | |
| # `nexthop.is_hybrid` | |
| # | |
| # (NAT 64) | |
| # `isIPv6(source.ip)` | |
| "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number | |
| # must be a positive value between 0 and 65000, and | |
| # must be unique among rules within a NAT. | |
| "sourceWorkloadIdentities": [ # A list of source workload identities. | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: | |
| # | |
| # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every | |
| # Subnetwork are allowed to Nat. | |
| # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges | |
| # in every Subnetwork are allowed to Nat. | |
| # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field subnetwork below) | |
| # | |
| # | |
| # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. | |
| # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there | |
| # should not be any other Router.Nat section in any Router for this network | |
| # in this region. | |
| "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following | |
| # values: | |
| # | |
| # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in | |
| # every Subnetwork are allowed to Nat. | |
| # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field nat64_subnetwork below) | |
| # | |
| # | |
| # The default is NAT64_OPTION_UNSPECIFIED. | |
| # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other | |
| # Router.Nat section in this region can also enable NAT64 for any | |
| # Subnetworks in this network. Other Router.Nat sections can still be | |
| # present to enable NAT44 only. | |
| "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT | |
| # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the | |
| # SubnetworkIpRangeToNatOption above. | |
| { # Defines the IP ranges that want to use NAT for a subnetwork. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT. | |
| "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to | |
| # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" | |
| # is one of the values in source_ip_ranges_to_nat. | |
| "A String", | |
| ], | |
| "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All | |
| # options of a single value are valid except | |
| # NAT_IP_RANGE_OPTION_UNSPECIFIED. | |
| # The only valid option with multiple values is: ["PRIMARY_IP_RANGE", | |
| # "LIST_OF_SECONDARY_IP_RANGES"] | |
| # Default: [ALL_IP_RANGES] | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s | |
| # if not set. | |
| "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. | |
| # Defaults to 120s if not set. | |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if | |
| # not set. | |
| "type": "A String", # Indicates whether this NAT is used for public or private IP | |
| # translation. If unspecified, it defaults to PUBLIC. | |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. | |
| }, | |
| ], | |
| "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. | |
| "network": "A String", # URI of the network to which this router belongs. | |
| "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted | |
| # as part of resource payload. | |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. | |
| # The field is allowed for INSERT | |
| # only. The keys/values to set on the resource should be specified in | |
| # either ID { : } or Namespaced format | |
| # { : }. | |
| # For example the following are valid inputs: | |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} | |
| # * {"123/environment" : "production", "345/abc" : "xyz"} | |
| # Note: | |
| # * Invalid combinations of ID & namespaced format is not supported. For | |
| # instance: {"123/environment" : "tagValues/444"} is invalid. | |
| # * Inconsistent format is not supported. For instance: | |
| # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| "region": "A String", # [Output Only] URI of the region where the router resides. | |
| # You must specify this field as part of the HTTP request URL. It is | |
| # not settable as a field in the request body. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "resource": { # Represents a Cloud Router resource. # Preview of given router. | |
| # | |
| # For more information about Cloud Router, read theCloud | |
| # Router overview. | |
| "bgp": { # BGP information specific to this router. | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| # The options are DEFAULT or CUSTOM. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These groups will be advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These IP ranges will be advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "asn": 42, # Local BGP Autonomous System Number (ASN). | |
| # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The | |
| # value will be fixed for this router resource. All VPN tunnels that link | |
| # to this router will have the same local ASN. | |
| "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It | |
| # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at | |
| # least /30, even if the BGP sessions are over IPv6. It must not overlap | |
| # with any IPv4 BGP session ranges. | |
| # | |
| # | |
| # Other vendors commonly call this "router ID". | |
| "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are | |
| # sent to the peer. | |
| # | |
| # | |
| # Hold time is three times the interval at which keepalive messages are | |
| # sent, and the hold time is the maximum number of seconds allowed to | |
| # elapse between successive keepalive messages that BGP receives from a | |
| # peer. | |
| # | |
| # | |
| # BGP will use the smaller of either the local hold time value or the | |
| # peer's hold time value as the hold time for the BGP connection between | |
| # the two peers. | |
| # | |
| # | |
| # If set, this value must be between 20 and 60. The default is 20. | |
| }, | |
| "bgpPeers": [ # BGP information that must be configured into the routing stack to | |
| # establish BGP peering. This information must specify the peer ASN and | |
| # either the interface name, IP address, or peer IP address. Please refer toRFC4273. | |
| { | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, | |
| # which currently supports the following option: | |
| # | |
| # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This | |
| # excludes any routes learned for subnets that use | |
| # VPC Network Peering. | |
| # | |
| # | |
| # Note that this field can only be populated if advertise_mode is CUSTOM | |
| # and overrides the list defined for the router (in the "bgp" message). | |
| # These groups are advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # overrides the list defined for the router (in the "bgp" message). | |
| # These IP ranges are advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more | |
| # than one matching route of maximum length, the routes with the lowest | |
| # priority value win. | |
| "bfd": { # BFD configuration for the BGP peering. | |
| "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # received from the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # transmit interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # corresponding receive interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "mode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. | |
| "multiplier": 42, # The number of consecutive BFD packets that must be missed | |
| # before BFD declares that a peer is unavailable. | |
| # | |
| # | |
| # If set, the value must be a value between 5 and 16. | |
| # | |
| # | |
| # The default is 5. | |
| "packetMode": "A String", # The BFD packet mode for this BGP peer. | |
| # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. | |
| # In this mode, if the peer router also has BFD echo mode enabled, BFD | |
| # echo packets will be sent to the other router. If the peer router does | |
| # not have BFD echo mode enabled, only control packets will be sent. If | |
| # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If | |
| # this router and the peer router have a multihop connection, this should | |
| # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop | |
| # connections. The default is CONTROL_AND_ECHO. | |
| "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # | |
| # | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. | |
| "slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to and received from the peer router when BFD echo mode is | |
| # enabled on both routers. The actual transmit and receive intervals are | |
| # negotiated between the two routers and are equal to the greater of this | |
| # value and the corresponding interval on the other router. | |
| # If set, this value must be between 1000 and 30000. | |
| # The default is 5000. | |
| }, | |
| "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP | |
| # session. | |
| { | |
| "range": "A String", # The custom learned route IP address range. Must be a valid | |
| # CIDR-formatted prefix. If an IP address is provided without a subnet | |
| # mask, it is interpreted as, for IPv4, a `/32` singular IP address | |
| # range, and, for IPv6, `/128`. | |
| }, | |
| ], | |
| "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This | |
| # value is applied to all custom learned route ranges for the session. | |
| # You can choose a value from `0` to `65335`. If you don't provide a | |
| # value, Google Cloud assigns a priority of `100` to the ranges. | |
| "enable": "A String", # The status of the BGP peer connection. | |
| # | |
| # | |
| # If set to FALSE, any active session with the peer is terminated and | |
| # all associated routing information is removed. If set to TRUE, the | |
| # peer connection can be established with routing information. The default | |
| # is TRUE. | |
| "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if | |
| # the peerIpAddress is version 4. | |
| "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the | |
| # peerIpAddress is version 6. | |
| "exportPolicies": [ # List of export policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_EXPORT type. | |
| "A String", | |
| ], | |
| "importPolicies": [ # List of import policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_IMPORT type. | |
| "A String", | |
| ], | |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. | |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. | |
| "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. | |
| "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. | |
| "linkedCustomHardware": "A String", # The linked custom hardware resource. | |
| # The URI of the custom hardware link attachment | |
| # is where you will establish the BGP session from the Cloud Router. | |
| # This link attachment must reside in the same subnetwork as the associated | |
| # router interface. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed by you | |
| # or other users | |
| # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed | |
| # by Cloud Interconnect, specifically by an InterconnectAttachment of type | |
| # PARTNER. Google automatically creates, updates, and deletes this type of | |
| # BGP peer when the PARTNER InterconnectAttachment is created, updated, | |
| # or deleted. | |
| "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the | |
| # name of one of the entries in the Router.md5_authentication_keys. The | |
| # field must comply with RFC1035. | |
| "name": "A String", # Name of this BGP peer. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use | |
| # a different value. | |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. | |
| "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router | |
| # appliances such as Next Gen Firewalls, Virtual Routers, or Router | |
| # Appliances. The VM instance must be located in zones contained in the | |
| # same region as this Cloud Router. | |
| # The VM instance is the peer side of the BGP session. | |
| }, | |
| ], | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN | |
| # attachments (interconnectAttachments). | |
| "etag": "A String", # ETag for optimistic concurrency control as described by AIP 154. Used to | |
| # prevent conflicting updates. If provided, the request will succeed only if | |
| # the etag matches the current etag of the router; otherwise, the request | |
| # fails with an ABORTED error. | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "interfaces": [ # Router interfaces. | |
| # To create a BGP peer that uses a router interface, | |
| # the interface must have one of the following fields specified: | |
| # | |
| # - linkedVpnTunnel | |
| # - linkedInterconnectAttachment | |
| # - subnetwork | |
| # | |
| # | |
| # You can create a router interface without any of these fields specified. | |
| # However, you cannot create a BGP peer that uses that interface. | |
| { | |
| "ipRange": "A String", # IP address and range of the interface. | |
| # | |
| # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must | |
| # be a CIDR-formatted string, for example, 169.254.0.1/30. | |
| # Note: Do not truncate the IP address, as it represents the IP address of | |
| # the interface. | |
| # - For Internet Protocol version 6 (IPv6), the value | |
| # must be a unique local address (ULA) range from fdff:1::/64 | |
| # with a mask length of 126 or less. This value should be a CIDR-formatted | |
| # string, for example, fdff:1::1/112. Within the router's | |
| # VPC, this IPv6 prefix will be reserved exclusively for this connection | |
| # and cannot be used for any other purpose. | |
| "ipVersion": "A String", # IP version of this interface. | |
| "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region | |
| # as the router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the | |
| # router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed directly | |
| # by users. | |
| # - MANAGED_BY_ATTACHMENT is an interface that is configured and | |
| # managed by Cloud Interconnect, specifically, by an InterconnectAttachment | |
| # of type PARTNER. Google automatically creates, updates, and deletes | |
| # this type of interface when the PARTNER InterconnectAttachment is | |
| # created, updated, or deleted. | |
| "name": "A String", # Name of this interface entry. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "privateIpAddress": "A String", # The regional private internal IP address that is used to establish | |
| # BGP sessions to a VM instance acting as a third-party | |
| # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or | |
| # an SD-WAN VM. | |
| "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface | |
| # you are creating. The redundantInterface must belong to the same Cloud | |
| # Router as the interface here. To establish the BGP session to a Router | |
| # Appliance VM, you must create two BGP peers. The two BGP peers must be | |
| # attached to two separate interfaces that are redundant with each other. | |
| # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must | |
| # be 1-63 characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which | |
| # must be in the same region as the Cloud Router. | |
| # When you establish a BGP session to a VM instance using this interface, | |
| # the VM instance must belong to the same subnetwork as the subnetwork | |
| # specified here. | |
| }, | |
| ], | |
| "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for | |
| # routers. | |
| "md5AuthenticationKeys": [ # Keys used for MD5 authentication. | |
| { | |
| "key": "A String", # [Input only] Value of the key. | |
| # | |
| # For patch and update calls, it can be skipped to | |
| # copy the value from the previous configuration. This is allowed if the | |
| # key with the same name existed before the operation. Maximum length is 80 | |
| # characters. Can only contain printable ASCII characters. | |
| "name": "A String", # Name used to identify the key. | |
| # | |
| # Must be unique within a router. Must be referenced by exactly | |
| # one bgpPeer. Must comply withRFC1035. | |
| }, | |
| ], | |
| "name": "A String", # Name of the resource. Provided by the client when the resource is created. | |
| # The name must be 1-63 characters long, and comply withRFC1035. | |
| # Specifically, the name must be 1-63 characters long and match the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first | |
| # character must be a lowercase letter, and all following characters must | |
| # be a dash, lowercase letter, or digit, except the last character, which | |
| # cannot be a dash. | |
| "nats": [ # A list of NAT services created in this router. | |
| { # Represents a Nat resource. It enables the VMs within the specified | |
| # subnetworks to access Internet without external IP addresses. It specifies | |
| # a list of subnetworks (and the ranges within) that want to use NAT. | |
| # Customers can also provide the external IPs that would be used for NAT. GCP | |
| # would auto-allocate ephemeral IPs if no external IPs are provided. | |
| "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. | |
| # Must be one of: PREMIUM, STANDARD. | |
| # If not specified, then the current | |
| # project-level default tier is used. | |
| "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT only. | |
| "A String", | |
| ], | |
| "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT | |
| # state. This value is equal to tcp_time_wait_timeout_sec. | |
| # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or | |
| # 120s. The field is output only. | |
| "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. | |
| # | |
| # | |
| # If not specified, it is disabled by default. | |
| # | |
| # | |
| # If set to true, | |
| # | |
| # - Dynamic Port Allocation will be enabled on this NAT | |
| # config. | |
| # - enableEndpointIndependentMapping cannot be set to true. | |
| # - If minPorts is set, minPortsPerVm must be set to a | |
| # power of two greater than or equal to 32. If minPortsPerVm is not set, a | |
| # minimum of 32 ports will be allocated to a VM from this NAT | |
| # config. | |
| "enableEndpointIndependentMapping": True or False, | |
| "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list | |
| # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM | |
| "A String", | |
| ], | |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. | |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. | |
| "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, | |
| # logs are exported for all connections handled by this NAT. | |
| # This option can take one of the following values: | |
| # | |
| # - ERRORS_ONLY: Export logs only for connection failures. | |
| # - TRANSLATIONS_ONLY: Export logs only for successful | |
| # connections. | |
| # - ALL: Export logs for all connections, successful and | |
| # unsuccessful. | |
| }, | |
| "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when | |
| # Dynamic Port Allocation is enabled. | |
| # | |
| # | |
| # If Dynamic Port Allocation is not enabled, this field has no effect. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled, and this field is set, it must be | |
| # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm | |
| # is not set. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled and this field is not set, | |
| # a maximum of 65536 ports will be allocated to a VM from this NAT | |
| # config. | |
| "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not | |
| # set, a default number of ports is allocated to a VM. This is rounded | |
| # up to the nearest power of 2. For example, if the value of this field is | |
| # 50, at least 64 ports are allocated to a VM. | |
| "name": "A String", # Unique name of this Nat service. | |
| # The name must be 1-63 characters long and comply withRFC1035. | |
| "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64 | |
| # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is | |
| # selected for the SubnetworkIpRangeToNat64Option above. | |
| { # Specifies a subnetwork to enable NAT64. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT64. | |
| }, | |
| ], | |
| "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following | |
| # values: | |
| # | |
| # - MANUAL_ONLY: Uses only Nat IP addresses provided by | |
| # customers. When there are not enough specified Nat IPs, the Nat service | |
| # fails for new VMs. | |
| # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers | |
| # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should | |
| # be empty. | |
| "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| "A String", | |
| ], | |
| "rules": [ # A list of rules associated with this NAT. | |
| { | |
| "action": { # The action to be enforced for traffic that matches this rule. | |
| "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this | |
| # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT rule only. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be | |
| # drained. This is only supported on patch/update, and these | |
| # subnetworks must have previously been used as active ranges in this | |
| # NAT Rule. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| }, | |
| "description": "A String", # An optional description of this rule. | |
| "match": "A String", # CEL expression that specifies the match condition that egress traffic | |
| # from a VM is evaluated against. If it evaluates to true, the | |
| # corresponding `action` is enforced. | |
| # | |
| # The following examples are valid match expressions for public NAT: | |
| # | |
| # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, | |
| # '2.2.0.0/16')` | |
| # | |
| # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` | |
| # | |
| # The following examples are valid match expressions for private NAT: | |
| # | |
| # (NAT 44) | |
| # `nexthop.hub == | |
| # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` | |
| # | |
| # `nexthop.is_hybrid` | |
| # | |
| # (NAT 64) | |
| # `isIPv6(source.ip)` | |
| "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number | |
| # must be a positive value between 0 and 65000, and | |
| # must be unique among rules within a NAT. | |
| "sourceWorkloadIdentities": [ # A list of source workload identities. | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: | |
| # | |
| # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every | |
| # Subnetwork are allowed to Nat. | |
| # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges | |
| # in every Subnetwork are allowed to Nat. | |
| # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field subnetwork below) | |
| # | |
| # | |
| # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. | |
| # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there | |
| # should not be any other Router.Nat section in any Router for this network | |
| # in this region. | |
| "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following | |
| # values: | |
| # | |
| # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in | |
| # every Subnetwork are allowed to Nat. | |
| # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field nat64_subnetwork below) | |
| # | |
| # | |
| # The default is NAT64_OPTION_UNSPECIFIED. | |
| # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other | |
| # Router.Nat section in this region can also enable NAT64 for any | |
| # Subnetworks in this network. Other Router.Nat sections can still be | |
| # present to enable NAT44 only. | |
| "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT | |
| # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the | |
| # SubnetworkIpRangeToNatOption above. | |
| { # Defines the IP ranges that want to use NAT for a subnetwork. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT. | |
| "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to | |
| # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" | |
| # is one of the values in source_ip_ranges_to_nat. | |
| "A String", | |
| ], | |
| "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All | |
| # options of a single value are valid except | |
| # NAT_IP_RANGE_OPTION_UNSPECIFIED. | |
| # The only valid option with multiple values is: ["PRIMARY_IP_RANGE", | |
| # "LIST_OF_SECONDARY_IP_RANGES"] | |
| # Default: [ALL_IP_RANGES] | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s | |
| # if not set. | |
| "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. | |
| # Defaults to 120s if not set. | |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if | |
| # not set. | |
| "type": "A String", # Indicates whether this NAT is used for public or private IP | |
| # translation. If unspecified, it defaults to PUBLIC. | |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. | |
| }, | |
| ], | |
| "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. | |
| "network": "A String", # URI of the network to which this router belongs. | |
| "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted | |
| # as part of resource payload. | |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. | |
| # The field is allowed for INSERT | |
| # only. The keys/values to set on the resource should be specified in | |
| # either ID { : } or Namespaced format | |
| # { : }. | |
| # For example the following are valid inputs: | |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} | |
| # * {"123/environment" : "production", "345/abc" : "xyz"} | |
| # Note: | |
| # * Invalid combinations of ID & namespaced format is not supported. For | |
| # instance: {"123/environment" : "tagValues/444"} is invalid. | |
| # * Inconsistent format is not supported. For instance: | |
| # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| "region": "A String", # [Output Only] URI of the region where the router resides. | |
| # You must specify this field as part of the HTTP request URL. It is | |
| # not settable as a field in the request body. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code> | |
| <pre>Returns permissions that a caller has on the specified resource. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, The name of the region for this request. (required) | |
| resource: string, Name or id of the resource for this request. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "permissions": [ # The set of permissions to check for the 'resource'. Permissions with | |
| # wildcards (such as '*' or 'storage.*') are not allowed. | |
| "A String", | |
| ], | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is | |
| # allowed. | |
| "A String", | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="update">update(project, region, router, body=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Updates the specified Router resource with the data included in the | |
| request. This method conforms toPUT semantics, which requests that the state of the | |
| target resource be created or replaced with the state defined by the | |
| representation enclosed in the request message payload. | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource to update. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Represents a Cloud Router resource. | |
| # | |
| # For more information about Cloud Router, read theCloud | |
| # Router overview. | |
| "bgp": { # BGP information specific to this router. | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| # The options are DEFAULT or CUSTOM. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These groups will be advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # is advertised to all peers of the router. | |
| # These IP ranges will be advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "asn": 42, # Local BGP Autonomous System Number (ASN). | |
| # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The | |
| # value will be fixed for this router resource. All VPN tunnels that link | |
| # to this router will have the same local ASN. | |
| "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It | |
| # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at | |
| # least /30, even if the BGP sessions are over IPv6. It must not overlap | |
| # with any IPv4 BGP session ranges. | |
| # | |
| # | |
| # Other vendors commonly call this "router ID". | |
| "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are | |
| # sent to the peer. | |
| # | |
| # | |
| # Hold time is three times the interval at which keepalive messages are | |
| # sent, and the hold time is the maximum number of seconds allowed to | |
| # elapse between successive keepalive messages that BGP receives from a | |
| # peer. | |
| # | |
| # | |
| # BGP will use the smaller of either the local hold time value or the | |
| # peer's hold time value as the hold time for the BGP connection between | |
| # the two peers. | |
| # | |
| # | |
| # If set, this value must be between 20 and 60. The default is 20. | |
| }, | |
| "bgpPeers": [ # BGP information that must be configured into the routing stack to | |
| # establish BGP peering. This information must specify the peer ASN and | |
| # either the interface name, IP address, or peer IP address. Please refer toRFC4273. | |
| { | |
| "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. | |
| "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, | |
| # which currently supports the following option: | |
| # | |
| # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This | |
| # excludes any routes learned for subnets that use | |
| # VPC Network Peering. | |
| # | |
| # | |
| # Note that this field can only be populated if advertise_mode is CUSTOM | |
| # and overrides the list defined for the router (in the "bgp" message). | |
| # These groups are advertised in addition to any specified prefixes. | |
| # Leave this field blank to advertise no custom groups. | |
| "A String", | |
| ], | |
| "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. | |
| # This field can only be populated if advertise_mode is CUSTOM and | |
| # overrides the list defined for the router (in the "bgp" message). | |
| # These IP ranges are advertised in addition to any specified groups. | |
| # Leave this field blank to advertise no custom IP ranges. | |
| { # Description-tagged IP ranges for the router to advertise. | |
| "description": "A String", # User-specified description for the IP range. | |
| "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. | |
| }, | |
| ], | |
| "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more | |
| # than one matching route of maximum length, the routes with the lowest | |
| # priority value win. | |
| "bfd": { # BFD configuration for the BGP peering. | |
| "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # received from the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # transmit interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to the peer router. The actual value is negotiated between | |
| # the two routers and is equal to the greater of this value and the | |
| # corresponding receive interval of the other router. | |
| # | |
| # | |
| # If set, this value must be between 1000 and 30000. | |
| # | |
| # | |
| # The default is 1000. | |
| "mode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE. | |
| "multiplier": 42, # The number of consecutive BFD packets that must be missed | |
| # before BFD declares that a peer is unavailable. | |
| # | |
| # | |
| # If set, the value must be a value between 5 and 16. | |
| # | |
| # | |
| # The default is 5. | |
| "packetMode": "A String", # The BFD packet mode for this BGP peer. | |
| # If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. | |
| # In this mode, if the peer router also has BFD echo mode enabled, BFD | |
| # echo packets will be sent to the other router. If the peer router does | |
| # not have BFD echo mode enabled, only control packets will be sent. If | |
| # set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If | |
| # this router and the peer router have a multihop connection, this should | |
| # be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop | |
| # connections. The default is CONTROL_AND_ECHO. | |
| "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. | |
| # | |
| # | |
| # If set to ACTIVE, the Cloud Router will initiate the BFD session for | |
| # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the | |
| # peer router to initiate the BFD session for this BGP peer. If set to | |
| # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. | |
| "slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets | |
| # transmitted to and received from the peer router when BFD echo mode is | |
| # enabled on both routers. The actual transmit and receive intervals are | |
| # negotiated between the two routers and are equal to the greater of this | |
| # value and the corresponding interval on the other router. | |
| # If set, this value must be between 1000 and 30000. | |
| # The default is 5000. | |
| }, | |
| "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP | |
| # session. | |
| { | |
| "range": "A String", # The custom learned route IP address range. Must be a valid | |
| # CIDR-formatted prefix. If an IP address is provided without a subnet | |
| # mask, it is interpreted as, for IPv4, a `/32` singular IP address | |
| # range, and, for IPv6, `/128`. | |
| }, | |
| ], | |
| "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This | |
| # value is applied to all custom learned route ranges for the session. | |
| # You can choose a value from `0` to `65335`. If you don't provide a | |
| # value, Google Cloud assigns a priority of `100` to the ranges. | |
| "enable": "A String", # The status of the BGP peer connection. | |
| # | |
| # | |
| # If set to FALSE, any active session with the peer is terminated and | |
| # all associated routing information is removed. If set to TRUE, the | |
| # peer connection can be established with routing information. The default | |
| # is TRUE. | |
| "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if | |
| # the peerIpAddress is version 4. | |
| "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the | |
| # peerIpAddress is version 6. | |
| "exportPolicies": [ # List of export policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_EXPORT type. | |
| "A String", | |
| ], | |
| "importPolicies": [ # List of import policies applied to this peer, in the order they must be | |
| # evaluated. The name must correspond to an existing policy that has | |
| # ROUTE_POLICY_TYPE_IMPORT type. | |
| "A String", | |
| ], | |
| "interfaceName": "A String", # Name of the interface the BGP peer is associated with. | |
| "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. | |
| "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. | |
| "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. | |
| "linkedCustomHardware": "A String", # The linked custom hardware resource. | |
| # The URI of the custom hardware link attachment | |
| # is where you will establish the BGP session from the Cloud Router. | |
| # This link attachment must reside in the same subnetwork as the associated | |
| # router interface. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed by you | |
| # or other users | |
| # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed | |
| # by Cloud Interconnect, specifically by an InterconnectAttachment of type | |
| # PARTNER. Google automatically creates, updates, and deletes this type of | |
| # BGP peer when the PARTNER InterconnectAttachment is created, updated, | |
| # or deleted. | |
| "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the | |
| # name of one of the entries in the Router.md5_authentication_keys. The | |
| # field must comply with RFC1035. | |
| "name": "A String", # Name of this BGP peer. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use | |
| # a different value. | |
| "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. | |
| "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. | |
| "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router | |
| # appliances such as Next Gen Firewalls, Virtual Routers, or Router | |
| # Appliances. The VM instance must be located in zones contained in the | |
| # same region as this Cloud Router. | |
| # The VM instance is the peer side of the BGP session. | |
| }, | |
| ], | |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 | |
| # text format. | |
| "description": "A String", # An optional description of this resource. Provide this property when you | |
| # create the resource. | |
| "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN | |
| # attachments (interconnectAttachments). | |
| "etag": "A String", # ETag for optimistic concurrency control as described by AIP 154. Used to | |
| # prevent conflicting updates. If provided, the request will succeed only if | |
| # the etag matches the current etag of the router; otherwise, the request | |
| # fails with an ABORTED error. | |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is | |
| # defined by the server. | |
| "interfaces": [ # Router interfaces. | |
| # To create a BGP peer that uses a router interface, | |
| # the interface must have one of the following fields specified: | |
| # | |
| # - linkedVpnTunnel | |
| # - linkedInterconnectAttachment | |
| # - subnetwork | |
| # | |
| # | |
| # You can create a router interface without any of these fields specified. | |
| # However, you cannot create a BGP peer that uses that interface. | |
| { | |
| "ipRange": "A String", # IP address and range of the interface. | |
| # | |
| # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must | |
| # be a CIDR-formatted string, for example, 169.254.0.1/30. | |
| # Note: Do not truncate the IP address, as it represents the IP address of | |
| # the interface. | |
| # - For Internet Protocol version 6 (IPv6), the value | |
| # must be a unique local address (ULA) range from fdff:1::/64 | |
| # with a mask length of 126 or less. This value should be a CIDR-formatted | |
| # string, for example, fdff:1::1/112. Within the router's | |
| # VPC, this IPv6 prefix will be reserved exclusively for this connection | |
| # and cannot be used for any other purpose. | |
| "ipVersion": "A String", # IP version of this interface. | |
| "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region | |
| # as the router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the | |
| # router. Each interface can have one linked resource, which can be | |
| # a VPN tunnel, an Interconnect attachment, or a subnetwork. | |
| "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. | |
| # | |
| # - MANAGED_BY_USER is the default value and can be managed directly | |
| # by users. | |
| # - MANAGED_BY_ATTACHMENT is an interface that is configured and | |
| # managed by Cloud Interconnect, specifically, by an InterconnectAttachment | |
| # of type PARTNER. Google automatically creates, updates, and deletes | |
| # this type of interface when the PARTNER InterconnectAttachment is | |
| # created, updated, or deleted. | |
| "name": "A String", # Name of this interface entry. | |
| # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 | |
| # characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "privateIpAddress": "A String", # The regional private internal IP address that is used to establish | |
| # BGP sessions to a VM instance acting as a third-party | |
| # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or | |
| # an SD-WAN VM. | |
| "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface | |
| # you are creating. The redundantInterface must belong to the same Cloud | |
| # Router as the interface here. To establish the BGP session to a Router | |
| # Appliance VM, you must create two BGP peers. The two BGP peers must be | |
| # attached to two separate interfaces that are redundant with each other. | |
| # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must | |
| # be 1-63 characters long and match the regular expression | |
| # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a | |
| # lowercase letter, and all following characters must be a dash, lowercase | |
| # letter, or digit, except the last character, which cannot be a dash. | |
| "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which | |
| # must be in the same region as the Cloud Router. | |
| # When you establish a BGP session to a VM instance using this interface, | |
| # the VM instance must belong to the same subnetwork as the subnetwork | |
| # specified here. | |
| }, | |
| ], | |
| "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for | |
| # routers. | |
| "md5AuthenticationKeys": [ # Keys used for MD5 authentication. | |
| { | |
| "key": "A String", # [Input only] Value of the key. | |
| # | |
| # For patch and update calls, it can be skipped to | |
| # copy the value from the previous configuration. This is allowed if the | |
| # key with the same name existed before the operation. Maximum length is 80 | |
| # characters. Can only contain printable ASCII characters. | |
| "name": "A String", # Name used to identify the key. | |
| # | |
| # Must be unique within a router. Must be referenced by exactly | |
| # one bgpPeer. Must comply withRFC1035. | |
| }, | |
| ], | |
| "name": "A String", # Name of the resource. Provided by the client when the resource is created. | |
| # The name must be 1-63 characters long, and comply withRFC1035. | |
| # Specifically, the name must be 1-63 characters long and match the regular | |
| # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first | |
| # character must be a lowercase letter, and all following characters must | |
| # be a dash, lowercase letter, or digit, except the last character, which | |
| # cannot be a dash. | |
| "nats": [ # A list of NAT services created in this router. | |
| { # Represents a Nat resource. It enables the VMs within the specified | |
| # subnetworks to access Internet without external IP addresses. It specifies | |
| # a list of subnetworks (and the ranges within) that want to use NAT. | |
| # Customers can also provide the external IPs that would be used for NAT. GCP | |
| # would auto-allocate ephemeral IPs if no external IPs are provided. | |
| "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. | |
| # Must be one of: PREMIUM, STANDARD. | |
| # If not specified, then the current | |
| # project-level default tier is used. | |
| "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT only. | |
| "A String", | |
| ], | |
| "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT | |
| # state. This value is equal to tcp_time_wait_timeout_sec. | |
| # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or | |
| # 120s. The field is output only. | |
| "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. | |
| # | |
| # | |
| # If not specified, it is disabled by default. | |
| # | |
| # | |
| # If set to true, | |
| # | |
| # - Dynamic Port Allocation will be enabled on this NAT | |
| # config. | |
| # - enableEndpointIndependentMapping cannot be set to true. | |
| # - If minPorts is set, minPortsPerVm must be set to a | |
| # power of two greater than or equal to 32. If minPortsPerVm is not set, a | |
| # minimum of 32 ports will be allocated to a VM from this NAT | |
| # config. | |
| "enableEndpointIndependentMapping": True or False, | |
| "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list | |
| # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM | |
| "A String", | |
| ], | |
| "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. | |
| "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. | |
| "enable": True or False, # Indicates whether or not to export logs. This is false by default. | |
| "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, | |
| # logs are exported for all connections handled by this NAT. | |
| # This option can take one of the following values: | |
| # | |
| # - ERRORS_ONLY: Export logs only for connection failures. | |
| # - TRANSLATIONS_ONLY: Export logs only for successful | |
| # connections. | |
| # - ALL: Export logs for all connections, successful and | |
| # unsuccessful. | |
| }, | |
| "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when | |
| # Dynamic Port Allocation is enabled. | |
| # | |
| # | |
| # If Dynamic Port Allocation is not enabled, this field has no effect. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled, and this field is set, it must be | |
| # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm | |
| # is not set. | |
| # | |
| # | |
| # If Dynamic Port Allocation is enabled and this field is not set, | |
| # a maximum of 65536 ports will be allocated to a VM from this NAT | |
| # config. | |
| "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not | |
| # set, a default number of ports is allocated to a VM. This is rounded | |
| # up to the nearest power of 2. For example, if the value of this field is | |
| # 50, at least 64 ports are allocated to a VM. | |
| "name": "A String", # Unique name of this Nat service. | |
| # The name must be 1-63 characters long and comply withRFC1035. | |
| "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64 | |
| # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is | |
| # selected for the SubnetworkIpRangeToNat64Option above. | |
| { # Specifies a subnetwork to enable NAT64. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT64. | |
| }, | |
| ], | |
| "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following | |
| # values: | |
| # | |
| # - MANUAL_ONLY: Uses only Nat IP addresses provided by | |
| # customers. When there are not enough specified Nat IPs, the Nat service | |
| # fails for new VMs. | |
| # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers | |
| # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should | |
| # be empty. | |
| "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| "A String", | |
| ], | |
| "rules": [ # A list of rules associated with this NAT. | |
| { | |
| "action": { # The action to be enforced for traffic that matches this rule. | |
| "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP | |
| # addresses must be valid static external IP addresses assigned to the | |
| # project. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this | |
| # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs | |
| # must be valid static external IPs that have been assigned to the NAT. | |
| # These IPs should be used for updating/patching a NAT rule only. | |
| # This field is used for public NAT. | |
| "A String", | |
| ], | |
| "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be | |
| # drained. This is only supported on patch/update, and these | |
| # subnetworks must have previously been used as active ranges in this | |
| # NAT Rule. | |
| # This field is used for private NAT. | |
| "A String", | |
| ], | |
| }, | |
| "description": "A String", # An optional description of this rule. | |
| "match": "A String", # CEL expression that specifies the match condition that egress traffic | |
| # from a VM is evaluated against. If it evaluates to true, the | |
| # corresponding `action` is enforced. | |
| # | |
| # The following examples are valid match expressions for public NAT: | |
| # | |
| # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, | |
| # '2.2.0.0/16')` | |
| # | |
| # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` | |
| # | |
| # The following examples are valid match expressions for private NAT: | |
| # | |
| # (NAT 44) | |
| # `nexthop.hub == | |
| # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` | |
| # | |
| # `nexthop.is_hybrid` | |
| # | |
| # (NAT 64) | |
| # `isIPv6(source.ip)` | |
| "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number | |
| # must be a positive value between 0 and 65000, and | |
| # must be unique among rules within a NAT. | |
| "sourceWorkloadIdentities": [ # A list of source workload identities. | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: | |
| # | |
| # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every | |
| # Subnetwork are allowed to Nat. | |
| # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges | |
| # in every Subnetwork are allowed to Nat. | |
| # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field subnetwork below) | |
| # | |
| # | |
| # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. | |
| # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there | |
| # should not be any other Router.Nat section in any Router for this network | |
| # in this region. | |
| "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following | |
| # values: | |
| # | |
| # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in | |
| # every Subnetwork are allowed to Nat. | |
| # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat | |
| # (specified in the field nat64_subnetwork below) | |
| # | |
| # | |
| # The default is NAT64_OPTION_UNSPECIFIED. | |
| # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other | |
| # Router.Nat section in this region can also enable NAT64 for any | |
| # Subnetworks in this network. Other Router.Nat sections can still be | |
| # present to enable NAT44 only. | |
| "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT | |
| # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the | |
| # SubnetworkIpRangeToNatOption above. | |
| { # Defines the IP ranges that want to use NAT for a subnetwork. | |
| "name": "A String", # URL for the subnetwork resource that will use NAT. | |
| "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to | |
| # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" | |
| # is one of the values in source_ip_ranges_to_nat. | |
| "A String", | |
| ], | |
| "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All | |
| # options of a single value are valid except | |
| # NAT_IP_RANGE_OPTION_UNSPECIFIED. | |
| # The only valid option with multiple values is: ["PRIMARY_IP_RANGE", | |
| # "LIST_OF_SECONDARY_IP_RANGES"] | |
| # Default: [ALL_IP_RANGES] | |
| "A String", | |
| ], | |
| }, | |
| ], | |
| "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s | |
| # if not set. | |
| "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. | |
| # Defaults to 120s if not set. | |
| "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if | |
| # not set. | |
| "type": "A String", # Indicates whether this NAT is used for public or private IP | |
| # translation. If unspecified, it defaults to PUBLIC. | |
| "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. | |
| }, | |
| ], | |
| "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. | |
| "network": "A String", # URI of the network to which this router belongs. | |
| "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted | |
| # as part of resource payload. | |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. | |
| # The field is allowed for INSERT | |
| # only. The keys/values to set on the resource should be specified in | |
| # either ID { : } or Namespaced format | |
| # { : }. | |
| # For example the following are valid inputs: | |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} | |
| # * {"123/environment" : "production", "345/abc" : "xyz"} | |
| # Note: | |
| # * Invalid combinations of ID & namespaced format is not supported. For | |
| # instance: {"123/environment" : "tagValues/444"} is invalid. | |
| # * Inconsistent format is not supported. For instance: | |
| # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| "region": "A String", # [Output Only] URI of the region where the router resides. | |
| # You must specify this field as part of the HTTP request URL. It is | |
| # not settable as a field in the request body. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| } | |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so | |
| that if you must retry your request, the server will know to ignore the | |
| request if it has already been completed. | |
| For example, consider a situation where you make an initial request and | |
| the request times out. If you make the request again with the same | |
| request ID, the server can check if original operation with the same | |
| request ID was received, and if so, will ignore the second request. This | |
| prevents clients from accidentally creating duplicate commitments. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the | |
| # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule | |
| # methods if not explicitly provided by the user. | |
| "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query | |
| # parameters specified minPriority/maxPriority. | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error | |
| # status code that was returned. For example, a `404` means the | |
| # resource was not found. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. | |
| # There is no requirement that this be linear or support any granularity of | |
| # operations. This should not be used to guess when the operation will be | |
| # complete. This number should monotonically increase as the operation | |
| # progresses. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For | |
| # operations related to creating a snapshot, this points to the disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="updateNamedSet">updateNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Updates or creates new Named Set | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource where Named Set is defined. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "description": "A String", # An optional description of named set. | |
| "elements": [ # CEL expressions that are comparable to constructs of this set's type | |
| # (see Policy Language). | |
| { # Represents a textual expression in the Common Expression Language (CEL) | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| ], | |
| "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is | |
| # essentially a hash of the Named Set used for optimistic locking. | |
| # The fingerprint is initially generated by Compute Engine and changes | |
| # after every request to modify or update the Named Set. You must always | |
| # provide an up-to-date fingerprint hash in order to update or change | |
| # labels. | |
| # | |
| # To see the latest fingerprint, make a getNamedSet() request | |
| # to retrieve a Named Set. | |
| "name": "A String", # This set's name, which must be a resource ID segment and unique within all | |
| # named sets owned by the Router. Name should conform to RFC1035. | |
| "type": "A String", # This named set's type | |
| } | |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so | |
| that if you must retry your request, the server will know to ignore the | |
| request if it has already been completed. | |
| For example, consider a situation where you make an initial request and | |
| the request times out. If you make the request again with the same | |
| request ID, the server can check if original operation with the same | |
| request ID was received, and if so, will ignore the second request. This | |
| prevents clients from accidentally creating duplicate commitments. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the | |
| # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule | |
| # methods if not explicitly provided by the user. | |
| "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query | |
| # parameters specified minPriority/maxPriority. | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error | |
| # status code that was returned. For example, a `404` means the | |
| # resource was not found. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. | |
| # There is no requirement that this be linear or support any granularity of | |
| # operations. This should not be used to guess when the operation will be | |
| # complete. This number should monotonically increase as the operation | |
| # progresses. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For | |
| # operations related to creating a snapshot, this points to the disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="updateRoutePolicy">updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)</code> | |
| <pre>Updates or creates new Route Policy | |
| Args: | |
| project: string, Project ID for this request. (required) | |
| region: string, Name of the region for this request. (required) | |
| router: string, Name of the Router resource where Route Policy is defined. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { | |
| "description": "A String", # An optional description of route policy. | |
| "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is | |
| # essentially a hash of the Route Policy used for optimistic locking. | |
| # The fingerprint is initially generated by Compute Engine and changes | |
| # after every request to modify or update Route Policy. You must always | |
| # provide an up-to-date fingerprint hash in order to update or change | |
| # labels. | |
| # | |
| # To see the latest fingerprint, make a getRoutePolicy() request | |
| # to retrieve a Route Policy. | |
| "name": "A String", # Route Policy name, which must be a resource ID segment and unique | |
| # within all the router's Route Policies. Name should conform to RFC1035. | |
| "terms": [ # List of terms (the order in the list is not important, they are evaluated | |
| # in order of priority). Order of policies is not retained and might change | |
| # when getting policy later. | |
| { | |
| "actions": [ # CEL expressions to evaluate to modify a route when this term matches. | |
| { # Represents a textual expression in the Common Expression Language (CEL) | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| ], | |
| "match": { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term | |
| # applies. When not set, the term applies to all | |
| # routes. | |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL | |
| # are documented at https://github.com/google/cel-spec. | |
| # | |
| # Example (Comparison): | |
| # | |
| # title: "Summary size limit" | |
| # description: "Determines if a summary is less than 100 chars" | |
| # expression: "document.summary.size() < 100" | |
| # | |
| # Example (Equality): | |
| # | |
| # title: "Requestor is owner" | |
| # description: "Determines if requestor is the document owner" | |
| # expression: "document.owner == request.auth.claims.email" | |
| # | |
| # Example (Logic): | |
| # | |
| # title: "Public documents" | |
| # description: "Determine whether the document should be publicly visible" | |
| # expression: "document.type != 'private' && document.type != 'internal'" | |
| # | |
| # Example (Data Manipulation): | |
| # | |
| # title: "Notification string" | |
| # description: "Create a notification string with a timestamp." | |
| # expression: "'New message received at ' + string(document.create_time)" | |
| # | |
| # The exact variables and functions that may be referenced within an expression | |
| # are determined by the service that evaluates it. See the service | |
| # documentation for additional information. | |
| "description": "A String", # Optional. Description of the expression. This is a longer text which | |
| # describes the expression, e.g. when hovered over it in a UI. | |
| "expression": "A String", # Textual representation of an expression in Common Expression Language | |
| # syntax. | |
| "location": "A String", # Optional. String indicating the location of the expression for error | |
| # reporting, e.g. a file name and a position in the file. | |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing | |
| # its purpose. This can be used e.g. in UIs which allow to enter the | |
| # expression. | |
| }, | |
| "priority": 42, # The evaluation priority for this term, which must be between 0 | |
| # (inclusive) and 2^31 (exclusive), and unique within the list. | |
| }, | |
| ], | |
| "type": "A String", | |
| } | |
| requestId: string, An optional request ID to identify requests. Specify a unique request ID so | |
| that if you must retry your request, the server will know to ignore the | |
| request if it has already been completed. | |
| For example, consider a situation where you make an initial request and | |
| the request times out. If you make the request again with the same | |
| request ID, the server can check if original operation with the same | |
| request ID was received, and if so, will ignore the second request. This | |
| prevents clients from accidentally creating duplicate commitments. | |
| The request ID must be | |
| a valid UUID with the exception that zero UUID is not supported | |
| (00000000-0000-0000-0000-000000000000). | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents an Operation resource. | |
| # | |
| # Google Compute Engine has three Operation resources: | |
| # | |
| # * [Global](/compute/docs/reference/rest/alpha/globalOperations) | |
| # * [Regional](/compute/docs/reference/rest/alpha/regionOperations) | |
| # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) | |
| # | |
| # You can use an operation resource to manage asynchronous API requests. | |
| # For more information, readHandling | |
| # API responses. | |
| # | |
| # Operations can be global, regional or zonal. | |
| # | |
| # - For global operations, use the `globalOperations` | |
| # resource. | |
| # - For regional operations, use the | |
| # `regionOperations` resource. | |
| # - For zonal operations, use | |
| # the `zoneOperations` resource. | |
| # | |
| # | |
| # | |
| # For more information, read | |
| # Global, Regional, and Zonal Resources. | |
| # | |
| # Note that completed Operation resources have a limited | |
| # retention period. | |
| "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. | |
| # Not present otherwise. | |
| "creationTimestamp": "A String", # [Deprecated] This field is deprecated. | |
| "description": "A String", # [Output Only] A textual description of the operation, which is | |
| # set when the operation is created. | |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 | |
| # text format. | |
| "error": { # [Output Only] If errors are generated during processing of the operation, | |
| # this field will be populated. | |
| "errors": [ # [Output Only] The array of errors encountered while processing this | |
| # operation. | |
| { # Represents a single error encountered during the processing of an | |
| # operation. | |
| "code": "A String", # [Output Only] The error type identifier for this error. | |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error | |
| # details. There is a set of defined message types to use for providing | |
| # details.The syntax depends on the error code. For example, | |
| # QuotaExceededInfo will have details when the error code is | |
| # QUOTA_EXCEEDED. | |
| { # Container for structured error details providing additional context | |
| # specific to the encountered error code. | |
| "errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata. | |
| # | |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it | |
| # is not enabled: | |
| # | |
| # { "reason": "API_DISABLED" | |
| # "domain": "googleapis.com" | |
| # "metadata": { | |
| # "resource": "projects/123", | |
| # "service": "pubsub.googleapis.com" | |
| # } | |
| # } | |
| # | |
| # This response indicates that the pubsub.googleapis.com API is not enabled. | |
| # | |
| # Example of an error that is returned when attempting to create a Spanner | |
| # instance in a region that is out of stock: | |
| # | |
| # { "reason": "STOCKOUT" | |
| # "domain": "spanner.googleapis.com", | |
| # "metadata": { | |
| # "availableRegions": "us-central1,us-east2" | |
| # } | |
| # } | |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain | |
| # is typically the registered service name of the tool or product that | |
| # generates the error. Example: "pubsub.googleapis.com". If the error is | |
| # generated by some common infrastructure, the error domain must be a | |
| # globally unique value that identifies the infrastructure. For Google API | |
| # infrastructure, the error domain is "googleapis.com". | |
| "metadatas": { # Additional structured details about this error. | |
| # | |
| # Keys must match a regular expression of `a-z+` but should | |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in | |
| # length. When identifying the current value of an exceeded limit, the units | |
| # should be contained in the key, not the value. For example, rather than | |
| # `{"instanceLimit": "100/request"}`, should be returned as, | |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of | |
| # instances that can be created in a single (batch) request. | |
| "a_key": "A String", | |
| }, | |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the | |
| # proximate cause of the error. Error reasons are unique within a particular | |
| # domain of errors. This should be at most 63 characters and match a | |
| # regular expression of `A-Z+[A-Z0-9]`, which represents | |
| # UPPER_SNAKE_CASE. | |
| }, | |
| "help": { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error. | |
| # | |
| # For example, if a quota check failed with an error indicating the calling | |
| # project hasn't enabled the accessed service, this can contain a URL pointing | |
| # directly to the right place in the developer console to flip the bit. | |
| "links": [ # URL(s) pointing to additional information on handling the current error. | |
| { # Describes a URL link. | |
| "description": "A String", # Describes what the link offers. | |
| "url": "A String", # The URL of the link. | |
| }, | |
| ], | |
| }, | |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users. | |
| # which can be attached to an RPC error. | |
| "locale": "A String", # The locale used following the specification defined at | |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. | |
| # Examples are: "en-US", "fr-CH", "es-MX" | |
| "message": "A String", # The localized error message in the above locale. | |
| }, | |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded. | |
| "dimensions": { # The map holding related quota dimensions. | |
| "a_key": "A String", | |
| }, | |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota | |
| # type or metric. | |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type | |
| # or metric. | |
| "limitName": "A String", # The name of the quota limit. | |
| "metricName": "A String", # The Compute Engine quota metric name. | |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. | |
| }, | |
| }, | |
| ], | |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. | |
| # This property is optional. | |
| "message": "A String", # [Output Only] An optional, human-readable error message. | |
| }, | |
| ], | |
| }, | |
| "firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the | |
| # networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule | |
| # methods if not explicitly provided by the user. | |
| "allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query | |
| # parameters specified minPriority/maxPriority. | |
| }, | |
| "getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations. | |
| "healthInfo": { # Health information. # Output only. The health information. | |
| "availabilitySloStatus": "A String", # Output only. The availability SLO status. | |
| "healthStatus": "A String", # Output only. The health status. | |
| "repairCategory": "A String", # Output only. The repair category. | |
| "unhealthyReason": "A String", # Output only. The reason for unhealthy status. | |
| "updateTime": "A String", # Output only. The time when health info was updated. | |
| }, | |
| }, | |
| "getVersionOperationMetadata": { | |
| "inlineSbomInfo": { | |
| "currentComponentVersions": { # A mapping of components to their currently-applied versions or other | |
| # appropriate identifiers. | |
| "a_key": "A String", | |
| }, | |
| "targetComponentVersions": { # A mapping of components to their target versions or other appropriate | |
| # identifiers. | |
| "a_key": "A String", | |
| }, | |
| }, | |
| }, | |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error | |
| # message that was returned, such as `NOT FOUND`. | |
| "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error | |
| # status code that was returned. For example, a `404` means the | |
| # resource was not found. | |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is | |
| # defined by the server. | |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. | |
| # This value is inRFC3339 | |
| # text format. | |
| "instancesBulkInsertOperationMetadata": { | |
| "perLocationStatus": { # Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. | |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. | |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an | |
| # error. | |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information | |
| # if the flow is rolling forward or rolling back. | |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. | |
| }, | |
| }, | |
| }, | |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for | |
| # Operation resources. | |
| "name": "A String", # [Output Only] Name of the operation. | |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a | |
| # group of operations results from a `bulkInsert` API request. | |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, | |
| # `update`, or `delete`, and so on. | |
| "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. | |
| # There is no requirement that this be linear or support any granularity of | |
| # operations. This should not be used to guess when the operation will be | |
| # complete. This number should monotonically increase as the operation | |
| # progresses. | |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only | |
| # applicable when performing regional operations. | |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. | |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. | |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, | |
| # this field will contain information on all underlying zonal actions and | |
| # their state. | |
| "clientOperationId": "A String", # [Output Only] The client operation id. | |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). | |
| # Example key: zones/us-central1-a | |
| "a_key": { | |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is | |
| # populated. | |
| # different programming environments, including REST APIs and RPC APIs. It is | |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains | |
| # three pieces of data: error code, error message, and error details. | |
| # | |
| # You can find out more about this error model and how to work with it in the | |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of | |
| # message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any | |
| # user-facing error message should be localized and sent in the | |
| # google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: | |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. | |
| }, | |
| }, | |
| }, | |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. | |
| # This value is inRFC3339 | |
| # text format. | |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the | |
| # following: | |
| # `PENDING`, `RUNNING`, or `DONE`. | |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the | |
| # operation. | |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation | |
| # of the target resource. | |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For | |
| # operations related to creating a snapshot, this points to the disk | |
| # that the snapshot was created from. | |
| "user": "A String", # [Output Only] User who requested the operation, for example: | |
| # `user@example.com` or | |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the | |
| # operation, this field will be populated. | |
| { | |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute | |
| # Engine returns NO_RESULTS_ON_PAGE if there | |
| # are no results in the response. | |
| "data": [ # [Output Only] Metadata about this warning in key: | |
| # value format. For example: | |
| # | |
| # "data": [ | |
| # { | |
| # "key": "scope", | |
| # "value": "zones/us-east1-d" | |
| # }] | |
| { | |
| "key": "A String", # [Output Only] A key that provides more detail on the warning being | |
| # returned. For example, for warnings where there are no results in a list | |
| # request for a particular zone, this key might be scope and | |
| # the key value might be the zone name. Other examples might be a key | |
| # indicating a deprecated resource and a suggested replacement, or a | |
| # warning about invalid network settings (for example, if an instance | |
| # attempts to perform IP forwarding but is not enabled for IP forwarding). | |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. | |
| }, | |
| ], | |
| "message": "A String", # [Output Only] A human-readable description of the warning code. | |
| }, | |
| ], | |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only | |
| # applicable when performing per-zone operations. | |
| }</pre> | |
| </div> | |
| </body></html> |