Network Management v1 API - Class ReachabilityServiceClient (2.3.0)

public abstract class ReachabilityServiceClient

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

ReachabilityService client wrapper, for convenient use.

Inheritance

Object > ReachabilityServiceClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

ReachabilityServiceClientImpl

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.

Properties

CreateConnectivityTestOperationsClient

public virtual OperationsClient CreateConnectivityTestOperationsClient { get; }

The long-running operations client for CreateConnectivityTest.

Property Value
Type	Description
`OperationsClient`

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ReachabilityService service, which is a host of "networkmanagement.googleapis.com" and a port of 443.

Property Value
Type	Description
`String`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ReachabilityService scopes.

Property Value
Type	Description
`IReadOnlyList<String>`

Remarks

The default ReachabilityService scopes are:

https://www.googleapis.com/auth/cloud-platform

DeleteConnectivityTestOperationsClient

public virtual OperationsClient DeleteConnectivityTestOperationsClient { get; }

The long-running operations client for DeleteConnectivityTest.

Property Value
Type	Description
`OperationsClient`

GrpcClient

public virtual ReachabilityService.ReachabilityServiceClient GrpcClient { get; }

The underlying gRPC ReachabilityService client

Property Value
Type	Description
`ReachabilityService.ReachabilityServiceClient`

RerunConnectivityTestOperationsClient

public virtual OperationsClient RerunConnectivityTestOperationsClient { get; }

The long-running operations client for RerunConnectivityTest.

Property Value
Type	Description
`OperationsClient`

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
`ServiceMetadata`

UpdateConnectivityTestOperationsClient

public virtual OperationsClient UpdateConnectivityTestOperationsClient { get; }

The long-running operations client for UpdateConnectivityTest.

Property Value
Type	Description
`OperationsClient`

Methods

Create()

public static ReachabilityServiceClient Create()

Synchronously creates a ReachabilityServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ReachabilityServiceClientBuilder.

Returns
Type	Description
`ReachabilityServiceClient`	The created ReachabilityServiceClient.

CreateAsync(CancellationToken)

public static Task<ReachabilityServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a ReachabilityServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ReachabilityServiceClientBuilder.

Parameter
Name	Description
`cancellationToken`	`CancellationToken` The CancellationToken to use while creating the client.

Returns
Type	Description
`Task<ReachabilityServiceClient>`	The task representing the created ReachabilityServiceClient.

CreateConnectivityTest(CreateConnectivityTestRequest, CallSettings)

