BeyondCorp AppConnections v1 API - Class AppConnectionsServiceClient (1.3.0)

public abstract class AppConnectionsServiceClient

Reference documentation and code samples for the BeyondCorp AppConnections v1 API class AppConnectionsServiceClient.

AppConnectionsService client wrapper, for convenient use.

Inheritance

object > AppConnectionsServiceClient

Namespace

Google.Cloud.BeyondCorp.AppConnections.V1

Assembly

Google.Cloud.BeyondCorp.AppConnections.V1.dll

Remarks

API Overview:

The beyondcorp.googleapis.com service implements the Google Cloud BeyondCorp API.

Data Model:

The AppConnectionsService exposes the following resources:

  • AppConnections, named as follows: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}.

The AppConnectionsService service provides methods to manage (create/read/update/delete) BeyondCorp AppConnections.

Properties

CreateAppConnectionOperationsClient

public virtual OperationsClient CreateAppConnectionOperationsClient { get; }

The long-running operations client for CreateAppConnection.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default AppConnectionsService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default AppConnectionsService scopes are:

DeleteAppConnectionOperationsClient

public virtual OperationsClient DeleteAppConnectionOperationsClient { get; }

The long-running operations client for DeleteAppConnection.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual AppConnectionsService.AppConnectionsServiceClient GrpcClient { get; }

The underlying gRPC AppConnectionsService client

Property Value
Type Description
AppConnectionsServiceAppConnectionsServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

UpdateAppConnectionOperationsClient

public virtual OperationsClient UpdateAppConnectionOperationsClient { get; }

The long-running operations client for UpdateAppConnection.

Property Value
Type Description
OperationsClient

Methods

Create()

public static AppConnectionsServiceClient Create()

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

Returns
Type Description
AppConnectionsServiceClient

The created AppConnectionsServiceClient.

CreateAppConnection(LocationName, AppConnection, string, CallSettings)

public virtual Operation<AppConnection, AppConnectionOperationMetadata> CreateAppConnection(LocationName parent, AppConnection appConnection, string appConnectionId, CallSettings callSettings = null)

Creates a new AppConnection in a given project and location.

Parameters
Name Description
parent LocationName

Required. The resource project name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

appConnection AppConnection

Required. A BeyondCorp AppConnection resource.

appConnectionId string

Optional. User-settable AppConnection resource ID.

  • Must start with a letter.
  • Must contain between 4-63 characters from /[a-z][0-9]-/.
  • Must end with a number or a letter.
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAppConnectionAppConnectionOperationMetadata

The RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AppConnection appConnection = new AppConnection();
string appConnectionId = "";
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = appConnectionsServiceClient.CreateAppConnection(parent, appConnection, appConnectionId);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = appConnectionsServiceClient.PollOnceCreateAppConnection(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

CreateAppConnection(CreateAppConnectionRequest, CallSettings)

public virtual Operation<AppConnection, AppConnectionOperationMetadata> CreateAppConnection(CreateAppConnectionRequest request, CallSettings callSettings = null)

Creates a new AppConnection in a given project and location.

Parameters
Name Description
request CreateAppConnectionRequest

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
OperationAppConnectionAppConnectionOperationMetadata

The RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
CreateAppConnectionRequest request = new CreateAppConnectionRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AppConnectionId = "",
    AppConnection = new AppConnection(),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = appConnectionsServiceClient.CreateAppConnection(request);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = appConnectionsServiceClient.PollOnceCreateAppConnection(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

CreateAppConnection(string, AppConnection, string, CallSettings)

public virtual Operation<AppConnection, AppConnectionOperationMetadata> CreateAppConnection(string parent, AppConnection appConnection, string appConnectionId, CallSettings callSettings = null)

Creates a new AppConnection in a given project and location.

Parameters
Name Description
parent string

Required. The resource project name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

appConnection AppConnection

Required. A BeyondCorp AppConnection resource.

appConnectionId string

Optional. User-settable AppConnection resource ID.

  • Must start with a letter.
  • Must contain between 4-63 characters from /[a-z][0-9]-/.
  • Must end with a number or a letter.
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAppConnectionAppConnectionOperationMetadata

The RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AppConnection appConnection = new AppConnection();
string appConnectionId = "";
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = appConnectionsServiceClient.CreateAppConnection(parent, appConnection, appConnectionId);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = appConnectionsServiceClient.PollOnceCreateAppConnection(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

CreateAppConnectionAsync(LocationName, AppConnection, string, CallSettings)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> CreateAppConnectionAsync(LocationName parent, AppConnection appConnection, string appConnectionId, CallSettings callSettings = null)

Creates a new AppConnection in a given project and location.

Parameters
Name Description
parent LocationName

Required. The resource project name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

appConnection AppConnection

Required. A BeyondCorp AppConnection resource.

appConnectionId string

Optional. User-settable AppConnection resource ID.

  • Must start with a letter.
  • Must contain between 4-63 characters from /[a-z][0-9]-/.
  • Must end with a number or a letter.
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAppConnectionAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AppConnection appConnection = new AppConnection();
string appConnectionId = "";
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.CreateAppConnectionAsync(parent, appConnection, appConnectionId);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceCreateAppConnectionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

CreateAppConnectionAsync(LocationName, AppConnection, string, CancellationToken)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> CreateAppConnectionAsync(LocationName parent, AppConnection appConnection, string appConnectionId, CancellationToken cancellationToken)

Creates a new AppConnection in a given project and location.

Parameters
Name Description
parent LocationName

Required. The resource project name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

appConnection AppConnection

Required. A BeyondCorp AppConnection resource.

appConnectionId string

Optional. User-settable AppConnection resource ID.

  • Must start with a letter.
  • Must contain between 4-63 characters from /[a-z][0-9]-/.
  • Must end with a number or a letter.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAppConnectionAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AppConnection appConnection = new AppConnection();
string appConnectionId = "";
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.CreateAppConnectionAsync(parent, appConnection, appConnectionId);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceCreateAppConnectionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

CreateAppConnectionAsync(CreateAppConnectionRequest, CallSettings)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> CreateAppConnectionAsync(CreateAppConnectionRequest request, CallSettings callSettings = null)

Creates a new AppConnection in a given project and location.

Parameters
Name Description
request CreateAppConnectionRequest

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
TaskOperationAppConnectionAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateAppConnectionRequest request = new CreateAppConnectionRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AppConnectionId = "",
    AppConnection = new AppConnection(),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.CreateAppConnectionAsync(request);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceCreateAppConnectionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

CreateAppConnectionAsync(CreateAppConnectionRequest, CancellationToken)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> CreateAppConnectionAsync(CreateAppConnectionRequest request, CancellationToken cancellationToken)

Creates a new AppConnection in a given project and location.

Parameters
Name Description
request CreateAppConnectionRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAppConnectionAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateAppConnectionRequest request = new CreateAppConnectionRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AppConnectionId = "",
    AppConnection = new AppConnection(),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.CreateAppConnectionAsync(request);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceCreateAppConnectionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

CreateAppConnectionAsync(string, AppConnection, string, CallSettings)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> CreateAppConnectionAsync(string parent, AppConnection appConnection, string appConnectionId, CallSettings callSettings = null)

Creates a new AppConnection in a given project and location.

Parameters
Name Description
parent string

Required. The resource project name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

appConnection AppConnection

Required. A BeyondCorp AppConnection resource.

appConnectionId string

Optional. User-settable AppConnection resource ID.

  • Must start with a letter.
  • Must contain between 4-63 characters from /[a-z][0-9]-/.
  • Must end with a number or a letter.
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAppConnectionAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AppConnection appConnection = new AppConnection();
string appConnectionId = "";
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.CreateAppConnectionAsync(parent, appConnection, appConnectionId);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceCreateAppConnectionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

CreateAppConnectionAsync(string, AppConnection, string, CancellationToken)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> CreateAppConnectionAsync(string parent, AppConnection appConnection, string appConnectionId, CancellationToken cancellationToken)

Creates a new AppConnection in a given project and location.

Parameters
Name Description
parent string

Required. The resource project name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

appConnection AppConnection

Required. A BeyondCorp AppConnection resource.

appConnectionId string

Optional. User-settable AppConnection resource ID.

  • Must start with a letter.
  • Must contain between 4-63 characters from /[a-z][0-9]-/.
  • Must end with a number or a letter.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAppConnectionAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AppConnection appConnection = new AppConnection();
string appConnectionId = "";
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.CreateAppConnectionAsync(parent, appConnection, appConnectionId);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceCreateAppConnectionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskAppConnectionsServiceClient

The task representing the created AppConnectionsServiceClient.

DeleteAppConnection(AppConnectionName, CallSettings)

public virtual Operation<Empty, AppConnectionOperationMetadata> DeleteAppConnection(AppConnectionName name, CallSettings callSettings = null)

Deletes a single AppConnection.

Parameters
Name Description
name AppConnectionName

Required. BeyondCorp Connector name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyAppConnectionOperationMetadata

The RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
AppConnectionName name = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]");
// Make the request
Operation<Empty, AppConnectionOperationMetadata> response = appConnectionsServiceClient.DeleteAppConnection(name);

// Poll until the returned long-running operation is complete
Operation<Empty, AppConnectionOperationMetadata> 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, AppConnectionOperationMetadata> retrievedResponse = appConnectionsServiceClient.PollOnceDeleteAppConnection(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;
}

DeleteAppConnection(DeleteAppConnectionRequest, CallSettings)

public virtual Operation<Empty, AppConnectionOperationMetadata> DeleteAppConnection(DeleteAppConnectionRequest request, CallSettings callSettings = null)

Deletes a single AppConnection.

Parameters
Name Description
request DeleteAppConnectionRequest

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
OperationEmptyAppConnectionOperationMetadata

The RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
DeleteAppConnectionRequest request = new DeleteAppConnectionRequest
{
    AppConnectionName = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]"),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<Empty, AppConnectionOperationMetadata> response = appConnectionsServiceClient.DeleteAppConnection(request);

// Poll until the returned long-running operation is complete
Operation<Empty, AppConnectionOperationMetadata> 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, AppConnectionOperationMetadata> retrievedResponse = appConnectionsServiceClient.PollOnceDeleteAppConnection(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;
}

DeleteAppConnection(string, CallSettings)

public virtual Operation<Empty, AppConnectionOperationMetadata> DeleteAppConnection(string name, CallSettings callSettings = null)

Deletes a single AppConnection.

Parameters
Name Description
name string

Required. BeyondCorp Connector name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyAppConnectionOperationMetadata

The RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appConnections/[APP_CONNECTION]";
// Make the request
Operation<Empty, AppConnectionOperationMetadata> response = appConnectionsServiceClient.DeleteAppConnection(name);

// Poll until the returned long-running operation is complete
Operation<Empty, AppConnectionOperationMetadata> 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, AppConnectionOperationMetadata> retrievedResponse = appConnectionsServiceClient.PollOnceDeleteAppConnection(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;
}

DeleteAppConnectionAsync(AppConnectionName, CallSettings)

public virtual Task<Operation<Empty, AppConnectionOperationMetadata>> DeleteAppConnectionAsync(AppConnectionName name, CallSettings callSettings = null)

Deletes a single AppConnection.

Parameters
Name Description
name AppConnectionName

Required. BeyondCorp Connector name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
AppConnectionName name = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]");
// Make the request
Operation<Empty, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.DeleteAppConnectionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, AppConnectionOperationMetadata> 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, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceDeleteAppConnectionAsync(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;
}

DeleteAppConnectionAsync(AppConnectionName, CancellationToken)

public virtual Task<Operation<Empty, AppConnectionOperationMetadata>> DeleteAppConnectionAsync(AppConnectionName name, CancellationToken cancellationToken)

Deletes a single AppConnection.

Parameters
Name Description
name AppConnectionName

Required. BeyondCorp Connector name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
AppConnectionName name = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]");
// Make the request
Operation<Empty, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.DeleteAppConnectionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, AppConnectionOperationMetadata> 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, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceDeleteAppConnectionAsync(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;
}

