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 organizationsLocationsGet(name: string): Promise<Location>;

async organizationsLocationsList(name: string, opts?: OrganizationsLocationsListOptions): Promise<ListLocationsResponse>;

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

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

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

async organizationsLocationsOperationsList(name: string, opts?: OrganizationsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async organizationsLocationsVpcFlowLogsConfigsCreate(

parent: string,

req: VpcFlowLogsConfig,

opts?: OrganizationsLocationsVpcFlowLogsConfigsCreateOptions,

): Promise<Operation>;

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

async organizationsLocationsVpcFlowLogsConfigsGet(name: string): Promise<VpcFlowLogsConfig>;

async organizationsLocationsVpcFlowLogsConfigsList(parent: string, opts?: OrganizationsLocationsVpcFlowLogsConfigsListOptions): Promise<ListVpcFlowLogsConfigsResponse>;

async organizationsLocationsVpcFlowLogsConfigsPatch(

req: VpcFlowLogsConfig,

opts?: OrganizationsLocationsVpcFlowLogsConfigsPatchOptions,

): Promise<Operation>;

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(

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>;

async projectsLocationsNetworkMonitoringProvidersCreate(

parent: string,

req: NetworkMonitoringProvider,

opts?: ProjectsLocationsNetworkMonitoringProvidersCreateOptions,

): Promise<Operation>;

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

async projectsLocationsNetworkMonitoringProvidersGet(name: string): Promise<NetworkMonitoringProvider>;

async projectsLocationsNetworkMonitoringProvidersList(parent: string, opts?: ProjectsLocationsNetworkMonitoringProvidersListOptions): Promise<ListNetworkMonitoringProvidersResponse>;

async projectsLocationsNetworkMonitoringProvidersMonitoringPointsGet(name: string): Promise<MonitoringPoint>;

async projectsLocationsNetworkMonitoringProvidersMonitoringPointsList(parent: string, opts?: ProjectsLocationsNetworkMonitoringProvidersMonitoringPointsListOptions): Promise<ListMonitoringPointsResponse>;

async projectsLocationsNetworkMonitoringProvidersNetworkPathsGet(name: string): Promise<NetworkPath>;

async projectsLocationsNetworkMonitoringProvidersNetworkPathsList(parent: string, opts?: ProjectsLocationsNetworkMonitoringProvidersNetworkPathsListOptions): Promise<ListNetworkPathsResponse>;

async projectsLocationsNetworkMonitoringProvidersWebPathsGet(name: string): Promise<WebPath>;

async projectsLocationsNetworkMonitoringProvidersWebPathsList(parent: string, opts?: ProjectsLocationsNetworkMonitoringProvidersWebPathsListOptions): Promise<ListWebPathsResponse>;

async projectsLocationsVpcFlowLogsConfigsCreate(

parent: string,

req: VpcFlowLogsConfig,

opts?: ProjectsLocationsVpcFlowLogsConfigsCreateOptions,

): Promise<Operation>;

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

async projectsLocationsVpcFlowLogsConfigsGet(name: string): Promise<VpcFlowLogsConfig>;

async projectsLocationsVpcFlowLogsConfigsList(parent: string, opts?: ProjectsLocationsVpcFlowLogsConfigsListOptions): Promise<ListVpcFlowLogsConfigsResponse>;

async projectsLocationsVpcFlowLogsConfigsPatch(

req: VpcFlowLogsConfig,

opts?: ProjectsLocationsVpcFlowLogsConfigsPatchOptions,

): Promise<Operation>;

async projectsLocationsVpcFlowLogsConfigsQueryOrgVpcFlowLogsConfigs(parent: string, opts?: ProjectsLocationsVpcFlowLogsConfigsQueryOrgVpcFlowLogsConfigsOptions): Promise<QueryOrgVpcFlowLogsConfigsResponse>;

async projectsLocationsVpcFlowLogsConfigsShowEffectiveFlowLogsConfigs(parent: string, opts?: ProjectsLocationsVpcFlowLogsConfigsShowEffectiveFlowLogsConfigsOptions): Promise<ShowEffectiveFlowLogsConfigsResponse>;

}

§Constructors

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

[src]

§Methods

organizationsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

organizationsLocationsList(name: string, opts?: OrganizationsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

organizationsLocationsOperationsCancel(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.

organizationsLocationsOperationsDelete(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.

organizationsLocationsOperationsGet(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.

organizationsLocationsOperationsList(name: string, opts?: OrganizationsLocationsOperationsListOptions): 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.

organizationsLocationsVpcFlowLogsConfigsCreate(parent: string, req: VpcFlowLogsConfig, opts?: OrganizationsLocationsVpcFlowLogsConfigsCreateOptions): Promise<Operation>

[src]

Creates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description

@param parent

Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats: - For project-level resources: projects/{project_id}/locations/global - For organization-level resources: organizations/{organization_id}/locations/global

organizationsLocationsVpcFlowLogsConfigsDelete(name: string): Promise<Operation>

[src]

Deletes a specific VpcFlowLogsConfig.

@param name

Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For a project-level resource: projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id} - For an organization-level resource: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}

organizationsLocationsVpcFlowLogsConfigsGet(name: string): Promise<VpcFlowLogsConfig>

[src]

Gets the details of a specific VpcFlowLogsConfig.

@param name

Required. The resource name of the VpcFlowLogsConfig, in one of the following formats: - For project-level resources: projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id} - For organization-level resources: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}

organizationsLocationsVpcFlowLogsConfigsList(parent: string, opts?: OrganizationsLocationsVpcFlowLogsConfigsListOptions): Promise<ListVpcFlowLogsConfigsResponse>

[src]

Lists all VpcFlowLogsConfigs in a given organization.

@param parent

Required. The parent resource of the VpcFlowLogsConfig, in one of the following formats: - For project-level resourcs: projects/{project_id}/locations/global - For organization-level resources: organizations/{organization_id}/locations/global

organizationsLocationsVpcFlowLogsConfigsPatch(name: string, req: VpcFlowLogsConfig, opts?: OrganizationsLocationsVpcFlowLogsConfigsPatchOptions): Promise<Operation>

[src]

Updates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with state=DISABLED will fail 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description

@param name

Identifier. Unique name of the configuration. The name can have one of the following forms: - For project-level configurations: projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id} - For organization-level configurations: organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}

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]

