Network Connectivity API: projects. The Network Connectivity API provides access to Network Connectivity Center. See: https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects
Network Connectivity API: projects. The Network Connectivity API provides access to Network Connectivity Center. See: https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects
(locations-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets information about a location.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/get Required parameters: name Optional parameters: none Gets information about a location.
(locations-global-hubs-create$ auth parameters body)
Required parameters: parent
Optional parameters: hubId, requestId
Body:
{:uniqueId string, :createTime string, :name string, :state string, :description string, :labels {}, :spokes [string], :updateTime string}
Creates a new Hub in a given project and location.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/global/hubs/create Required parameters: parent Optional parameters: hubId, requestId Body: {:uniqueId string, :createTime string, :name string, :state string, :description string, :labels {}, :spokes [string], :updateTime string} Creates a new Hub in a given project and location.
(locations-global-hubs-delete$ auth parameters)
Required parameters: name
Optional parameters: requestId
Deletes a single Hub.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/global/hubs/delete Required parameters: name Optional parameters: requestId Deletes a single Hub.
(locations-global-hubs-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets details of a single Hub.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/global/hubs/get Required parameters: name Optional parameters: none Gets details of a single Hub.
(locations-global-hubs-getIamPolicy$ auth parameters)
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/global/hubs/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-global-hubs-list$ auth parameters)
Required parameters: parent
Optional parameters: orderBy, pageSize, filter, pageToken
Lists Hubs in a given project and location.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/global/hubs/list Required parameters: parent Optional parameters: orderBy, pageSize, filter, pageToken Lists Hubs in a given project and location.
(locations-global-hubs-patch$ auth parameters body)
Required parameters: name
Optional parameters: requestId, updateMask
Body:
{:uniqueId string, :createTime string, :name string, :state string, :description string, :labels {}, :spokes [string], :updateTime string}
Updates the parameters of a single Hub.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/global/hubs/patch Required parameters: name Optional parameters: requestId, updateMask Body: {:uniqueId string, :createTime string, :name string, :state string, :description string, :labels {}, :spokes [string], :updateTime string} Updates the parameters of a single Hub.
(locations-global-hubs-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/global/hubs/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(locations-global-hubs-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/global/hubs/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
(locations-internalRanges-getIamPolicy$ auth parameters)
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/internalRanges/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-internalRanges-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/internalRanges/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(locations-internalRanges-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/internalRanges/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
(locations-list$ auth parameters)
Required parameters: name
Optional parameters: pageToken, pageSize, filter
Lists information about the supported locations for this service.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/list Required parameters: name Optional parameters: pageToken, pageSize, filter Lists information about the supported locations for this service.
(locations-operations-cancel$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{}
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/operations/cancel Required parameters: name Optional parameters: none Body: {} Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
(locations-operations-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/operations/delete Required parameters: name Optional parameters: none Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
(locations-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/operations/get Required parameters: name Optional parameters: none Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
(locations-operations-list$ auth parameters)
Required parameters: name
Optional parameters: pageSize, pageToken, filter
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/operations/list Required parameters: name Optional parameters: pageSize, pageToken, filter Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
(locations-spokes-create$ auth parameters body)
Required parameters: parent
Optional parameters: spokeId, requestId
Body:
{:description string, :linkedInterconnectAttachments [string], :labels {}, :hub string, :name string, :linkedRouterApplianceInstances [{:networkInterface string, :ipAddress string, :virtualMachine string}], :createTime string, :linkedVpnTunnels [string], :state string, :updateTime string, :uniqueId string}
Creates a new Spoke in a given project and location.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/spokes/create Required parameters: parent Optional parameters: spokeId, requestId Body: {:description string, :linkedInterconnectAttachments [string], :labels {}, :hub string, :name string, :linkedRouterApplianceInstances [{:networkInterface string, :ipAddress string, :virtualMachine string}], :createTime string, :linkedVpnTunnels [string], :state string, :updateTime string, :uniqueId string} Creates a new Spoke in a given project and location.
(locations-spokes-delete$ auth parameters)
Required parameters: name
Optional parameters: requestId
Deletes a single Spoke.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/spokes/delete Required parameters: name Optional parameters: requestId Deletes a single Spoke.
(locations-spokes-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets details of a single Spoke.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/spokes/get Required parameters: name Optional parameters: none Gets details of a single Spoke.
(locations-spokes-getIamPolicy$ auth parameters)
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/spokes/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(locations-spokes-list$ auth parameters)
Required parameters: parent
Optional parameters: orderBy, pageSize, pageToken, filter
Lists Spokes in a given project and location.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/spokes/list Required parameters: parent Optional parameters: orderBy, pageSize, pageToken, filter Lists Spokes in a given project and location.
(locations-spokes-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask, requestId
Body:
{:description string, :linkedInterconnectAttachments [string], :labels {}, :hub string, :name string, :linkedRouterApplianceInstances [{:networkInterface string, :ipAddress string, :virtualMachine string}], :createTime string, :linkedVpnTunnels [string], :state string, :updateTime string, :uniqueId string}
Updates the parameters of a single Spoke.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/spokes/patch Required parameters: name Optional parameters: updateMask, requestId Body: {:description string, :linkedInterconnectAttachments [string], :labels {}, :hub string, :name string, :linkedRouterApplianceInstances [{:networkInterface string, :ipAddress string, :virtualMachine string}], :createTime string, :linkedVpnTunnels [string], :state string, :updateTime string, :uniqueId string} Updates the parameters of a single Spoke.
(locations-spokes-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/spokes/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:version integer, :bindings [Binding], :auditConfigs [AuditConfig], :etag string}, :updateMask string} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(locations-spokes-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/restapi/reference/rest/v1alpha1/projects/locations/spokes/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close