DeleteAppConnectionAsync(DeleteAppConnectionRequest, CallSettings)

public virtual Task<Operation<Empty, AppConnectionOperationMetadata>> DeleteAppConnectionAsync(DeleteAppConnectionRequest request, CallSettings callSettings = null)

Deletes a single AppConnection.

Parameters
Name Description
request DeleteAppConnectionRequest

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
TaskOperationEmptyAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteAppConnectionRequest request = new DeleteAppConnectionRequest
{
    AppConnectionName = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]"),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<Empty, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.DeleteAppConnectionAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, AppConnectionOperationMetadata> 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, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceDeleteAppConnectionAsync(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;
}

DeleteAppConnectionAsync(DeleteAppConnectionRequest, CancellationToken)

public virtual Task<Operation<Empty, AppConnectionOperationMetadata>> DeleteAppConnectionAsync(DeleteAppConnectionRequest request, CancellationToken cancellationToken)

Deletes a single AppConnection.

Parameters
Name Description
request DeleteAppConnectionRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteAppConnectionRequest request = new DeleteAppConnectionRequest
{
    AppConnectionName = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]"),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<Empty, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.DeleteAppConnectionAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, AppConnectionOperationMetadata> 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, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceDeleteAppConnectionAsync(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;
}

DeleteAppConnectionAsync(string, CallSettings)

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

