Network Management v1 API - Class ReachabilityService.ReachabilityServiceBase (2.12.0)

[BindServiceMethod(typeof(ReachabilityService), "BindService")]
public abstract class ReachabilityService.ReachabilityServiceBase

Reference documentation and code samples for the Network Management v1 API class ReachabilityService.ReachabilityServiceBase.

Base class for server-side implementations of ReachabilityService

Inheritance

object > ReachabilityService.ReachabilityServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.NetworkManagement.V1

Assembly

Google.Cloud.NetworkManagement.V1.dll

Methods

CreateConnectivityTest(CreateConnectivityTestRequest, ServerCallContext)

public virtual Task<Operation> CreateConnectivityTest(CreateConnectivityTestRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`CreateConnectivityTestRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteConnectivityTest(DeleteConnectivityTestRequest, ServerCallContext)

public virtual Task<Operation> DeleteConnectivityTest(DeleteConnectivityTestRequest request, ServerCallContext context)

Deletes a specific ConnectivityTest.

Parameters
Name	Description
`request`	`DeleteConnectivityTestRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

GetConnectivityTest(GetConnectivityTestRequest, ServerCallContext)

public virtual Task<ConnectivityTest> GetConnectivityTest(GetConnectivityTestRequest request, ServerCallContext context)

Gets the details of a specific Connectivity Test.

Parameters
Name	Description
`request`	`GetConnectivityTestRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskConnectivityTest`	The response to send back to the client (wrapped by a task).

ListConnectivityTests(ListConnectivityTestsRequest, ServerCallContext)

public virtual Task<ListConnectivityTestsResponse> ListConnectivityTests(ListConnectivityTestsRequest request, ServerCallContext context)

Lists all Connectivity Tests owned by a project.

Parameters
Name	Description
`request`	`ListConnectivityTestsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListConnectivityTestsResponse`	The response to send back to the client (wrapped by a task).

RerunConnectivityTest(RerunConnectivityTestRequest, ServerCallContext)

public virtual Task<Operation> RerunConnectivityTest(RerunConnectivityTestRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`RerunConnectivityTestRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateConnectivityTest(UpdateConnectivityTestRequest, ServerCallContext)

public virtual Task<Operation> UpdateConnectivityTest(UpdateConnectivityTestRequest request, ServerCallContext context)

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 more details.

Parameters
Name	Description
`request`	`UpdateConnectivityTestRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).