# Compute Engine API . routes

## Instance Methods

Deletes the specified Route resource.

Returns the specified Route resource. Get a list of available routes by making a list() request.

Creates a Route resource in the specified project using the data included in the request.

Retrieves the list of Route resources available to the specified project.

Retrieves the next page of results.

Returns permissions that a caller has on the specified resource.

### Method Details

`delete(project, route)`

    Deletes the specified Route resource.

    Args:
      project: string, Project ID for this request. (required)
      route: string, Name of the Route resource to delete. (required)

    Returns:
      An object of the form:

        { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "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.
        "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.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "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" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "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).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "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.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the 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 persistent disk that the snapshot was created from.
      }

`get(project, route)`

    Returns the specified Route resource. Get a list of available routes by making a list() request.

    Args:
      project: string, Project ID for this request. (required)
      route: string, Name of the Route resource to return. (required)

    Returns:
      An object of the form:

        { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
          #
          # For each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
          #
          # Packets that do not match any route in the sending instance's routing table are dropped.
        "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//global/gateways/default-internet-gateway
        "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
        "kind": "compute#route", # [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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        "tags": [ # A list of instance tags to which this route applies.
          "A String",
        ],
        "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/
        "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 the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
        "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
        "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
        "network": "A String", # Fully-qualified URL of the network that this route applies to.
        "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "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" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "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).
              },
            ],
          },
        ],
        "destRange": "A String", # The destination range of outgoing packets that this route applies to.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
      }

`insert(project, body)`

    Creates a Route resource in the specified project using the data included in the request.

    Args:
      project: string, Project ID for this request. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
        #
        # For each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
        #
        # Packets that do not match any route in the sending instance's routing table are dropped.
      "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//global/gateways/default-internet-gateway
      "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
      "kind": "compute#route", # [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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
      "tags": [ # A list of instance tags to which this route applies.
        "A String",
      ],
      "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/
      "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 the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
      "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
      "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
      "network": "A String", # Fully-qualified URL of the network that this route applies to.
      "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
      "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
        {
          "message": "A String", # [Output Only] A human-readable description of the warning code.
          "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" }
            {
              "value": "A String", # [Output Only] A warning data value corresponding to the key.
              "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).
            },
          ],
        },
      ],
      "destRange": "A String", # The destination range of outgoing packets that this route applies to.
      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
      "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
    }

    Returns:
      An object of the form:

        { # An Operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
        "clientOperationId": "A String", # [Output Only] Reserved for future use.
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
        "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.
        "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.
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
          {
            "message": "A String", # [Output Only] A human-readable description of the warning code.
            "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" }
              {
                "value": "A String", # [Output Only] A warning data value corresponding to the key.
                "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).
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
        "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.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined URL for the 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 persistent disk that the snapshot was created from.
      }

`list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)`

    Retrieves the list of Route resources available to the specified project.

    Args:
      project: string, Project ID for this request. (required)
      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.
      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.
      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.
      filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

    The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

    For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.

    You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

    To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

    Returns:
      An object of the form:

        { # Contains a list of Route resources.
        "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
        "items": [ # [Output Only] A list of Route resources.
          { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
              #
              # For each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
              #
              # Packets that do not match any route in the sending instance's routing table are dropped.
            "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//global/gateways/default-internet-gateway
            "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
            "kind": "compute#route", # [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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
            "tags": [ # A list of instance tags to which this route applies.
              "A String",
            ],
            "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/
            "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 the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
            "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
            "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
            "network": "A String", # Fully-qualified URL of the network that this route applies to.
            "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
            "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
              {
                "message": "A String", # [Output Only] A human-readable description of the warning code.
                "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" }
                  {
                    "value": "A String", # [Output Only] A warning data value corresponding to the key.
                    "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).
                  },
                ],
              },
            ],
            "destRange": "A String", # The destination range of outgoing packets that this route applies to.
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
            "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
          },
        ],
        "kind": "compute#routeList", # Type of resource.
        "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
      }

`list_next(previous_request, previous_response)`

    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.

`testIamPermissions(project, resource, body)`

    Returns permissions that a caller has on the specified resource.

    Args:
      project: string, Project ID for this request. (required)
      resource: string, Name of the resource for this request. (required)
      body: object, The request body. (required)
        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",
        ],
      }

    Returns:
      An object of the form:

        {
        "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
          "A String",
        ],
      }