- locations-get$
- locations-global-connectivityTests-create$
- locations-global-connectivityTests-delete$
- locations-global-connectivityTests-get$
- locations-global-connectivityTests-getIamPolicy$
- locations-global-connectivityTests-list$
- locations-global-connectivityTests-patch$
- locations-global-connectivityTests-rerun$
- locations-global-connectivityTests-setIamPolicy$
- locations-global-connectivityTests-testIamPermissions$
- locations-global-operations-cancel$
- locations-global-operations-delete$
- locations-global-operations-get$
- locations-global-operations-list$
- locations-list$
happygapi.networkmanagement.projects
Network Management API: projects. The Network Management API provides a collection of network performance monitoring and diagnostic capabilities. See: https://cloud.google.com/api/reference/rest/v1beta1/projects
Network Management API: projects. The Network Management API provides a collection of network performance monitoring and diagnostic capabilities. See: https://cloud.google.com/api/reference/rest/v1beta1/projects
locations-get$clj
(locations-get$ auth parameters)https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/get
Required parameters: name
Optional parameters: none
Gets information about a location.
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/get Required parameters: name Optional parameters: none Gets information about a location.
locations-global-connectivityTests-create$clj
(locations-global-connectivityTests-create$ auth parameters body)Required parameters: parent
Optional parameters: testId
Body:
{:description string, :labels {}, :protocol string, :displayName string, :name string, :createTime string, :relatedProjects [string], :source {:networkType string, :ipAddress string, :instance string, :projectId string, :port integer, :network string}, :updateTime string, :reachabilityDetails {:traces [Trace], :result string, :error Status, :verifyTime string}, :destination {:networkType string, :ipAddress string, :instance string, :projectId string, :port integer, :network string}}
Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes.
If the endpoint specifications in ConnectivityTest are invalid
(for example, containing non-existent resources in the network, or you
don't have read permissions to the network configurations of listed
projects), then the reachability result returns a value of UNKNOWN.
If the endpoint specifications in ConnectivityTest are
incomplete, the reachability result returns a value of
<code>AMBIGUOUS</code>. For more information,
see the Connectivity Test documentation.
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/connectivityTests/create
Required parameters: parent
Optional parameters: testId
Body:
{:description string,
:labels {},
:protocol string,
:displayName string,
:name string,
:createTime string,
:relatedProjects [string],
:source {:networkType string,
:ipAddress string,
:instance string,
:projectId string,
:port integer,
:network string},
:updateTime string,
:reachabilityDetails {:traces [Trace],
:result string,
:error Status,
:verifyTime string},
:destination {:networkType string,
:ipAddress string,
:instance string,
:projectId string,
:port integer,
:network string}}
Creates a new Connectivity Test.
After you create a test, the reachability analysis is performed as part
of the long running operation, which completes when the analysis completes.
If the endpoint specifications in `ConnectivityTest` are invalid
(for example, containing non-existent resources in the network, or you
don't have read permissions to the network configurations of listed
projects), then the reachability result returns a value of `UNKNOWN`.
If the endpoint specifications in `ConnectivityTest` are
incomplete, the reachability result returns a value of
<code>AMBIGUOUS</code>. For more information,
see the Connectivity Test documentation.locations-global-connectivityTests-delete$clj
(locations-global-connectivityTests-delete$ auth parameters)Required parameters: name
Optional parameters: none
Deletes a specific ConnectivityTest.
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/connectivityTests/delete Required parameters: name Optional parameters: none Deletes a specific `ConnectivityTest`.
locations-global-connectivityTests-get$clj
(locations-global-connectivityTests-get$ auth parameters)https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/connectivityTests/get
Required parameters: name
Optional parameters: none
Gets the details of a specific Connectivity Test.
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/connectivityTests/get Required parameters: name Optional parameters: none Gets the details of a specific Connectivity Test.
locations-global-connectivityTests-getIamPolicy$clj
(locations-global-connectivityTests-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/api/reference/rest/v1beta1/projects/locations/global/connectivityTests/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-connectivityTests-list$clj
(locations-global-connectivityTests-list$ auth parameters)https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/connectivityTests/list
Required parameters: parent
Optional parameters: pageToken, orderBy, pageSize, filter
Lists all Connectivity Tests owned by a project.
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/connectivityTests/list Required parameters: parent Optional parameters: pageToken, orderBy, pageSize, filter Lists all Connectivity Tests owned by a project.
locations-global-connectivityTests-patch$clj
(locations-global-connectivityTests-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:description string, :labels {}, :protocol string, :displayName string, :name string, :createTime string, :relatedProjects [string], :source {:networkType string, :ipAddress string, :instance string, :projectId string, :port integer, :network string}, :updateTime string, :reachabilityDetails {:traces [Trace], :result string, :error Status, :verifyTime string}, :destination {:networkType string, :ipAddress string, :instance string, :projectId string, :port integer, :network string}}
Updates the configuration of an existing ConnectivityTest.
After you update a test, the reachability analysis is performed as part
of the long running operation, which completes when the analysis completes.
The Reachability state in the test resource is updated with the new result.
If the endpoint specifications in ConnectivityTest are invalid
(for example, they contain non-existent resources in the network, or the
user does not have read permissions to the network configurations of
listed projects), then the reachability result returns a value of
<code>UNKNOWN</code>.
If the endpoint specifications in ConnectivityTest are incomplete, the
reachability result returns a value of AMBIGUOUS. See the documentation
in ConnectivityTest for for more details.
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/connectivityTests/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:description string,
:labels {},
:protocol string,
:displayName string,
:name string,
:createTime string,
:relatedProjects [string],
:source {:networkType string,
:ipAddress string,
:instance string,
:projectId string,
:port integer,
:network string},
:updateTime string,
:reachabilityDetails {:traces [Trace],
:result string,
:error Status,
:verifyTime string},
:destination {:networkType string,
:ipAddress string,
:instance string,
:projectId string,
:port integer,
:network string}}
Updates the configuration of an existing `ConnectivityTest`.
After you update a test, the reachability analysis is performed as part
of the long running operation, which completes when the analysis completes.
The Reachability state in the test resource is updated with the new result.
If the endpoint specifications in `ConnectivityTest` are invalid
(for example, they contain non-existent resources in the network, or the
user does not have read permissions to the network configurations of
listed projects), then the reachability result returns a value of
<code>UNKNOWN</code>.
If the endpoint specifications in `ConnectivityTest` are incomplete, the
reachability result returns a value of `AMBIGUOUS`. See the documentation
in `ConnectivityTest` for for more details.locations-global-connectivityTests-rerun$clj
(locations-global-connectivityTests-rerun$ auth parameters body)Required parameters: name
Optional parameters: none
Body:
{}
Rerun an existing ConnectivityTest.
After the user triggers the rerun, the reachability analysis is performed
as part of the long running operation, which completes when the analysis
completes.
Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes.
If the endpoint specifications in ConnectivityTest become invalid (for
example, specified resources are deleted in the network, or you lost
read permissions to the network configurations of listed projects), then
the reachability result returns a value of UNKNOWN.
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/connectivityTests/rerun
Required parameters: name
Optional parameters: none
Body:
{}
Rerun an existing `ConnectivityTest`.
After the user triggers the rerun, the reachability analysis is performed
as part of the long running operation, which completes when the analysis
completes.
Even though the test configuration remains the same, the reachability
result may change due to underlying network configuration changes.
If the endpoint specifications in `ConnectivityTest` become invalid (for
example, specified resources are deleted in the network, or you lost
read permissions to the network configurations of listed projects), then
the reachability result returns a value of `UNKNOWN`.locations-global-connectivityTests-setIamPolicy$clj
(locations-global-connectivityTests-setIamPolicy$ auth parameters body)Required parameters: resource
Optional parameters: none
Body:
{:updateMask string, :policy {:auditConfigs [AuditConfig], :bindings [Binding], :etag string, :version integer}}
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/connectivityTests/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:updateMask string,
:policy {:auditConfigs [AuditConfig],
:bindings [Binding],
:etag string,
:version integer}}
Sets the access control policy on the specified resource. Replaces any
existing policy.
Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIEDlocations-global-connectivityTests-testIamPermissions$clj
(locations-global-connectivityTests-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/api/reference/rest/v1beta1/projects/locations/global/connectivityTests/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-global-operations-cancel$clj
(locations-global-operations-cancel$ auth parameters body)https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/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.
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/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-global-operations-delete$clj
(locations-global-operations-delete$ auth parameters)https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/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.
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/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-global-operations-get$clj
(locations-global-operations-get$ auth parameters)https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/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.
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/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-global-operations-list$clj
(locations-global-operations-list$ auth parameters)https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/global/operations/list
Required parameters: name
Optional parameters: filter, pageToken, pageSize
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/api/reference/rest/v1beta1/projects/locations/global/operations/list
Required parameters: name
Optional parameters: filter, pageToken, pageSize
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-list$clj
(locations-list$ auth parameters)https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/list
Required parameters: name
Optional parameters: filter, pageToken, pageSize
Lists information about the supported locations for this service.
https://cloud.google.com/api/reference/rest/v1beta1/projects/locations/list Required parameters: name Optional parameters: filter, pageToken, pageSize Lists information about the supported locations for this service.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close