Network Connectivity API (networkconnectivity:v1)

2022-10-25

14 new methods

Additions

    Methods
  • networkconnectivity.projects.locations.serviceClasses.getIamPolicy

      Parameter Order : resource

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceClasses/{serviceClassesId}:getIamPolicy

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

      Path : v1/{+resource}:getIamPolicy

      HTTP Method : GET

      Parameters :

        options.requestedPolicyVersion

          Format : int32

          Location : query

          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).

          Type : integer

        resource

          Type : string

          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/[^/]+/serviceClasses/[^/]+$

          Location : path

          Required : Yes

  • networkconnectivity.projects.locations.serviceClasses.testIamPermissions

      Parameters :

        resource

          Type : string

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

          Location : path

          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.

          Required : Yes

      Parameter Order : resource

      Path : v1/{+resource}:testIamPermissions

      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.

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceClasses/{serviceClassesId}:testIamPermissions

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

  • networkconnectivity.projects.locations.serviceClasses.setIamPolicy

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceClasses/{serviceClassesId}:setIamPolicy

      Parameter Order : resource

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

      HTTP Method : POST

      Parameters :

        resource

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

          Location : path

          Type : string

          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.

          Required : Yes

      Path : v1/{+resource}:setIamPolicy

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

  • networkconnectivity.projects.locations.serviceConnectionMaps.testIamPermissions

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps/{serviceConnectionMapsId}:testIamPermissions

      Path : v1/{+resource}:testIamPermissions

      Parameters :

        resource

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

          Type : string

          Required : Yes

          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.

          Location : path

      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.

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

      HTTP Method : POST

      Parameter Order : resource

  • networkconnectivity.projects.locations.serviceConnectionMaps.getIamPolicy

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

      Path : v1/{+resource}:getIamPolicy

      Parameter Order : resource

      Parameters :

        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).

          Type : integer

          Location : query

          Format : int32

        resource

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

          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.

          Type : string

          Location : path

          Required : Yes

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps/{serviceConnectionMapsId}:getIamPolicy

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

  • networkconnectivity.projects.locations.serviceConnectionMaps.setIamPolicy

      Path : v1/{+resource}:setIamPolicy

      Parameters :

        resource

          Location : path

          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.

          Type : string

          Required : Yes

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

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionMaps/{serviceConnectionMapsId}:setIamPolicy

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

      Parameter Order : resource

      HTTP Method : POST

  • networkconnectivity.projects.locations.internalRanges.create

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

      Parameter Order : parent

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

      Parameters :

        requestId

          Type : string

          Location : query

          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 t he 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).

        parent

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

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

          Location : path

          Type : string

          Required : Yes

        internalRangeId

          Type : string

          Description : Optional. Resource ID (i.e. 'foo' in '[...]/projects/p/locations/l/internalRanges/foo') See https://google.aip.dev/122#resource-id-segments Unique per location.

          Location : query

      HTTP Method : POST

      Path : v1/{+parent}/internalRanges

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

  • networkconnectivity.projects.locations.internalRanges.delete

      Path : v1/{+name}

      Parameter Order : name

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

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the InternalRange to delete.

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

          Location : path

          Type : string

          Required : Yes

        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 after the first request. For example, consider a situation where you make an initial request and t he 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

      Description : Deletes a single InternalRange.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}

  • networkconnectivity.projects.locations.internalRanges.patch

      HTTP Method : PATCH

      Parameter Order : name

      Parameters :

        name

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

          Type : string

          Description : Immutable. The name of a InternalRange. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names

          Required : Yes

          Location : path

        requestId

          Type : string

          Location : query

          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 t he 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).

        updateMask

          Location : query

          Type : string

          Format : google-fieldmask

          Description : Optional. Field mask is used to specify the fields to be overwritten in the InternalRange 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.

      Description : Updates the parameters of a single InternalRange.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}

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

      Path : v1/{+name}

  • networkconnectivity.projects.locations.internalRanges.list

      Parameter Order : parent

      HTTP Method : GET

      Path : v1/{+parent}/internalRanges

      Parameters :

        parent

          Required : Yes

          Type : string

          Description : Required. The parent resource's name.

          Location : path

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

        orderBy

          Location : query

          Type : string

          Description : Sort the results by a certain order.

        pageSize

          Format : int32

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

          Type : integer

          Location : query

        pageToken

          Type : string

          Location : query

          Description : The page token.

        filter

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

          Type : string

          Location : query

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

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

      Description : Lists InternalRanges in a given project and location.

  • networkconnectivity.projects.locations.internalRanges.get

      Parameter Order : name

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

      Description : Gets details of a single InternalRange.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}

      HTTP Method : GET

      Parameters :

        name

          Location : path

          Required : Yes

          Type : string

          Description : Required. Name of the InternalRange to get.

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

      Path : v1/{+name}

  • networkconnectivity.projects.locations.serviceConnectionPolicies.testIamPermissions

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies/{serviceConnectionPoliciesId}:testIamPermissions

      Parameter Order : resource

      Parameters :

        resource

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

          Required : Yes

          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.

          Type : string

          Location : path

      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.

      Path : v1/{+resource}:testIamPermissions

  • networkconnectivity.projects.locations.serviceConnectionPolicies.getIamPolicy

      HTTP Method : GET

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

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies/{serviceConnectionPoliciesId}:getIamPolicy

      Path : v1/{+resource}:getIamPolicy

      Parameters :

        options.requestedPolicyVersion

          Type : integer

          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).

          Format : int32

          Location : query

        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.

          Required : Yes

          Location : path

          Type : string

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

      Parameter Order : resource

  • networkconnectivity.projects.locations.serviceConnectionPolicies.setIamPolicy

      Path : v1/{+resource}:setIamPolicy

      Parameters :

        resource

          Required : Yes

          Location : path

          Type : string

          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/[^/]+/serviceConnectionPolicies/[^/]+$

      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.

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/serviceConnectionPolicies/{serviceConnectionPoliciesId}:setIamPolicy

      Parameter Order : resource