Network Connectivity API . projects . locations . global_ . hubs . routeTables . routes

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets details about the specified route.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists routes in a given route table.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets details about the specified route.

Args:
  name: string, Required. The name of the route resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.
  "createTime": "A String", # Output only. The time the route was created.
  "description": "A String", # An optional description of the route.
  "ipCidrRange": "A String", # The destination IP address range.
  "labels": { # Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
    "a_key": "A String",
  },
  "location": "A String", # Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
  "name": "A String", # Immutable. The name of the route. Route names must be unique. Route names use the following form: `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}`
  "nextHopInterconnectAttachment": { # A route next hop that leads to an interconnect attachment resource. # Immutable. The next-hop VLAN attachment for packets on this route.
    "siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this interconnect attachment resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
    "uri": "A String", # The URI of the interconnect attachment resource.
    "vpcNetwork": "A String", # The VPC network where this interconnect attachment is located.
  },
  "nextHopRouterApplianceInstance": { # A route next hop that leads to a Router appliance instance. # Immutable. The next-hop Router appliance instance for packets on this route.
    "siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this Router appliance instance resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
    "uri": "A String", # The URI of the Router appliance instance.
    "vpcNetwork": "A String", # The VPC network where this VM is located.
  },
  "nextHopVpcNetwork": { # Immutable. The destination VPC network for packets on this route.
    "uri": "A String", # The URI of the VPC network resource
  },
  "nextHopVpnTunnel": { # A route next hop that leads to a VPN tunnel resource. # Immutable. The next-hop VPN tunnel for packets on this route.
    "siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this VPN tunnel resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
    "uri": "A String", # The URI of the VPN tunnel resource.
    "vpcNetwork": "A String", # The VPC network where this VPN tunnel is located.
  },
  "priority": "A String", # Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.
  "spoke": "A String", # Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE
  "state": "A String", # Output only. The current lifecycle state of the route.
  "type": "A String", # Output only. The route's type. Its type is determined by the properties of its IP address range.
  "uid": "A String", # Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different `uid`.
  "updateTime": "A String", # Output only. The time the route was last updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists routes in a given route table.

Args:
  parent: string, Required. The parent resource's name. (required)
  filter: string, An expression that filters the list of results.
  orderBy: string, Sort the results by a certain order.
  pageSize: integer, The maximum number of results to return per page.
  pageToken: string, The page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for HubService.ListRoutes method.
  "nextPageToken": "A String", # The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results.
  "routes": [ # The requested routes.
    { # A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.
      "createTime": "A String", # Output only. The time the route was created.
      "description": "A String", # An optional description of the route.
      "ipCidrRange": "A String", # The destination IP address range.
      "labels": { # Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
        "a_key": "A String",
      },
      "location": "A String", # Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
      "name": "A String", # Immutable. The name of the route. Route names must be unique. Route names use the following form: `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}`
      "nextHopInterconnectAttachment": { # A route next hop that leads to an interconnect attachment resource. # Immutable. The next-hop VLAN attachment for packets on this route.
        "siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this interconnect attachment resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
        "uri": "A String", # The URI of the interconnect attachment resource.
        "vpcNetwork": "A String", # The VPC network where this interconnect attachment is located.
      },
      "nextHopRouterApplianceInstance": { # A route next hop that leads to a Router appliance instance. # Immutable. The next-hop Router appliance instance for packets on this route.
        "siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this Router appliance instance resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
        "uri": "A String", # The URI of the Router appliance instance.
        "vpcNetwork": "A String", # The VPC network where this VM is located.
      },
      "nextHopVpcNetwork": { # Immutable. The destination VPC network for packets on this route.
        "uri": "A String", # The URI of the VPC network resource
      },
      "nextHopVpnTunnel": { # A route next hop that leads to a VPN tunnel resource. # Immutable. The next-hop VPN tunnel for packets on this route.
        "siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this VPN tunnel resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
        "uri": "A String", # The URI of the VPN tunnel resource.
        "vpcNetwork": "A String", # The VPC network where this VPN tunnel is located.
      },
      "priority": "A String", # Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.
      "spoke": "A String", # Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE
      "state": "A String", # Output only. The current lifecycle state of the route.
      "type": "A String", # Output only. The route's type. Its type is determined by the properties of its IP address range.
      "uid": "A String", # Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different `uid`.
      "updateTime": "A String", # Output only. The time the route was last updated.
    },
  ],
  "unreachable": [ # RouteTables that could not be reached.
    "A String",
  ],
}
list_next()
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.