Network Management v1 API - Class ReachabilityService.ReachabilityServiceClient (2.9.0)

Version 2.9.0

• 2.10.0 (latest)
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.0

public class ReachabilityService.ReachabilityServiceClient : ClientBase<ReachabilityService.ReachabilityServiceClient>

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

Client for ReachabilityService

Inheritance

object > ClientBase > ClientBaseReachabilityServiceReachabilityServiceClient > ReachabilityService.ReachabilityServiceClient

Inherited Members

ClientBase<ReachabilityService.ReachabilityServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.NetworkManagement.V1

Assembly

Google.Cloud.NetworkManagement.V1.dll

Constructors

ReachabilityServiceClient()

protected ReachabilityServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ReachabilityServiceClient(CallInvoker)

public ReachabilityServiceClient(CallInvoker callInvoker)

Creates a new client for ReachabilityService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ReachabilityServiceClient(ChannelBase)

public ReachabilityServiceClient(ChannelBase channel)

Creates a new client for ReachabilityService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

ReachabilityServiceClient(ClientBaseConfiguration)

protected ReachabilityServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateConnectivityTest(CreateConnectivityTestRequest, CallOptions)

public virtual Operation CreateConnectivityTest(CreateConnectivityTestRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateConnectivityTest(CreateConnectivityTestRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateConnectivityTest(CreateConnectivityTestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateConnectivityTestAsync(CreateConnectivityTestRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateConnectivityTestAsync(CreateConnectivityTestRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateConnectivityTestAsync(CreateConnectivityTestRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateConnectivityTestAsync(CreateConnectivityTestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteConnectivityTest(DeleteConnectivityTestRequest, CallOptions)

public virtual Operation DeleteConnectivityTest(DeleteConnectivityTestRequest request, CallOptions options)

Deletes a specific ConnectivityTest.

Parameters
Name	Description
request	DeleteConnectivityTestRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteConnectivityTest(DeleteConnectivityTestRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteConnectivityTest(DeleteConnectivityTestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a specific ConnectivityTest.

Parameters
Name	Description
request	DeleteConnectivityTestRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteConnectivityTestAsync(DeleteConnectivityTestRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteConnectivityTestAsync(DeleteConnectivityTestRequest request, CallOptions options)

Deletes a specific ConnectivityTest.

Parameters
Name	Description
request	DeleteConnectivityTestRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteConnectivityTestAsync(DeleteConnectivityTestRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteConnectivityTestAsync(DeleteConnectivityTestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a specific ConnectivityTest.

Parameters
Name	Description
request	DeleteConnectivityTestRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GetConnectivityTest(GetConnectivityTestRequest, CallOptions)

public virtual ConnectivityTest GetConnectivityTest(GetConnectivityTestRequest request, CallOptions options)

Gets the details of a specific Connectivity Test.

Parameters
Name	Description
request	GetConnectivityTestRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ConnectivityTest	The response received from the server.

GetConnectivityTest(GetConnectivityTestRequest, Metadata, DateTime?, CancellationToken)

public virtual ConnectivityTest GetConnectivityTest(GetConnectivityTestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a specific Connectivity Test.

Parameters
Name	Description
request	GetConnectivityTestRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ConnectivityTest	The response received from the server.

GetConnectivityTestAsync(GetConnectivityTestRequest, CallOptions)

public virtual AsyncUnaryCall<ConnectivityTest> GetConnectivityTestAsync(GetConnectivityTestRequest request, CallOptions options)

Gets the details of a specific Connectivity Test.

Parameters
Name	Description
request	GetConnectivityTestRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallConnectivityTest	The call object.

GetConnectivityTestAsync(GetConnectivityTestRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ConnectivityTest> GetConnectivityTestAsync(GetConnectivityTestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of a specific Connectivity Test.

Parameters
Name	Description
request	GetConnectivityTestRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallConnectivityTest	The call object.

ListConnectivityTests(ListConnectivityTestsRequest, CallOptions)

public virtual ListConnectivityTestsResponse ListConnectivityTests(ListConnectivityTestsRequest request, CallOptions options)

Lists all Connectivity Tests owned by a project.

Parameters
Name	Description
request	ListConnectivityTestsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListConnectivityTestsResponse	The response received from the server.

ListConnectivityTests(ListConnectivityTestsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListConnectivityTestsResponse ListConnectivityTests(ListConnectivityTestsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all Connectivity Tests owned by a project.

Parameters
Name	Description
request	ListConnectivityTestsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListConnectivityTestsResponse	The response received from the server.

ListConnectivityTestsAsync(ListConnectivityTestsRequest, CallOptions)

public virtual AsyncUnaryCall<ListConnectivityTestsResponse> ListConnectivityTestsAsync(ListConnectivityTestsRequest request, CallOptions options)

Lists all Connectivity Tests owned by a project.

Parameters
Name	Description
request	ListConnectivityTestsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListConnectivityTestsResponse	The call object.

ListConnectivityTestsAsync(ListConnectivityTestsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListConnectivityTestsResponse> ListConnectivityTestsAsync(ListConnectivityTestsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all Connectivity Tests owned by a project.

Parameters
Name	Description
request	ListConnectivityTestsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListConnectivityTestsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override ReachabilityService.ReachabilityServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ReachabilityServiceReachabilityServiceClient

Overrides

ClientBase<ReachabilityService.ReachabilityServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

RerunConnectivityTest(RerunConnectivityTestRequest, CallOptions)

public virtual Operation RerunConnectivityTest(RerunConnectivityTestRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

RerunConnectivityTest(RerunConnectivityTestRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RerunConnectivityTest(RerunConnectivityTestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

RerunConnectivityTestAsync(RerunConnectivityTestRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RerunConnectivityTestAsync(RerunConnectivityTestRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RerunConnectivityTestAsync(RerunConnectivityTestRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RerunConnectivityTestAsync(RerunConnectivityTestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateConnectivityTest(UpdateConnectivityTestRequest, CallOptions)

public virtual Operation UpdateConnectivityTest(UpdateConnectivityTestRequest request, CallOptions options)

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.

Parameters
Name	Description
request	UpdateConnectivityTestRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateConnectivityTest(UpdateConnectivityTestRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateConnectivityTest(UpdateConnectivityTestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	UpdateConnectivityTestRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateConnectivityTestAsync(UpdateConnectivityTestRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateConnectivityTestAsync(UpdateConnectivityTestRequest request, CallOptions options)

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.

Parameters
Name	Description
request	UpdateConnectivityTestRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateConnectivityTestAsync(UpdateConnectivityTestRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateConnectivityTestAsync(UpdateConnectivityTestRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	UpdateConnectivityTestRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.