NetworkManagement

import { NetworkManagement } from "https://googleapis.deno.dev/v1/networkmanagement:v1.ts";

The Network Management API provides a collection of network performance monitoring and diagnostic capabilities.

class NetworkManagement {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsGlobalConnectivityTestsCreate(

parent: string,

req: ConnectivityTest,

opts?: ProjectsLocationsGlobalConnectivityTestsCreateOptions,

): Promise<Operation>;

async projectsLocationsGlobalConnectivityTestsDelete(name: string): Promise<Operation>;

async projectsLocationsGlobalConnectivityTestsGet(name: string): Promise<ConnectivityTest>;

async projectsLocationsGlobalConnectivityTestsGetIamPolicy(resource: string, opts?: ProjectsLocationsGlobalConnectivityTestsGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsGlobalConnectivityTestsList(parent: string, opts?: ProjectsLocationsGlobalConnectivityTestsListOptions): Promise<ListConnectivityTestsResponse>;

async projectsLocationsGlobalConnectivityTestsPatch(

name: string,

req: ConnectivityTest,

opts?: ProjectsLocationsGlobalConnectivityTestsPatchOptions,

): Promise<Operation>;

async projectsLocationsGlobalConnectivityTestsRerun(name: string, req: RerunConnectivityTestRequest): Promise<Operation>;

async projectsLocationsGlobalConnectivityTestsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsGlobalConnectivityTestsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsGlobalOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsGlobalOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsGlobalOperationsGet(name: string): Promise<Operation>;

async projectsLocationsGlobalOperationsList(name: string, opts?: ProjectsLocationsGlobalOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

}

§Constructors

new NetworkManagement(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsGlobalConnectivityTestsCreate(parent: string, req: ConnectivityTest, opts?: ProjectsLocationsGlobalConnectivityTestsCreateOptions): Promise<Operation>

[src]

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 AMBIGUOUS. For more information, see the Connectivity Test documentation.

@param parent

Required. The parent resource of the Connectivity Test to create: projects/{project_id}/locations/global

projectsLocationsGlobalConnectivityTestsDelete(name: string): Promise<Operation>

[src]

Deletes a specific ConnectivityTest.

@param name

Required. Connectivity Test resource name using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

projectsLocationsGlobalConnectivityTestsGet(name: string): Promise<ConnectivityTest>

[src]

Gets the details of a specific Connectivity Test.

@param name

Required. ConnectivityTest resource name using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

projectsLocationsGlobalConnectivityTestsGetIamPolicy(resource: string, opts?: ProjectsLocationsGlobalConnectivityTestsGetIamPolicyOptions): Promise<Policy>

[src]

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

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

projectsLocationsGlobalConnectivityTestsList(parent: string, opts?: ProjectsLocationsGlobalConnectivityTestsListOptions): Promise<ListConnectivityTestsResponse>

[src]

Lists all Connectivity Tests owned by a project.

@param parent

Required. The parent resource of the Connectivity Tests: projects/{project_id}/locations/global

projectsLocationsGlobalConnectivityTestsPatch(name: string, req: ConnectivityTest, opts?: ProjectsLocationsGlobalConnectivityTestsPatchOptions): Promise<Operation>

[src]

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 UNKNOWN. If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. See the documentation in ConnectivityTest for more details.

@param name

Identifier. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

projectsLocationsGlobalConnectivityTestsRerun(name: string, req: RerunConnectivityTestRequest): Promise<Operation>

[src]

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.

@param name

Required. Connectivity Test resource name using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

projectsLocationsGlobalConnectivityTestsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

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

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

projectsLocationsGlobalConnectivityTestsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

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.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

projectsLocationsGlobalOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be cancelled.

projectsLocationsGlobalOperationsDelete(name: string): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be deleted.

projectsLocationsGlobalOperationsGet(name: string): Promise<Operation>

[src]

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.

@param name

The name of the operation resource.

projectsLocationsGlobalOperationsList(name: string, opts?: ProjectsLocationsGlobalOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.