@param name

The name of the operation resource to be cancelled.

projectsLocationsGlobalOperationsDelete(name: string): Promise<Empty>

[src]

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

projectsLocationsNetworkMonitoringProvidersCreate(parent: string, req: NetworkMonitoringProvider, opts?: ProjectsLocationsNetworkMonitoringProvidersCreateOptions): Promise<Operation>

[src]

Creates a NetworkMonitoringProvider resource.

@param parent

Required. Parent value for CreateNetworkMonitoringProviderRequest. Format: projects/{project}/locations/{location}

projectsLocationsNetworkMonitoringProvidersDelete(name: string): Promise<Operation>

[src]

Deletes a NetworkMonitoringProvider resource and all of its child resources.

@param name

Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}

projectsLocationsNetworkMonitoringProvidersGet(name: string): Promise<NetworkMonitoringProvider>

[src]

Gets the NetworkMonitoringProvider resource.

@param name

Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}

projectsLocationsNetworkMonitoringProvidersList(parent: string, opts?: ProjectsLocationsNetworkMonitoringProvidersListOptions): Promise<ListNetworkMonitoringProvidersResponse>

[src]

Lists NetworkMonitoringProviders for a given project and location.

@param parent

Required. Parent value for ListNetworkMonitoringProvidersRequest. Format: projects/{project}/locations/{location}

