Network Connectivity API (networkconnectivity:v1)

2023-08-17

4 new methods

Additions

    Methods
  • networkconnectivity.projects.locations.global.policyBasedRoutes.delete

      Description: Deletes a single PolicyBasedRoute.

      Flat Path: v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}

      Parameters:

        name

          Type: string

          Description: Required. Name of the PolicyBasedRoute resource to delete.

          Location: path

          Required: Yes

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

        requestId

          Type: string

          Description: Optional. 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. The server will guarantee that for at least 60 minutes after the first request. 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).

          Location: query

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

      Path: v1/{+name}

      Parameter Order: name

      HTTP Method: DELETE

  • networkconnectivity.projects.locations.global.policyBasedRoutes.list

      Flat Path: v1/projects/{projectsId}/locations/global/policyBasedRoutes

      HTTP Method: GET

      Path: v1/{+parent}/policyBasedRoutes

      Description: Lists PolicyBasedRoutes in a given project and location.

      Parameter Order: parent

      Parameters:

        filter

          Description: A filter expression that filters the results listed in the response.

          Type: string

          Location: query

        pageToken

          Location: query

          Description: The page token.

          Type: string

        orderBy

          Location: query

          Description: Sort the results by a certain order.

          Type: string

        pageSize

          Description: The maximum number of results per page that should be returned.

          Format: int32

          Type: integer

          Location: query

        parent

          Description: Required. The parent resource's name.

          Location: path

          Required: Yes

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

          Type: string

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

  • networkconnectivity.projects.locations.global.policyBasedRoutes.get

      HTTP Method: GET

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

      Description: Gets details of a single PolicyBasedRoute.

      Parameters:

        name

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

          Required: Yes

          Description: Required. Name of the PolicyBasedRoute resource to get.

          Type: string

          Location: path

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}

      Parameter Order: name

  • networkconnectivity.projects.locations.global.policyBasedRoutes.create

      HTTP Method: POST

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

      Parameter Order: parent

      Parameters:

        requestId

          Description: Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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).

          Location: query

          Type: string

        policyBasedRouteId

          Description: Required. Unique id for the Policy Based Route to create.

          Type: string

          Location: query

        parent

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

          Description: Required. The parent resource's name of the PolicyBasedRoute.

          Location: path

          Required: Yes

          Type: string

      Description: Creates a new PolicyBasedRoute in a given project and location.

      Path: v1/{+parent}/policyBasedRoutes

      Flat Path: v1/projects/{projectsId}/locations/global/policyBasedRoutes