Deletes a single AppConnection.

Parameters
Name Description
name string

Required. BeyondCorp Connector name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appConnections/[APP_CONNECTION]";
// Make the request
Operation<Empty, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.DeleteAppConnectionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, AppConnectionOperationMetadata> 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, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceDeleteAppConnectionAsync(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;
}

DeleteAppConnectionAsync(string, CancellationToken)

public virtual Task<Operation<Empty, AppConnectionOperationMetadata>> DeleteAppConnectionAsync(string name, CancellationToken cancellationToken)

Deletes a single AppConnection.

Parameters
Name Description
name string

Required. BeyondCorp Connector name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appConnections/[APP_CONNECTION]";
// Make the request
Operation<Empty, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.DeleteAppConnectionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, AppConnectionOperationMetadata> 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, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceDeleteAppConnectionAsync(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;
}

GetAppConnection(AppConnectionName, CallSettings)

public virtual AppConnection GetAppConnection(AppConnectionName name, CallSettings callSettings = null)

Gets details of a single AppConnection.

Parameters
Name Description
name AppConnectionName

Required. BeyondCorp AppConnection name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AppConnection

The RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
AppConnectionName name = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]");
// Make the request
AppConnection response = appConnectionsServiceClient.GetAppConnection(name);

GetAppConnection(GetAppConnectionRequest, CallSettings)

public virtual AppConnection GetAppConnection(GetAppConnectionRequest request, CallSettings callSettings = null)

Gets details of a single AppConnection.

Parameters
Name Description
request GetAppConnectionRequest

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
AppConnection

The RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
GetAppConnectionRequest request = new GetAppConnectionRequest
{
    AppConnectionName = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]"),
};
// Make the request
AppConnection response = appConnectionsServiceClient.GetAppConnection(request);

GetAppConnection(string, CallSettings)

public virtual AppConnection GetAppConnection(string name, CallSettings callSettings = null)

Gets details of a single AppConnection.

Parameters
Name Description
name string

Required. BeyondCorp AppConnection name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AppConnection

The RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appConnections/[APP_CONNECTION]";
// Make the request
AppConnection response = appConnectionsServiceClient.GetAppConnection(name);

GetAppConnectionAsync(AppConnectionName, CallSettings)

public virtual Task<AppConnection> GetAppConnectionAsync(AppConnectionName name, CallSettings callSettings = null)

Gets details of a single AppConnection.

Parameters
Name Description
name AppConnectionName

Required. BeyondCorp AppConnection name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAppConnection

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
AppConnectionName name = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]");
// Make the request
AppConnection response = await appConnectionsServiceClient.GetAppConnectionAsync(name);

GetAppConnectionAsync(AppConnectionName, CancellationToken)

public virtual Task<AppConnection> GetAppConnectionAsync(AppConnectionName name, CancellationToken cancellationToken)

