Network Services API (networkservices:v1)

2024-02-16

18 new methods

Additions

    Methods
  • networkservices.projects.locations.lbTrafficExtensions.list

      Path : v1/{+parent}/lbTrafficExtensions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project}/locations/{location}`.

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

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A token identifying a page of results that the server returns.

          Location : query

          Type : string

        filter

          Description : Optional. Filtering results.

          Location : query

          Type : string

        orderBy

          Description : Optional. Hint for how to order the results.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Lists `LbTrafficExtension` resources in a given project and location.

  • networkservices.projects.locations.lbTrafficExtensions.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions/{lbTrafficExtensionsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets details of the specified `LbTrafficExtension` resource.

  • networkservices.projects.locations.lbTrafficExtensions.create

      Path : v1/{+parent}/lbTrafficExtensions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project}/locations/{location}`.

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

          Location : path

          Required : Yes

          Type : string

        lbTrafficExtensionId

          Description : Required. User-provided ID of the `LbTrafficExtension` resource to be created.

          Location : query

          Type : string

        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 can ignore the request if it has already been completed. The server guarantees 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, ignores 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

      Parameter Order : parent

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

      Description : Creates a new `LbTrafficExtension` resource in a given project and location.

  • networkservices.projects.locations.lbTrafficExtensions.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions/{lbTrafficExtensionsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.

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

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Required. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.

          Location : query

          Type : string

          Format : google-fieldmask

        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 can ignore the request if it has already been completed. The server guarantees 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, ignores 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

      Parameter Order : name

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

      Description : Updates the parameters of the specified `LbTrafficExtension` resource.

  • networkservices.projects.locations.lbTrafficExtensions.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions/{lbTrafficExtensionsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.

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

          Location : path

          Required : Yes

          Type : string

        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 can ignore the request if it has already been completed. The server guarantees 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, ignores 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

      Parameter Order : name

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

      Description : Deletes the specified `LbTrafficExtension` resource.

  • networkservices.projects.locations.lbRouteExtensions.list

      Path : v1/{+parent}/lbRouteExtensions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project}/locations/{location}`.

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

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A token identifying a page of results that the server returns.

          Location : query

          Type : string

        filter

          Description : Optional. Filtering results.

          Location : query

          Type : string

        orderBy

          Description : Optional. Hint for how to order the results.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Lists `LbRouteExtension` resources in a given project and location.

  • networkservices.projects.locations.lbRouteExtensions.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions/{lbRouteExtensionsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets details of the specified `LbRouteExtension` resource.

  • networkservices.projects.locations.lbRouteExtensions.create

      Path : v1/{+parent}/lbRouteExtensions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project}/locations/{location}`.

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

          Location : path

          Required : Yes

          Type : string

        lbRouteExtensionId

          Description : Required. User-provided ID of the `LbRouteExtension` resource to be created.

          Location : query

          Type : string

        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 can ignore the request if it has already been completed. The server guarantees 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, ignores 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

      Parameter Order : parent

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

      Description : Creates a new `LbRouteExtension` resource in a given project and location.

  • networkservices.projects.locations.lbRouteExtensions.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions/{lbRouteExtensionsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.

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

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Required. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.

          Location : query

          Type : string

          Format : google-fieldmask

        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 can ignore the request if it has already been completed. The server guarantees 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, ignores 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

      Parameter Order : name

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

      Description : Updates the parameters of the specified `LbRouteExtension` resource.

  • networkservices.projects.locations.lbRouteExtensions.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions/{lbRouteExtensionsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.

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

          Location : path

          Required : Yes

          Type : string

        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 can ignore the request if it has already been completed. The server guarantees 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, ignores 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

      Parameter Order : name

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

      Description : Deletes the specified `LbRouteExtension` resource.

  • networkservices.projects.locations.serviceLbPolicies.list

      Path : v1/{+parent}/serviceLbPolicies

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The project and location from which the ServiceLbPolicies should be listed, specified in the format `projects/{project}/locations/{location}`.

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

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Maximum number of ServiceLbPolicies to return per call.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The value returned by the last `ListServiceLbPoliciesResponse` Indicates that this is a continuation of a prior `ListRouters` call, and that the system should return the next page of data.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Lists ServiceLbPolicies in a given project and location.

  • networkservices.projects.locations.serviceLbPolicies.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. A name of the ServiceLbPolicy to get. Must be in the format `projects/{project}/locations/{location}/serviceLbPolicies/*`.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets details of a single ServiceLbPolicy.

  • networkservices.projects.locations.serviceLbPolicies.create

      Path : v1/{+parent}/serviceLbPolicies

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The parent resource of the ServiceLbPolicy. Must be in the format `projects/{project}/locations/{location}`.

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

          Location : path

          Required : Yes

          Type : string

        serviceLbPolicyId

          Description : Required. Short name of the ServiceLbPolicy resource to be created. E.g. for resource name `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. the id is value of {service_lb_policy_name}

          Location : query

          Type : string

      Parameter Order : parent

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

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

  • networkservices.projects.locations.serviceLbPolicies.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Required. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.

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

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. Field mask is used to specify the fields to be overwritten in the ServiceLbPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Updates the parameters of a single ServiceLbPolicy.

  • networkservices.projects.locations.serviceLbPolicies.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. A name of the ServiceLbPolicy to delete. Must be in the format `projects/{project}/locations/{location}/serviceLbPolicies/*`.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Deletes a single ServiceLbPolicy.

  • networkservices.projects.locations.serviceLbPolicies.setIamPolicy

      Path : v1/{+resource}:setIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:setIamPolicy

      HTTP Method : POST

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

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

      Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • networkservices.projects.locations.serviceLbPolicies.getIamPolicy

      Path : v1/{+resource}:getIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:getIamPolicy

      HTTP Method : GET

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location : path

          Required : Yes

          Type : string

        options.requestedPolicyVersion

          Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Location : query

          Type : integer

          Format : int32

      Parameter Order : resource

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

      Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • networkservices.projects.locations.serviceLbPolicies.testIamPermissions

      Path : v1/{+resource}:testIamPermissions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:testIamPermissions

      HTTP Method : POST

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

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

      Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.