public virtual 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
`Operation<ConnectivityTest, OperationMetadata>`	The RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.Create();
// Initialize request argument(s)
CreateConnectivityTestRequest request = new CreateConnectivityTestRequest
{
    Parent = "",
    TestId = "",
    Resource = new ConnectivityTest(),
};
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = reachabilityServiceClient.CreateConnectivityTest(request);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = reachabilityServiceClient.PollOnceCreateConnectivityTest(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

CreateConnectivityTest(String, String, ConnectivityTest, CallSettings)

public virtual Operation<ConnectivityTest, OperationMetadata> CreateConnectivityTest(string parent, string testId, ConnectivityTest resource, 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 incomplete, the reachability result returns a value of <code>AMBIGUOUS</code>. For more information, see the Connectivity Test documentation.

Parameters
Name	Description
`parent`	`String` Required. The parent resource of the Connectivity Test to create: `projects/{project_id}/locations/global`
`testId`	`String` Required. The logical name of the Connectivity Test in your project with the following restrictions: Must contain only lowercase letters, numbers, and hyphens. Must start with a letter. Must be between 1-40 characters. Must end with a number or a letter. Must be unique within the customer project
`resource`	`ConnectivityTest` Required. A `ConnectivityTest` resource
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<ConnectivityTest, OperationMetadata>`	The RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.Create();
// Initialize request argument(s)
string parent = "";
string testId = "";
ConnectivityTest resource = new ConnectivityTest();
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = reachabilityServiceClient.CreateConnectivityTest(parent, testId, resource);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = reachabilityServiceClient.PollOnceCreateConnectivityTest(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

CreateConnectivityTestAsync(CreateConnectivityTestRequest, CallSettings)

public virtual 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 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
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
CreateConnectivityTestRequest request = new CreateConnectivityTestRequest
{
    Parent = "",
    TestId = "",
    Resource = new ConnectivityTest(),
};
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = await reachabilityServiceClient.CreateConnectivityTestAsync(request);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceCreateConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

CreateConnectivityTestAsync(CreateConnectivityTestRequest, CancellationToken)

public virtual Task<Operation<ConnectivityTest, OperationMetadata>> CreateConnectivityTestAsync(CreateConnectivityTestRequest request, CancellationToken cancellationToken)

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 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.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
CreateConnectivityTestRequest request = new CreateConnectivityTestRequest
{
    Parent = "",
    TestId = "",
    Resource = new ConnectivityTest(),
};
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = await reachabilityServiceClient.CreateConnectivityTestAsync(request);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceCreateConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

CreateConnectivityTestAsync(String, String, ConnectivityTest, CallSettings)

public virtual Task<Operation<ConnectivityTest, OperationMetadata>> CreateConnectivityTestAsync(string parent, string testId, ConnectivityTest resource, 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 incomplete, the reachability result returns a value of <code>AMBIGUOUS</code>. For more information, see the Connectivity Test documentation.

Parameters
Name	Description
`parent`	`String` Required. The parent resource of the Connectivity Test to create: `projects/{project_id}/locations/global`
`testId`	`String` Required. The logical name of the Connectivity Test in your project with the following restrictions: Must contain only lowercase letters, numbers, and hyphens. Must start with a letter. Must be between 1-40 characters. Must end with a number or a letter. Must be unique within the customer project
`resource`	`ConnectivityTest` Required. A `ConnectivityTest` resource
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
string testId = "";
ConnectivityTest resource = new ConnectivityTest();
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = await reachabilityServiceClient.CreateConnectivityTestAsync(parent, testId, resource);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceCreateConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

CreateConnectivityTestAsync(String, String, ConnectivityTest, CancellationToken)

public virtual Task<Operation<ConnectivityTest, OperationMetadata>> CreateConnectivityTestAsync(string parent, string testId, ConnectivityTest resource, CancellationToken cancellationToken)

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 incomplete, the reachability result returns a value of <code>AMBIGUOUS</code>. For more information, see the Connectivity Test documentation.

Parameters
Name	Description
`parent`	`String` Required. The parent resource of the Connectivity Test to create: `projects/{project_id}/locations/global`
`testId`	`String` Required. The logical name of the Connectivity Test in your project with the following restrictions: Must contain only lowercase letters, numbers, and hyphens. Must start with a letter. Must be between 1-40 characters. Must end with a number or a letter. Must be unique within the customer project
`resource`	`ConnectivityTest` Required. A `ConnectivityTest` resource
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
string testId = "";
ConnectivityTest resource = new ConnectivityTest();
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = await reachabilityServiceClient.CreateConnectivityTestAsync(parent, testId, resource);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceCreateConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

DeleteConnectivityTest(DeleteConnectivityTestRequest, CallSettings)

public virtual 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
`Operation<Empty, OperationMetadata>`	The RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.Create();
// Initialize request argument(s)
DeleteConnectivityTestRequest request = new DeleteConnectivityTestRequest { Name = "", };
// Make the request
Operation<Empty, OperationMetadata> response = reachabilityServiceClient.DeleteConnectivityTest(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = reachabilityServiceClient.PollOnceDeleteConnectivityTest(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConnectivityTest(String, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteConnectivityTest(string name, CallSettings callSettings = null)

Deletes a specific ConnectivityTest.

Parameters
Name	Description
`name`	`String` Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, OperationMetadata>`	The RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.Create();
// Initialize request argument(s)
string name = "";
// Make the request
Operation<Empty, OperationMetadata> response = reachabilityServiceClient.DeleteConnectivityTest(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = reachabilityServiceClient.PollOnceDeleteConnectivityTest(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConnectivityTestAsync(DeleteConnectivityTestRequest, CallSettings)

public virtual 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
`Task<Operation<Empty, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteConnectivityTestRequest request = new DeleteConnectivityTestRequest { Name = "", };
// Make the request
Operation<Empty, OperationMetadata> response = await reachabilityServiceClient.DeleteConnectivityTestAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceDeleteConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConnectivityTestAsync(DeleteConnectivityTestRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteConnectivityTestAsync(DeleteConnectivityTestRequest request, CancellationToken cancellationToken)

Deletes a specific ConnectivityTest.

Parameters
Name	Description
`request`	`DeleteConnectivityTestRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<Empty, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteConnectivityTestRequest request = new DeleteConnectivityTestRequest { Name = "", };
// Make the request
Operation<Empty, OperationMetadata> response = await reachabilityServiceClient.DeleteConnectivityTestAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceDeleteConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConnectivityTestAsync(String, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteConnectivityTestAsync(string name, CallSettings callSettings = null)

Deletes a specific ConnectivityTest.

Parameters
Name	Description
`name`	`String` Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Operation<Empty, OperationMetadata> response = await reachabilityServiceClient.DeleteConnectivityTestAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceDeleteConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteConnectivityTestAsync(String, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteConnectivityTestAsync(string name, CancellationToken cancellationToken)

Deletes a specific ConnectivityTest.

Parameters
Name	Description
`name`	`String` Required. Connectivity Test resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}`
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<Empty, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
Operation<Empty, OperationMetadata> response = await reachabilityServiceClient.DeleteConnectivityTestAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceDeleteConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

GetConnectivityTest(GetConnectivityTestRequest, CallSettings)

public virtual 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.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.Create();
// Initialize request argument(s)
GetConnectivityTestRequest request = new GetConnectivityTestRequest { Name = "", };
// Make the request
ConnectivityTest response = reachabilityServiceClient.GetConnectivityTest(request);

GetConnectivityTest(String, CallSettings)

public virtual ConnectivityTest GetConnectivityTest(string name, CallSettings callSettings = null)

Gets the details of a specific Connectivity Test.

Parameters
Name	Description
`name`	`String` Required. `ConnectivityTest` resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ConnectivityTest`	The RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.Create();
// Initialize request argument(s)
string name = "";
// Make the request
ConnectivityTest response = reachabilityServiceClient.GetConnectivityTest(name);

GetConnectivityTestAsync(GetConnectivityTestRequest, CallSettings)

public virtual 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
`Task<ConnectivityTest>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
GetConnectivityTestRequest request = new GetConnectivityTestRequest { Name = "", };
// Make the request
ConnectivityTest response = await reachabilityServiceClient.GetConnectivityTestAsync(request);

GetConnectivityTestAsync(GetConnectivityTestRequest, CancellationToken)

public virtual Task<ConnectivityTest> GetConnectivityTestAsync(GetConnectivityTestRequest request, CancellationToken cancellationToken)

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.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<ConnectivityTest>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
GetConnectivityTestRequest request = new GetConnectivityTestRequest { Name = "", };
// Make the request
ConnectivityTest response = await reachabilityServiceClient.GetConnectivityTestAsync(request);

GetConnectivityTestAsync(String, CallSettings)

public virtual Task<ConnectivityTest> GetConnectivityTestAsync(string name, CallSettings callSettings = null)

Gets the details of a specific Connectivity Test.

Parameters
Name	Description
`name`	`String` Required. `ConnectivityTest` resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}`
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<ConnectivityTest>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
ConnectivityTest response = await reachabilityServiceClient.GetConnectivityTestAsync(name);

GetConnectivityTestAsync(String, CancellationToken)

public virtual Task<ConnectivityTest> GetConnectivityTestAsync(string name, CancellationToken cancellationToken)

Gets the details of a specific Connectivity Test.

Parameters
Name	Description
`name`	`String` Required. `ConnectivityTest` resource name using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}`
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<ConnectivityTest>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "";
// Make the request
ConnectivityTest response = await reachabilityServiceClient.GetConnectivityTestAsync(name);

ListConnectivityTests(ListConnectivityTestsRequest, CallSettings)

public virtual 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
`PagedEnumerable<ListConnectivityTestsResponse, ConnectivityTest>`	A pageable sequence of ConnectivityTest resources.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.Create();
// Initialize request argument(s)
ListConnectivityTestsRequest request = new ListConnectivityTestsRequest
{
    Parent = "",
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListConnectivityTestsResponse, ConnectivityTest> response = reachabilityServiceClient.ListConnectivityTests(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ConnectivityTest item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListConnectivityTestsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConnectivityTest item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ConnectivityTest> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ConnectivityTest item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListConnectivityTests(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListConnectivityTestsResponse, ConnectivityTest> ListConnectivityTests(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all Connectivity Tests owned by a project.

Parameters
Name	Description
`parent`	`String` Required. The parent resource of the Connectivity Tests: `projects/{project_id}/locations/global`
`pageToken`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListConnectivityTestsResponse, ConnectivityTest>`	A pageable sequence of ConnectivityTest resources.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.Create();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedEnumerable<ListConnectivityTestsResponse, ConnectivityTest> response = reachabilityServiceClient.ListConnectivityTests(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ConnectivityTest item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListConnectivityTestsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConnectivityTest item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ConnectivityTest> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ConnectivityTest item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListConnectivityTestsAsync(ListConnectivityTestsRequest, CallSettings)

public virtual 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
`PagedAsyncEnumerable<ListConnectivityTestsResponse, ConnectivityTest>`	A pageable asynchronous sequence of ConnectivityTest resources.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
ListConnectivityTestsRequest request = new ListConnectivityTestsRequest
{
    Parent = "",
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListConnectivityTestsResponse, ConnectivityTest> response = reachabilityServiceClient.ListConnectivityTestsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ConnectivityTest item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListConnectivityTestsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConnectivityTest item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ConnectivityTest> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ConnectivityTest item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListConnectivityTestsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListConnectivityTestsResponse, ConnectivityTest> ListConnectivityTestsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all Connectivity Tests owned by a project.

Parameters
Name	Description
`parent`	`String` Required. The parent resource of the Connectivity Tests: `projects/{project_id}/locations/global`
`pageToken`	`String` The token returned from the previous request. A value of `null` or an empty string retrieves the first page.
`pageSize`	`Nullable<Int32>` The size of page to request. The response will not be larger than this, but may be smaller. A value of `null` or `0` uses a server-defined page size.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListConnectivityTestsResponse, ConnectivityTest>`	A pageable asynchronous sequence of ConnectivityTest resources.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "";
// Make the request
PagedAsyncEnumerable<ListConnectivityTestsResponse, ConnectivityTest> response = reachabilityServiceClient.ListConnectivityTestsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ConnectivityTest item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListConnectivityTestsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ConnectivityTest item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ConnectivityTest> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ConnectivityTest item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateConnectivityTest(String, CallSettings)

public virtual Operation<ConnectivityTest, OperationMetadata> PollOnceCreateConnectivityTest(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateConnectivityTest.

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<ConnectivityTest, OperationMetadata>`	The result of polling the operation.

PollOnceCreateConnectivityTestAsync(String, CallSettings)

public virtual Task<Operation<ConnectivityTest, OperationMetadata>> PollOnceCreateConnectivityTestAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateConnectivityTest.

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A task representing the result of polling the operation.

PollOnceDeleteConnectivityTest(String, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteConnectivityTest(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteConnectivityTest.

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, OperationMetadata>`	The result of polling the operation.

PollOnceDeleteConnectivityTestAsync(String, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteConnectivityTestAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteConnectivityTest.

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, OperationMetadata>>`	A task representing the result of polling the operation.

PollOnceRerunConnectivityTest(String, CallSettings)

public virtual Operation<ConnectivityTest, OperationMetadata> PollOnceRerunConnectivityTest(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of RerunConnectivityTest .

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<ConnectivityTest, OperationMetadata>`	The result of polling the operation.

PollOnceRerunConnectivityTestAsync(String, CallSettings)

public virtual Task<Operation<ConnectivityTest, OperationMetadata>> PollOnceRerunConnectivityTestAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of RerunConnectivityTest.

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A task representing the result of polling the operation.

PollOnceUpdateConnectivityTest(String, CallSettings)

public virtual Operation<ConnectivityTest, OperationMetadata> PollOnceUpdateConnectivityTest(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateConnectivityTest.

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<ConnectivityTest, OperationMetadata>`	The result of polling the operation.

PollOnceUpdateConnectivityTestAsync(String, CallSettings)

public virtual Task<Operation<ConnectivityTest, OperationMetadata>> PollOnceUpdateConnectivityTestAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateConnectivityTest.

Parameters
Name	Description
`operationName`	`String` The name of a previously invoked operation. Must not be `null` or empty.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A task representing the result of polling the operation.

RerunConnectivityTest(RerunConnectivityTestRequest, CallSettings)

public virtual 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
`Operation<ConnectivityTest, OperationMetadata>`	The RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.Create();
// Initialize request argument(s)
RerunConnectivityTestRequest request = new RerunConnectivityTestRequest { Name = "", };
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = reachabilityServiceClient.RerunConnectivityTest(request);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = reachabilityServiceClient.PollOnceRerunConnectivityTest(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

RerunConnectivityTestAsync(RerunConnectivityTestRequest, CallSettings)

public virtual 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.

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
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
RerunConnectivityTestRequest request = new RerunConnectivityTestRequest { Name = "", };
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = await reachabilityServiceClient.RerunConnectivityTestAsync(request);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceRerunConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

RerunConnectivityTestAsync(RerunConnectivityTestRequest, CancellationToken)

public virtual Task<Operation<ConnectivityTest, OperationMetadata>> RerunConnectivityTestAsync(RerunConnectivityTestRequest request, CancellationToken cancellationToken)

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.

Parameters
Name	Description
`request`	`RerunConnectivityTestRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
RerunConnectivityTestRequest request = new RerunConnectivityTestRequest { Name = "", };
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = await reachabilityServiceClient.RerunConnectivityTestAsync(request);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceRerunConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
`Task`	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateConnectivityTest(UpdateConnectivityTestRequest, CallSettings)

public virtual 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
`Operation<ConnectivityTest, OperationMetadata>`	The RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.Create();
// Initialize request argument(s)
UpdateConnectivityTestRequest request = new UpdateConnectivityTestRequest
{
    UpdateMask = new FieldMask(),
    Resource = new ConnectivityTest(),
};
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = reachabilityServiceClient.UpdateConnectivityTest(request);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = reachabilityServiceClient.PollOnceUpdateConnectivityTest(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

UpdateConnectivityTest(FieldMask, ConnectivityTest, CallSettings)

public virtual Operation<ConnectivityTest, OperationMetadata> UpdateConnectivityTest(FieldMask updateMask, ConnectivityTest resource, CallSettings callSettings = null)

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
`updateMask`	`FieldMask` Required. Mask of fields to update. At least one path must be supplied in this field.
`resource`	`ConnectivityTest` Required. Only fields specified in update_mask are updated.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<ConnectivityTest, OperationMetadata>`	The RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = ReachabilityServiceClient.Create();
// Initialize request argument(s)
FieldMask updateMask = new FieldMask();
ConnectivityTest resource = new ConnectivityTest();
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = reachabilityServiceClient.UpdateConnectivityTest(updateMask, resource);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = reachabilityServiceClient.PollOnceUpdateConnectivityTest(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

UpdateConnectivityTestAsync(UpdateConnectivityTestRequest, CallSettings)

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

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
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateConnectivityTestRequest request = new UpdateConnectivityTestRequest
{
    UpdateMask = new FieldMask(),
    Resource = new ConnectivityTest(),
};
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = await reachabilityServiceClient.UpdateConnectivityTestAsync(request);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceUpdateConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

UpdateConnectivityTestAsync(UpdateConnectivityTestRequest, CancellationToken)

public virtual Task<Operation<ConnectivityTest, OperationMetadata>> UpdateConnectivityTestAsync(UpdateConnectivityTestRequest request, CancellationToken cancellationToken)

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.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateConnectivityTestRequest request = new UpdateConnectivityTestRequest
{
    UpdateMask = new FieldMask(),
    Resource = new ConnectivityTest(),
};
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = await reachabilityServiceClient.UpdateConnectivityTestAsync(request);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceUpdateConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

UpdateConnectivityTestAsync(FieldMask, ConnectivityTest, CallSettings)

public virtual Task<Operation<ConnectivityTest, OperationMetadata>> UpdateConnectivityTestAsync(FieldMask updateMask, ConnectivityTest resource, CallSettings callSettings = null)

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
`updateMask`	`FieldMask` Required. Mask of fields to update. At least one path must be supplied in this field.
`resource`	`ConnectivityTest` Required. Only fields specified in update_mask are updated.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
FieldMask updateMask = new FieldMask();
ConnectivityTest resource = new ConnectivityTest();
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = await reachabilityServiceClient.UpdateConnectivityTestAsync(updateMask, resource);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceUpdateConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}

UpdateConnectivityTestAsync(FieldMask, ConnectivityTest, CancellationToken)

public virtual Task<Operation<ConnectivityTest, OperationMetadata>> UpdateConnectivityTestAsync(FieldMask updateMask, ConnectivityTest resource, CancellationToken cancellationToken)

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
`updateMask`	`FieldMask` Required. Mask of fields to update. At least one path must be supplied in this field.
`resource`	`ConnectivityTest` Required. Only fields specified in update_mask are updated.
`cancellationToken`	`CancellationToken` A CancellationToken to use for this RPC.

Returns
Type	Description
`Task<Operation<ConnectivityTest, OperationMetadata>>`	A Task containing the RPC response.

Example

// Create client
ReachabilityServiceClient reachabilityServiceClient = await ReachabilityServiceClient.CreateAsync();
// Initialize request argument(s)
FieldMask updateMask = new FieldMask();
ConnectivityTest resource = new ConnectivityTest();
// Make the request
Operation<ConnectivityTest, OperationMetadata> response = await reachabilityServiceClient.UpdateConnectivityTestAsync(updateMask, resource);

// Poll until the returned long-running operation is complete
Operation<ConnectivityTest, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ConnectivityTest result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ConnectivityTest, OperationMetadata> retrievedResponse = await reachabilityServiceClient.PollOnceUpdateConnectivityTestAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ConnectivityTest retrievedResult = retrievedResponse.Result;
}