Gets details of a single AppConnection.

Parameters
Name Description
name AppConnectionName

Required. BeyondCorp AppConnection name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAppConnection

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
AppConnectionName name = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]");
// Make the request
AppConnection response = await appConnectionsServiceClient.GetAppConnectionAsync(name);

GetAppConnectionAsync(GetAppConnectionRequest, CallSettings)

public virtual Task<AppConnection> GetAppConnectionAsync(GetAppConnectionRequest request, CallSettings callSettings = null)

Gets details of a single AppConnection.

Parameters
Name Description
request GetAppConnectionRequest

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
TaskAppConnection

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
GetAppConnectionRequest request = new GetAppConnectionRequest
{
    AppConnectionName = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]"),
};
// Make the request
AppConnection response = await appConnectionsServiceClient.GetAppConnectionAsync(request);

GetAppConnectionAsync(GetAppConnectionRequest, CancellationToken)

public virtual Task<AppConnection> GetAppConnectionAsync(GetAppConnectionRequest request, CancellationToken cancellationToken)

Gets details of a single AppConnection.

Parameters
Name Description
request GetAppConnectionRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAppConnection

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
GetAppConnectionRequest request = new GetAppConnectionRequest
{
    AppConnectionName = AppConnectionName.FromProjectLocationAppConnection("[PROJECT]", "[LOCATION]", "[APP_CONNECTION]"),
};
// Make the request
AppConnection response = await appConnectionsServiceClient.GetAppConnectionAsync(request);

GetAppConnectionAsync(string, CallSettings)

public virtual Task<AppConnection> GetAppConnectionAsync(string name, CallSettings callSettings = null)

Gets details of a single AppConnection.

Parameters
Name Description
name string

Required. BeyondCorp AppConnection name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAppConnection

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appConnections/[APP_CONNECTION]";
// Make the request
AppConnection response = await appConnectionsServiceClient.GetAppConnectionAsync(name);

GetAppConnectionAsync(string, CancellationToken)

public virtual Task<AppConnection> GetAppConnectionAsync(string name, CancellationToken cancellationToken)

Gets details of a single AppConnection.

Parameters
Name Description
name string

Required. BeyondCorp AppConnection name using the form: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAppConnection

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appConnections/[APP_CONNECTION]";
// Make the request
AppConnection response = await appConnectionsServiceClient.GetAppConnectionAsync(name);

