Network Management v1 API - Class ReachabilityServiceClientImpl (2.9.0)

Version 2.9.0

• 2.11.0 (latest)
• 2.10.0
• 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 sealed class ReachabilityServiceClientImpl : ReachabilityServiceClient

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

ReachabilityService client wrapper implementation, for convenient use.

Inheritance

object > ReachabilityServiceClient > ReachabilityServiceClientImpl

Inherited Members

ReachabilityServiceClient.DefaultEndpoint

ReachabilityServiceClient.DefaultScopes

ReachabilityServiceClient.ServiceMetadata

ReachabilityServiceClient.CreateAsync(CancellationToken)

ReachabilityServiceClient.Create()

ReachabilityServiceClient.ShutdownDefaultChannelsAsync()

ReachabilityServiceClient.ListConnectivityTests(string, string, int?, CallSettings)

ReachabilityServiceClient.ListConnectivityTestsAsync(string, string, int?, CallSettings)

ReachabilityServiceClient.GetConnectivityTestAsync(GetConnectivityTestRequest, CancellationToken)

ReachabilityServiceClient.GetConnectivityTest(string, CallSettings)

ReachabilityServiceClient.GetConnectivityTestAsync(string, CallSettings)

ReachabilityServiceClient.GetConnectivityTestAsync(string, CancellationToken)

ReachabilityServiceClient.CreateConnectivityTestAsync(CreateConnectivityTestRequest, CancellationToken)

ReachabilityServiceClient.PollOnceCreateConnectivityTest(string, CallSettings)

ReachabilityServiceClient.PollOnceCreateConnectivityTestAsync(string, CallSettings)

ReachabilityServiceClient.CreateConnectivityTest(string, string, ConnectivityTest, CallSettings)

ReachabilityServiceClient.CreateConnectivityTestAsync(string, string, ConnectivityTest, CallSettings)

ReachabilityServiceClient.CreateConnectivityTestAsync(string, string, ConnectivityTest, CancellationToken)

ReachabilityServiceClient.UpdateConnectivityTestAsync(UpdateConnectivityTestRequest, CancellationToken)

ReachabilityServiceClient.PollOnceUpdateConnectivityTest(string, CallSettings)

ReachabilityServiceClient.PollOnceUpdateConnectivityTestAsync(string, CallSettings)

ReachabilityServiceClient.UpdateConnectivityTest(FieldMask, ConnectivityTest, CallSettings)

ReachabilityServiceClient.UpdateConnectivityTestAsync(FieldMask, ConnectivityTest, CallSettings)

ReachabilityServiceClient.UpdateConnectivityTestAsync(FieldMask, ConnectivityTest, CancellationToken)

ReachabilityServiceClient.RerunConnectivityTestAsync(RerunConnectivityTestRequest, CancellationToken)

ReachabilityServiceClient.PollOnceRerunConnectivityTest(string, CallSettings)

ReachabilityServiceClient.PollOnceRerunConnectivityTestAsync(string, CallSettings)

ReachabilityServiceClient.DeleteConnectivityTestAsync(DeleteConnectivityTestRequest, CancellationToken)

ReachabilityServiceClient.PollOnceDeleteConnectivityTest(string, CallSettings)

ReachabilityServiceClient.PollOnceDeleteConnectivityTestAsync(string, CallSettings)

ReachabilityServiceClient.DeleteConnectivityTest(string, CallSettings)

ReachabilityServiceClient.DeleteConnectivityTestAsync(string, CallSettings)

