Network Connectivity API (networkconnectivity:v1)

2023-06-26

7 new methods | 4 updated methods

Additions

    Methods
  • networkconnectivity.projects.locations.spokes.accept

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+name}:accept

      Parameters:

        name

          Required: Yes

          Type: string

          Location: path

          Description: Required. The name of the spoke to accept.

          Pattern: ^projects/[^/]+/locations/[^/]+/spokes/[^/]+$

      Parameter Order: name

      Description: Accepts a proposal to attach a Network Connectivity Center spoke to the hub.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:accept

  • networkconnectivity.projects.locations.spokes.reject

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:reject

      Path: v1/{+name}:reject

      Description: Does one of the following: * Rejects a proposal to attach a Network Connectivity Center spoke to the hub. * Rejects and removes a previously attached spoke from the hub.

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/spokes/[^/]+$

          Required: Yes

          Description: Required. The name of the spoke to reject.

          Location: path

          Type: string

      Parameter Order: name

  • networkconnectivity.projects.locations.global.hubs.routeTables.routes.list

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+parent}/routes

      Description: Lists routes in a given project.

      HTTP Method: GET

      Parameters:

        pageSize

          Type: integer

          Format: int32

          Location: query

          Description: The maximum number of results to return per page.

        pageToken

          Description: The page token.

          Type: string

          Location: query

        filter

          Location: query

          Type: string

          Description: An expression that filters the list of results.

        orderBy

          Location: query

          Type: string

          Description: Sort the results by a certain order.

        parent

          Location: path

          Required: Yes

          Type: string

          Description: Required. The parent resource's name.

          Pattern: ^projects/[^/]+/locations/global/hubs/[^/]+/routeTables/[^/]+$

      Flat Path: v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables/{routeTablesId}/routes

      Parameter Order: parent

  • networkconnectivity.projects.locations.global.hubs.routeTables.routes.get

      Description: Gets details about the specified route.

      Parameters:

        name

          Required: Yes

          Type: string

          Pattern: ^projects/[^/]+/locations/global/hubs/[^/]+/routeTables/[^/]+/routes/[^/]+$

          Location: path

          Description: Required. The name of the route resource.

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables/{routeTablesId}/routes/{routesId}

      Path: v1/{+name}

      Parameter Order: name

  • networkconnectivity.projects.locations.global.hubs.routeTables.list

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables

      Description: Lists route tables in a given project.

      HTTP Method: GET

      Path: v1/{+parent}/routeTables

      Parameters:

        orderBy

          Location: query

          Type: string

          Description: Sort the results by a certain order.

        parent

          Type: string

          Pattern: ^projects/[^/]+/locations/global/hubs/[^/]+$

          Required: Yes

          Description: Required. The parent resource's name.

          Location: path

        filter

          Location: query

          Description: An expression that filters the list of results.

          Type: string

        pageSize

          Type: integer

          Description: The maximum number of results to return per page.

          Location: query

          Format: int32

        pageToken

          Description: The page token.

          Location: query

          Type: string

  • networkconnectivity.projects.locations.global.hubs.routeTables.get

      Description: Gets details about a Network Connectivity Center route table.

      Parameters:

        name

          Type: string

          Description: Required. The name of the route table resource.

          Location: path

          Pattern: ^projects/[^/]+/locations/global/hubs/[^/]+/routeTables/[^/]+$

          Required: Yes

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      HTTP Method: GET

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/global/hubs/{hubsId}/routeTables/{routeTablesId}

  • networkconnectivity.projects.locations.global.hubs.listSpokes

      Path: v1/{+name}:listSpokes

      HTTP Method: GET

      Description: Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted.

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/global/hubs/{hubsId}:listSpokes

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        spokeLocations

          Description: A list of locations. Specify one of the following: `[global]`, a single region (for example, `[us-central1]`), or a combination of values (for example, `[global, us-central1, us-west1]`). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.

          Repeated: Yes

          Location: query

          Type: string

        orderBy

          Location: query

          Description: Sort the results by name or create_time.

          Type: string

        filter

          Description: An expression that filters the list of results.

          Type: string

          Location: query

        pageToken

          Location: query

          Description: The page token.

          Type: string

        view

          Enum Descriptions:

        • The spoke view is unspecified. When the spoke view is unspecified, the API returns the same fields as the `BASIC` view.
        • Includes `name`, `create_time`, `hub`, `unique_id`, `state`, `reasons`, and `spoke_type`. This is the default value.
        • Includes all spoke fields except `labels`. You can use the `DETAILED` view only when you set the `spoke_locations` field to `[global]`.
        • Enum:

        • SPOKE_VIEW_UNSPECIFIED
        • BASIC
        • DETAILED
        • Description: The view of the spoke to return. The view you use determines which spoke fields are included in the response.

          Location: query

          Type: string

        name

          Required: Yes

          Pattern: ^projects/[^/]+/locations/global/hubs/[^/]+$

          Description: Required. The name of the hub.

          Location: path

          Type: string

        pageSize

          Description: The maximum number of results to return per page.

          Type: integer

          Location: query

          Format: int32

Updates

    Methods
  • networkconnectivity.projects.locations.serviceConnectionPolicies.delete

      Parameters:

        etag

          Description: Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

          Type: string

          Location: query

  • networkconnectivity.projects.locations.serviceConnectionMaps.delete

      Parameters:

        etag

          Type: string

          Location: query

          Description: Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

  • networkconnectivity.projects.locations.serviceClasses.delete

      Parameters:

        etag

          Type: string

          Description: Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

          Location: query

  • networkconnectivity.projects.locations.serviceConnectionTokens.delete

      Parameters:

        etag

          Description: Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

          Type: string

          Location: query