ListAppConnections(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListAppConnectionsResponse, AppConnection> ListAppConnections(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists AppConnections in a given project and location.

Parameters
Name Description
parent LocationName

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListAppConnectionsResponseAppConnection

A pageable sequence of AppConnection resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListAppConnectionsResponse, AppConnection> response = appConnectionsServiceClient.ListAppConnections(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AppConnection 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 (ListAppConnectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppConnection 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<AppConnection> 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 (AppConnection 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;

ListAppConnections(ListAppConnectionsRequest, CallSettings)

public virtual PagedEnumerable<ListAppConnectionsResponse, AppConnection> ListAppConnections(ListAppConnectionsRequest request, CallSettings callSettings = null)

Lists AppConnections in a given project and location.

Parameters
Name Description
request ListAppConnectionsRequest

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
PagedEnumerableListAppConnectionsResponseAppConnection

A pageable sequence of AppConnection resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
ListAppConnectionsRequest request = new ListAppConnectionsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListAppConnectionsResponse, AppConnection> response = appConnectionsServiceClient.ListAppConnections(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (AppConnection 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 (ListAppConnectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppConnection 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<AppConnection> 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 (AppConnection 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;

ListAppConnections(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListAppConnectionsResponse, AppConnection> ListAppConnections(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists AppConnections in a given project and location.

Parameters
Name Description
parent string

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListAppConnectionsResponseAppConnection

A pageable sequence of AppConnection resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListAppConnectionsResponse, AppConnection> response = appConnectionsServiceClient.ListAppConnections(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (AppConnection 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 (ListAppConnectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppConnection 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<AppConnection> 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 (AppConnection 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;

ListAppConnectionsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAppConnectionsResponse, AppConnection> ListAppConnectionsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists AppConnections in a given project and location.

Parameters
Name Description
parent LocationName

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListAppConnectionsResponseAppConnection

A pageable asynchronous sequence of AppConnection resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListAppConnectionsResponse, AppConnection> response = appConnectionsServiceClient.ListAppConnectionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AppConnection 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((ListAppConnectionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppConnection 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<AppConnection> 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 (AppConnection 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;

ListAppConnectionsAsync(ListAppConnectionsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAppConnectionsResponse, AppConnection> ListAppConnectionsAsync(ListAppConnectionsRequest request, CallSettings callSettings = null)

Lists AppConnections in a given project and location.

Parameters
Name Description
request ListAppConnectionsRequest

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
PagedAsyncEnumerableListAppConnectionsResponseAppConnection

A pageable asynchronous sequence of AppConnection resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
ListAppConnectionsRequest request = new ListAppConnectionsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListAppConnectionsResponse, AppConnection> response = appConnectionsServiceClient.ListAppConnectionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AppConnection 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((ListAppConnectionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppConnection 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<AppConnection> 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 (AppConnection 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;

ListAppConnectionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAppConnectionsResponse, AppConnection> ListAppConnectionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists AppConnections in a given project and location.

Parameters
Name Description
parent string

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListAppConnectionsResponseAppConnection

A pageable asynchronous sequence of AppConnection resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListAppConnectionsResponse, AppConnection> response = appConnectionsServiceClient.ListAppConnectionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AppConnection 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((ListAppConnectionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AppConnection 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<AppConnection> 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 (AppConnection 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;

PollOnceCreateAppConnection(string, CallSettings)

public virtual Operation<AppConnection, AppConnectionOperationMetadata> PollOnceCreateAppConnection(string operationName, CallSettings callSettings = null)

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

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
OperationAppConnectionAppConnectionOperationMetadata

The result of polling the operation.

PollOnceCreateAppConnectionAsync(string, CallSettings)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> PollOnceCreateAppConnectionAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationAppConnectionAppConnectionOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteAppConnection(string, CallSettings)

public virtual Operation<Empty, AppConnectionOperationMetadata> PollOnceDeleteAppConnection(string operationName, CallSettings callSettings = null)

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

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
OperationEmptyAppConnectionOperationMetadata

The result of polling the operation.

PollOnceDeleteAppConnectionAsync(string, CallSettings)

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

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

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
TaskOperationEmptyAppConnectionOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateAppConnection(string, CallSettings)

public virtual Operation<AppConnection, AppConnectionOperationMetadata> PollOnceUpdateAppConnection(string operationName, CallSettings callSettings = null)

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

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
OperationAppConnectionAppConnectionOperationMetadata

The result of polling the operation.

PollOnceUpdateAppConnectionAsync(string, CallSettings)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> PollOnceUpdateAppConnectionAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationAppConnectionAppConnectionOperationMetadata

A task representing the result of polling the operation.

ResolveAppConnections(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> ResolveAppConnections(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Parameters
Name Description
parent LocationName

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableResolveAppConnectionsResponseResolveAppConnectionsResponseTypesAppConnectionDetails

A pageable sequence of ResolveAppConnectionsResponse.Types.AppConnectionDetails resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> response = appConnectionsServiceClient.ResolveAppConnections(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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 (ResolveAppConnectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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<ResolveAppConnectionsResponse.Types.AppConnectionDetails> 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 (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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;

ResolveAppConnections(ResolveAppConnectionsRequest, CallSettings)

public virtual PagedEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> ResolveAppConnections(ResolveAppConnectionsRequest request, CallSettings callSettings = null)

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Parameters
Name Description
request ResolveAppConnectionsRequest

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
PagedEnumerableResolveAppConnectionsResponseResolveAppConnectionsResponseTypesAppConnectionDetails

A pageable sequence of ResolveAppConnectionsResponse.Types.AppConnectionDetails resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
ResolveAppConnectionsRequest request = new ResolveAppConnectionsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AppConnectorIdAsAppConnectorName = AppConnectorName.FromProjectLocationAppConnector("[PROJECT]", "[LOCATION]", "[APP_CONNECTOR]"),
};
// Make the request
PagedEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> response = appConnectionsServiceClient.ResolveAppConnections(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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 (ResolveAppConnectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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<ResolveAppConnectionsResponse.Types.AppConnectionDetails> 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 (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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;

ResolveAppConnections(string, string, int?, CallSettings)

public virtual PagedEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> ResolveAppConnections(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Parameters
Name Description
parent string

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableResolveAppConnectionsResponseResolveAppConnectionsResponseTypesAppConnectionDetails

A pageable sequence of ResolveAppConnectionsResponse.Types.AppConnectionDetails resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> response = appConnectionsServiceClient.ResolveAppConnections(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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 (ResolveAppConnectionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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<ResolveAppConnectionsResponse.Types.AppConnectionDetails> 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 (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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;

ResolveAppConnectionsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> ResolveAppConnectionsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Parameters
Name Description
parent LocationName

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableResolveAppConnectionsResponseResolveAppConnectionsResponseTypesAppConnectionDetails

A pageable asynchronous sequence of ResolveAppConnectionsResponse.Types.AppConnectionDetails resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> response = appConnectionsServiceClient.ResolveAppConnectionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ResolveAppConnectionsResponse.Types.AppConnectionDetails 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((ResolveAppConnectionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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<ResolveAppConnectionsResponse.Types.AppConnectionDetails> 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 (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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;

ResolveAppConnectionsAsync(ResolveAppConnectionsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> ResolveAppConnectionsAsync(ResolveAppConnectionsRequest request, CallSettings callSettings = null)

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Parameters
Name Description
request ResolveAppConnectionsRequest

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
PagedAsyncEnumerableResolveAppConnectionsResponseResolveAppConnectionsResponseTypesAppConnectionDetails

A pageable asynchronous sequence of ResolveAppConnectionsResponse.Types.AppConnectionDetails resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
ResolveAppConnectionsRequest request = new ResolveAppConnectionsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AppConnectorIdAsAppConnectorName = AppConnectorName.FromProjectLocationAppConnector("[PROJECT]", "[LOCATION]", "[APP_CONNECTOR]"),
};
// Make the request
PagedAsyncEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> response = appConnectionsServiceClient.ResolveAppConnectionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ResolveAppConnectionsResponse.Types.AppConnectionDetails 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((ResolveAppConnectionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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<ResolveAppConnectionsResponse.Types.AppConnectionDetails> 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 (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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;

ResolveAppConnectionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> ResolveAppConnectionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

Parameters
Name Description
parent string

Required. The resource name of the AppConnection location using the form: projects/{project_id}/locations/{location_id}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableResolveAppConnectionsResponseResolveAppConnectionsResponseTypesAppConnectionDetails

A pageable asynchronous sequence of ResolveAppConnectionsResponse.Types.AppConnectionDetails resources.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ResolveAppConnectionsResponse, ResolveAppConnectionsResponse.Types.AppConnectionDetails> response = appConnectionsServiceClient.ResolveAppConnectionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ResolveAppConnectionsResponse.Types.AppConnectionDetails 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((ResolveAppConnectionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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<ResolveAppConnectionsResponse.Types.AppConnectionDetails> 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 (ResolveAppConnectionsResponse.Types.AppConnectionDetails 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;

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.

UpdateAppConnection(AppConnection, FieldMask, CallSettings)

public virtual Operation<AppConnection, AppConnectionOperationMetadata> UpdateAppConnection(AppConnection appConnection, FieldMask updateMask, CallSettings callSettings = null)

Updates the parameters of a single AppConnection.

Parameters
Name Description
appConnection AppConnection

Required. AppConnection message with updated fields. Only supported fields specified in update_mask are updated.

updateMask FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnection]:

  • labels
  • display_name
  • application_endpoint
  • connectors
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAppConnectionAppConnectionOperationMetadata

The RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
AppConnection appConnection = new AppConnection();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = appConnectionsServiceClient.UpdateAppConnection(appConnection, updateMask);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = appConnectionsServiceClient.PollOnceUpdateAppConnection(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

UpdateAppConnection(UpdateAppConnectionRequest, CallSettings)

public virtual Operation<AppConnection, AppConnectionOperationMetadata> UpdateAppConnection(UpdateAppConnectionRequest request, CallSettings callSettings = null)

Updates the parameters of a single AppConnection.

Parameters
Name Description
request UpdateAppConnectionRequest

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
OperationAppConnectionAppConnectionOperationMetadata

The RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = AppConnectionsServiceClient.Create();
// Initialize request argument(s)
UpdateAppConnectionRequest request = new UpdateAppConnectionRequest
{
    UpdateMask = new FieldMask(),
    AppConnection = new AppConnection(),
    RequestId = "",
    ValidateOnly = false,
    AllowMissing = false,
};
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = appConnectionsServiceClient.UpdateAppConnection(request);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = appConnectionsServiceClient.PollOnceUpdateAppConnection(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

UpdateAppConnectionAsync(AppConnection, FieldMask, CallSettings)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> UpdateAppConnectionAsync(AppConnection appConnection, FieldMask updateMask, CallSettings callSettings = null)

Updates the parameters of a single AppConnection.

Parameters
Name Description
appConnection AppConnection

Required. AppConnection message with updated fields. Only supported fields specified in update_mask are updated.

updateMask FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnection]:

  • labels
  • display_name
  • application_endpoint
  • connectors
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAppConnectionAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
AppConnection appConnection = new AppConnection();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.UpdateAppConnectionAsync(appConnection, updateMask);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceUpdateAppConnectionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

UpdateAppConnectionAsync(AppConnection, FieldMask, CancellationToken)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> UpdateAppConnectionAsync(AppConnection appConnection, FieldMask updateMask, CancellationToken cancellationToken)

Updates the parameters of a single AppConnection.

Parameters
Name Description
appConnection AppConnection

Required. AppConnection message with updated fields. Only supported fields specified in update_mask are updated.

updateMask FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnection]:

  • labels
  • display_name
  • application_endpoint
  • connectors
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAppConnectionAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
AppConnection appConnection = new AppConnection();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.UpdateAppConnectionAsync(appConnection, updateMask);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceUpdateAppConnectionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

UpdateAppConnectionAsync(UpdateAppConnectionRequest, CallSettings)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> UpdateAppConnectionAsync(UpdateAppConnectionRequest request, CallSettings callSettings = null)

Updates the parameters of a single AppConnection.

Parameters
Name Description
request UpdateAppConnectionRequest

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
TaskOperationAppConnectionAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateAppConnectionRequest request = new UpdateAppConnectionRequest
{
    UpdateMask = new FieldMask(),
    AppConnection = new AppConnection(),
    RequestId = "",
    ValidateOnly = false,
    AllowMissing = false,
};
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.UpdateAppConnectionAsync(request);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceUpdateAppConnectionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}

UpdateAppConnectionAsync(UpdateAppConnectionRequest, CancellationToken)

public virtual Task<Operation<AppConnection, AppConnectionOperationMetadata>> UpdateAppConnectionAsync(UpdateAppConnectionRequest request, CancellationToken cancellationToken)

Updates the parameters of a single AppConnection.

Parameters
Name Description
request UpdateAppConnectionRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAppConnectionAppConnectionOperationMetadata

A Task containing the RPC response.

Example
// Create client
AppConnectionsServiceClient appConnectionsServiceClient = await AppConnectionsServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateAppConnectionRequest request = new UpdateAppConnectionRequest
{
    UpdateMask = new FieldMask(),
    AppConnection = new AppConnection(),
    RequestId = "",
    ValidateOnly = false,
    AllowMissing = false,
};
// Make the request
Operation<AppConnection, AppConnectionOperationMetadata> response = await appConnectionsServiceClient.UpdateAppConnectionAsync(request);

// Poll until the returned long-running operation is complete
Operation<AppConnection, AppConnectionOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AppConnection 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<AppConnection, AppConnectionOperationMetadata> retrievedResponse = await appConnectionsServiceClient.PollOnceUpdateAppConnectionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AppConnection retrievedResult = retrievedResponse.Result;
}