ReachabilityServiceClient.DeleteConnectivityTestAsync(string, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.NetworkManagement.V1

Assembly

Google.Cloud.NetworkManagement.V1.dll

Remarks

The Reachability service in the Google Cloud Network Management API provides services that analyze the reachability within a single Google Virtual Private Cloud (VPC) network, between peered VPC networks, between VPC and on-premises networks, or between VPC networks and internet hosts. A reachability analysis is based on Google Cloud network configurations.

You can use the analysis results to verify these configurations and to troubleshoot connectivity issues.

Constructors

ReachabilityServiceClientImpl(ReachabilityServiceClient, ReachabilityServiceSettings, ILogger)

public ReachabilityServiceClientImpl(ReachabilityService.ReachabilityServiceClient grpcClient, ReachabilityServiceSettings settings, ILogger logger)

Constructs a client wrapper for the ReachabilityService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	ReachabilityServiceReachabilityServiceClient The underlying gRPC client.
settings	ReachabilityServiceSettings The base ReachabilityServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

CreateConnectivityTestOperationsClient

public override OperationsClient CreateConnectivityTestOperationsClient { get; }

The long-running operations client for CreateConnectivityTest.

Property Value
Type	Description
OperationsClient

Overrides

ReachabilityServiceClient.CreateConnectivityTestOperationsClient

DeleteConnectivityTestOperationsClient

public override OperationsClient DeleteConnectivityTestOperationsClient { get; }

The long-running operations client for DeleteConnectivityTest.

Property Value
Type	Description
OperationsClient

Overrides

ReachabilityServiceClient.DeleteConnectivityTestOperationsClient

GrpcClient

public override ReachabilityService.ReachabilityServiceClient GrpcClient { get; }

The underlying gRPC ReachabilityService client

Property Value
Type	Description
ReachabilityServiceReachabilityServiceClient

Overrides

ReachabilityServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

Overrides

ReachabilityServiceClient.IAMPolicyClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

ReachabilityServiceClient.LocationsClient

RerunConnectivityTestOperationsClient

public override OperationsClient RerunConnectivityTestOperationsClient { get; }

The long-running operations client for RerunConnectivityTest.

Property Value
Type	Description
OperationsClient

Overrides

ReachabilityServiceClient.RerunConnectivityTestOperationsClient

UpdateConnectivityTestOperationsClient

public override OperationsClient UpdateConnectivityTestOperationsClient { get; }

The long-running operations client for UpdateConnectivityTest.

Property Value
Type	Description
OperationsClient

Overrides

ReachabilityServiceClient.UpdateConnectivityTestOperationsClient

Methods

CreateConnectivityTest(CreateConnectivityTestRequest, CallSettings)

public override Operation<ConnectivityTest, OperationMetadata> CreateConnectivityTest(CreateConnectivityTestRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationConnectivityTestOperationMetadata	The RPC response.

Overrides

ReachabilityServiceClient.CreateConnectivityTest(CreateConnectivityTestRequest, CallSettings)

CreateConnectivityTestAsync(CreateConnectivityTestRequest, CallSettings)

public override Task<Operation<ConnectivityTest, OperationMetadata>> CreateConnectivityTestAsync(CreateConnectivityTestRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationConnectivityTestOperationMetadata	A Task containing the RPC response.

Overrides

ReachabilityServiceClient.CreateConnectivityTestAsync(CreateConnectivityTestRequest, CallSettings)

DeleteConnectivityTest(DeleteConnectivityTestRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteConnectivityTest(DeleteConnectivityTestRequest request, CallSettings callSettings = null)

Deletes a specific ConnectivityTest.

Parameters
Name	Description
request	DeleteConnectivityTestRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Overrides

ReachabilityServiceClient.DeleteConnectivityTest(DeleteConnectivityTestRequest, CallSettings)

DeleteConnectivityTestAsync(DeleteConnectivityTestRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteConnectivityTestAsync(DeleteConnectivityTestRequest request, CallSettings callSettings = null)

Deletes a specific ConnectivityTest.

Parameters
Name	Description
request	DeleteConnectivityTestRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Overrides

ReachabilityServiceClient.DeleteConnectivityTestAsync(DeleteConnectivityTestRequest, CallSettings)

GetConnectivityTest(GetConnectivityTestRequest, CallSettings)

public override ConnectivityTest GetConnectivityTest(GetConnectivityTestRequest request, CallSettings callSettings = null)

Gets the details of a specific Connectivity Test.

Parameters
Name	Description
request	GetConnectivityTestRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ConnectivityTest	The RPC response.

Overrides

ReachabilityServiceClient.GetConnectivityTest(GetConnectivityTestRequest, CallSettings)

GetConnectivityTestAsync(GetConnectivityTestRequest, CallSettings)

public override Task<ConnectivityTest> GetConnectivityTestAsync(GetConnectivityTestRequest request, CallSettings callSettings = null)

Gets the details of a specific Connectivity Test.

Parameters
Name	Description
request	GetConnectivityTestRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskConnectivityTest	A Task containing the RPC response.

Overrides

ReachabilityServiceClient.GetConnectivityTestAsync(GetConnectivityTestRequest, CallSettings)

ListConnectivityTests(ListConnectivityTestsRequest, CallSettings)

public override PagedEnumerable<ListConnectivityTestsResponse, ConnectivityTest> ListConnectivityTests(ListConnectivityTestsRequest request, CallSettings callSettings = null)

Lists all Connectivity Tests owned by a project.

Parameters
Name	Description
request	ListConnectivityTestsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListConnectivityTestsResponseConnectivityTest	A pageable sequence of ConnectivityTest resources.

Overrides

ReachabilityServiceClient.ListConnectivityTests(ListConnectivityTestsRequest, CallSettings)

ListConnectivityTestsAsync(ListConnectivityTestsRequest, CallSettings)

public override PagedAsyncEnumerable<ListConnectivityTestsResponse, ConnectivityTest> ListConnectivityTestsAsync(ListConnectivityTestsRequest request, CallSettings callSettings = null)

Lists all Connectivity Tests owned by a project.

Parameters
Name	Description
request	ListConnectivityTestsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListConnectivityTestsResponseConnectivityTest	A pageable asynchronous sequence of ConnectivityTest resources.

Overrides

ReachabilityServiceClient.ListConnectivityTestsAsync(ListConnectivityTestsRequest, CallSettings)

RerunConnectivityTest(RerunConnectivityTestRequest, CallSettings)

public override Operation<ConnectivityTest, OperationMetadata> RerunConnectivityTest(RerunConnectivityTestRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationConnectivityTestOperationMetadata	The RPC response.

Overrides

ReachabilityServiceClient.RerunConnectivityTest(RerunConnectivityTestRequest, CallSettings)

RerunConnectivityTestAsync(RerunConnectivityTestRequest, CallSettings)

public override Task<Operation<ConnectivityTest, OperationMetadata>> RerunConnectivityTestAsync(RerunConnectivityTestRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationConnectivityTestOperationMetadata	A Task containing the RPC response.

Overrides

ReachabilityServiceClient.RerunConnectivityTestAsync(RerunConnectivityTestRequest, CallSettings)

UpdateConnectivityTest(UpdateConnectivityTestRequest, CallSettings)

public override Operation<ConnectivityTest, OperationMetadata> UpdateConnectivityTest(UpdateConnectivityTestRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationConnectivityTestOperationMetadata	The RPC response.

Overrides

ReachabilityServiceClient.UpdateConnectivityTest(UpdateConnectivityTestRequest, CallSettings)

UpdateConnectivityTestAsync(UpdateConnectivityTestRequest, CallSettings)

public override Task<Operation<ConnectivityTest, OperationMetadata>> UpdateConnectivityTestAsync(UpdateConnectivityTestRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationConnectivityTestOperationMetadata	A Task containing the RPC response.

Overrides

ReachabilityServiceClient.UpdateConnectivityTestAsync(UpdateConnectivityTestRequest, CallSettings)