projectsLocationsNetworkMonitoringProvidersMonitoringPointsGet(name: string): Promise<MonitoringPoint>

[src]

Gets the MonitoringPoint resource.

@param name

Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point}

projectsLocationsNetworkMonitoringProvidersMonitoringPointsList(parent: string, opts?: ProjectsLocationsNetworkMonitoringProvidersMonitoringPointsListOptions): Promise<ListMonitoringPointsResponse>

[src]

Lists MonitoringPoints for a given network monitoring provider.

@param parent

Required. Parent value for ListMonitoringPointsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}

projectsLocationsNetworkMonitoringProvidersNetworkPathsGet(name: string): Promise<NetworkPath>

[src]

Gets the NetworkPath resource.

@param name

Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}

projectsLocationsNetworkMonitoringProvidersNetworkPathsList(parent: string, opts?: ProjectsLocationsNetworkMonitoringProvidersNetworkPathsListOptions): Promise<ListNetworkPathsResponse>

[src]

Lists NetworkPaths for a given network monitoring provider.

@param parent

Required. Parent value for ListNetworkPathsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}

projectsLocationsNetworkMonitoringProvidersWebPathsGet(name: string): Promise<WebPath>

[src]

Gets the WebPath resource.

@param name

Required. Name of the resource.. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/webPaths/{web_path}

projectsLocationsNetworkMonitoringProvidersWebPathsList(parent: string, opts?: ProjectsLocationsNetworkMonitoringProvidersWebPathsListOptions): Promise<ListWebPathsResponse>

[src]

Lists WebPaths for a given network monitoring provider.

@param parent

Required. Parent value for ListWebPathsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}

projectsLocationsVpcFlowLogsConfigsCreate(parent: string, req: VpcFlowLogsConfig, opts?: ProjectsLocationsVpcFlowLogsConfigsCreateOptions): Promise<Operation>

[src]

@param parent

projectsLocationsVpcFlowLogsConfigsDelete(name: string): Promise<Operation>

[src]

Deletes a specific VpcFlowLogsConfig.

@param name

projectsLocationsVpcFlowLogsConfigsGet(name: string): Promise<VpcFlowLogsConfig>

[src]

Gets the details of a specific VpcFlowLogsConfig.

@param name

projectsLocationsVpcFlowLogsConfigsList(parent: string, opts?: ProjectsLocationsVpcFlowLogsConfigsListOptions): Promise<ListVpcFlowLogsConfigsResponse>

[src]

Lists all VpcFlowLogsConfigs in a given project.

@param parent

projectsLocationsVpcFlowLogsConfigsPatch(name: string, req: VpcFlowLogsConfig, opts?: ProjectsLocationsVpcFlowLogsConfigsPatchOptions): Promise<Operation>

[src]

Updates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Updating a configuration with state=DISABLED will fail. 2. The following fields are not considered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: * name * create_time * update_time * labels * description

@param name

projectsLocationsVpcFlowLogsConfigsQueryOrgVpcFlowLogsConfigs(parent: string, opts?: ProjectsLocationsVpcFlowLogsConfigsQueryOrgVpcFlowLogsConfigsOptions): Promise<QueryOrgVpcFlowLogsConfigsResponse>

[src]

QueryOrgVpcFlowLogsConfigs returns a list of all organization-level VPC Flow Logs configurations applicable to the specified project.

@param parent

Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: projects/{project_id}/locations/global

projectsLocationsVpcFlowLogsConfigsShowEffectiveFlowLogsConfigs(parent: string, opts?: ProjectsLocationsVpcFlowLogsConfigsShowEffectiveFlowLogsConfigsOptions): Promise<ShowEffectiveFlowLogsConfigsResponse>

[src]

ShowEffectiveFlowLogsConfigs returns a list of all VPC Flow Logs configurations applicable to a specified resource.

@param parent

Required. The parent resource of the VpcFlowLogsConfig, specified in the following format: projects/{project_id}/locations/global