BeyondCorp AppGateways v1 API - Class AppGatewaysServiceClient (1.4.0) 

public abstract class AppGatewaysServiceClient

Reference documentation and code samples for the BeyondCorp AppGateways v1 API class AppGatewaysServiceClient.

AppGatewaysService client wrapper, for convenient use.

Inheritance

object > AppGatewaysServiceClient

Namespace

Google.Cloud.BeyondCorp.AppGateways.V1

Assembly

Google.Cloud.BeyondCorp.AppGateways.V1.dll

Remarks

API Overview:

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

Data Model:

The AppGatewaysService exposes the following resources:

  • AppGateways, named as follows: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}.

The AppGatewaysService service provides methods to manage (create/read/update/delete) BeyondCorp AppGateways.

Properties

CreateAppGatewayOperationsClient

public virtual OperationsClient CreateAppGatewayOperationsClient { get; }

The long-running operations client for CreateAppGateway.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the AppGatewaysService 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 AppGatewaysService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default AppGatewaysService scopes are:

DeleteAppGatewayOperationsClient

public virtual OperationsClient DeleteAppGatewayOperationsClient { get; }

The long-running operations client for DeleteAppGateway.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual AppGatewaysService.AppGatewaysServiceClient GrpcClient { get; }

The underlying gRPC AppGatewaysService client

Property Value
Type Description
AppGatewaysServiceAppGatewaysServiceClient

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

Methods

Create()

public static AppGatewaysServiceClient Create()

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

Returns
Type Description
AppGatewaysServiceClient

The created AppGatewaysServiceClient.

CreateAppGateway(LocationName, AppGateway, string, CallSettings)

public virtual Operation<AppGateway, AppGatewayOperationMetadata> CreateAppGateway(LocationName parent, AppGateway appGateway, string appGatewayId, CallSettings callSettings = null)

Creates a new AppGateway in a given project and location.

Parameters
Name Description
parent LocationName

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

Required. A BeyondCorp AppGateway resource.
appGatewayId string

Optional. User-settable AppGateway 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
OperationAppGatewayAppGatewayOperationMetadata

The RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AppGateway appGateway = new AppGateway();
string appGatewayId = "";
// Make the request
Operation<AppGateway, AppGatewayOperationMetadata> response = appGatewaysServiceClient.CreateAppGateway(parent, appGateway, appGatewayId);

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

CreateAppGateway(CreateAppGatewayRequest, CallSettings)

public virtual Operation<AppGateway, AppGatewayOperationMetadata> CreateAppGateway(CreateAppGatewayRequest request, CallSettings callSettings = null)

Creates a new AppGateway in a given project and location.

Parameters
Name Description
request CreateAppGatewayRequest

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
OperationAppGatewayAppGatewayOperationMetadata

The RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
CreateAppGatewayRequest request = new CreateAppGatewayRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AppGatewayId = "",
    AppGateway = new AppGateway(),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AppGateway, AppGatewayOperationMetadata> response = appGatewaysServiceClient.CreateAppGateway(request);

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

CreateAppGateway(string, AppGateway, string, CallSettings)

public virtual Operation<AppGateway, AppGatewayOperationMetadata> CreateAppGateway(string parent, AppGateway appGateway, string appGatewayId, CallSettings callSettings = null)

Creates a new AppGateway in a given project and location.

Parameters
Name Description
parent string

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

Required. A BeyondCorp AppGateway resource.
appGatewayId string

Optional. User-settable AppGateway 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
OperationAppGatewayAppGatewayOperationMetadata

The RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AppGateway appGateway = new AppGateway();
string appGatewayId = "";
// Make the request
Operation<AppGateway, AppGatewayOperationMetadata> response = appGatewaysServiceClient.CreateAppGateway(parent, appGateway, appGatewayId);

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

CreateAppGatewayAsync(LocationName, AppGateway, string, CallSettings)

public virtual Task<Operation<AppGateway, AppGatewayOperationMetadata>> CreateAppGatewayAsync(LocationName parent, AppGateway appGateway, string appGatewayId, CallSettings callSettings = null)

Creates a new AppGateway in a given project and location.

Parameters
Name Description
parent LocationName

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

Required. A BeyondCorp AppGateway resource.
appGatewayId string

Optional. User-settable AppGateway 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
TaskOperationAppGatewayAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AppGateway appGateway = new AppGateway();
string appGatewayId = "";
// Make the request
Operation<AppGateway, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.CreateAppGatewayAsync(parent, appGateway, appGatewayId);

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

CreateAppGatewayAsync(LocationName, AppGateway, string, CancellationToken)

public virtual Task<Operation<AppGateway, AppGatewayOperationMetadata>> CreateAppGatewayAsync(LocationName parent, AppGateway appGateway, string appGatewayId, CancellationToken cancellationToken)

Creates a new AppGateway in a given project and location.

Parameters
Name Description
parent LocationName

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

Required. A BeyondCorp AppGateway resource.
appGatewayId string

Optional. User-settable AppGateway 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
TaskOperationAppGatewayAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
AppGateway appGateway = new AppGateway();
string appGatewayId = "";
// Make the request
Operation<AppGateway, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.CreateAppGatewayAsync(parent, appGateway, appGatewayId);

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

CreateAppGatewayAsync(CreateAppGatewayRequest, CallSettings)

public virtual Task<Operation<AppGateway, AppGatewayOperationMetadata>> CreateAppGatewayAsync(CreateAppGatewayRequest request, CallSettings callSettings = null)

Creates a new AppGateway in a given project and location.

Parameters
Name Description
request CreateAppGatewayRequest

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
TaskOperationAppGatewayAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
CreateAppGatewayRequest request = new CreateAppGatewayRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AppGatewayId = "",
    AppGateway = new AppGateway(),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AppGateway, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.CreateAppGatewayAsync(request);

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

CreateAppGatewayAsync(CreateAppGatewayRequest, CancellationToken)

public virtual Task<Operation<AppGateway, AppGatewayOperationMetadata>> CreateAppGatewayAsync(CreateAppGatewayRequest request, CancellationToken cancellationToken)

Creates a new AppGateway in a given project and location.

Parameters
Name Description
request CreateAppGatewayRequest

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

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationAppGatewayAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
CreateAppGatewayRequest request = new CreateAppGatewayRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    AppGatewayId = "",
    AppGateway = new AppGateway(),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<AppGateway, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.CreateAppGatewayAsync(request);

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

CreateAppGatewayAsync(string, AppGateway, string, CallSettings)

public virtual Task<Operation<AppGateway, AppGatewayOperationMetadata>> CreateAppGatewayAsync(string parent, AppGateway appGateway, string appGatewayId, CallSettings callSettings = null)

Creates a new AppGateway in a given project and location.

Parameters
Name Description
parent string

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

Required. A BeyondCorp AppGateway resource.
appGatewayId string

Optional. User-settable AppGateway 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
TaskOperationAppGatewayAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AppGateway appGateway = new AppGateway();
string appGatewayId = "";
// Make the request
Operation<AppGateway, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.CreateAppGatewayAsync(parent, appGateway, appGatewayId);

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

CreateAppGatewayAsync(string, AppGateway, string, CancellationToken)

public virtual Task<Operation<AppGateway, AppGatewayOperationMetadata>> CreateAppGatewayAsync(string parent, AppGateway appGateway, string appGatewayId, CancellationToken cancellationToken)

Creates a new AppGateway in a given project and location.

Parameters
Name Description
parent string

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

Required. A BeyondCorp AppGateway resource.
appGatewayId string

Optional. User-settable AppGateway 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
TaskOperationAppGatewayAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
AppGateway appGateway = new AppGateway();
string appGatewayId = "";
// Make the request
Operation<AppGateway, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.CreateAppGatewayAsync(parent, appGateway, appGatewayId);

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

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskAppGatewaysServiceClient

The task representing the created AppGatewaysServiceClient.

DeleteAppGateway(AppGatewayName, CallSettings)

public virtual Operation<Empty, AppGatewayOperationMetadata> DeleteAppGateway(AppGatewayName name, CallSettings callSettings = null)

Deletes a single AppGateway.

Parameters
Name Description
name AppGatewayName

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyAppGatewayOperationMetadata

The RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
AppGatewayName name = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
// Make the request
Operation<Empty, AppGatewayOperationMetadata> response = appGatewaysServiceClient.DeleteAppGateway(name);

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

DeleteAppGateway(DeleteAppGatewayRequest, CallSettings)

public virtual Operation<Empty, AppGatewayOperationMetadata> DeleteAppGateway(DeleteAppGatewayRequest request, CallSettings callSettings = null)

Deletes a single AppGateway.

Parameters
Name Description
request DeleteAppGatewayRequest

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
OperationEmptyAppGatewayOperationMetadata

The RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
DeleteAppGatewayRequest request = new DeleteAppGatewayRequest
{
    AppGatewayName = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]"),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<Empty, AppGatewayOperationMetadata> response = appGatewaysServiceClient.DeleteAppGateway(request);

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

DeleteAppGateway(string, CallSettings)

public virtual Operation<Empty, AppGatewayOperationMetadata> DeleteAppGateway(string name, CallSettings callSettings = null)

Deletes a single AppGateway.

Parameters
Name Description
name string

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyAppGatewayOperationMetadata

The RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appGateways/[APP_GATEWAY]";
// Make the request
Operation<Empty, AppGatewayOperationMetadata> response = appGatewaysServiceClient.DeleteAppGateway(name);

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

DeleteAppGatewayAsync(AppGatewayName, CallSettings)

public virtual Task<Operation<Empty, AppGatewayOperationMetadata>> DeleteAppGatewayAsync(AppGatewayName name, CallSettings callSettings = null)

Deletes a single AppGateway.

Parameters
Name Description
name AppGatewayName

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
AppGatewayName name = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
// Make the request
Operation<Empty, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.DeleteAppGatewayAsync(name);

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

DeleteAppGatewayAsync(AppGatewayName, CancellationToken)

public virtual Task<Operation<Empty, AppGatewayOperationMetadata>> DeleteAppGatewayAsync(AppGatewayName name, CancellationToken cancellationToken)

Deletes a single AppGateway.

Parameters
Name Description
name AppGatewayName

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationEmptyAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
AppGatewayName name = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
// Make the request
Operation<Empty, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.DeleteAppGatewayAsync(name);

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

DeleteAppGatewayAsync(DeleteAppGatewayRequest, CallSettings)

public virtual Task<Operation<Empty, AppGatewayOperationMetadata>> DeleteAppGatewayAsync(DeleteAppGatewayRequest request, CallSettings callSettings = null)

Deletes a single AppGateway.

Parameters
Name Description
request DeleteAppGatewayRequest

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
TaskOperationEmptyAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteAppGatewayRequest request = new DeleteAppGatewayRequest
{
    AppGatewayName = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]"),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<Empty, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.DeleteAppGatewayAsync(request);

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

DeleteAppGatewayAsync(DeleteAppGatewayRequest, CancellationToken)

public virtual Task<Operation<Empty, AppGatewayOperationMetadata>> DeleteAppGatewayAsync(DeleteAppGatewayRequest request, CancellationToken cancellationToken)

Deletes a single AppGateway.

Parameters
Name Description
request DeleteAppGatewayRequest

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

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationEmptyAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteAppGatewayRequest request = new DeleteAppGatewayRequest
{
    AppGatewayName = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]"),
    RequestId = "",
    ValidateOnly = false,
};
// Make the request
Operation<Empty, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.DeleteAppGatewayAsync(request);

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

DeleteAppGatewayAsync(string, CallSettings)

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

Deletes a single AppGateway.

Parameters
Name Description
name string

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appGateways/[APP_GATEWAY]";
// Make the request
Operation<Empty, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.DeleteAppGatewayAsync(name);

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

DeleteAppGatewayAsync(string, CancellationToken)

public virtual Task<Operation<Empty, AppGatewayOperationMetadata>> DeleteAppGatewayAsync(string name, CancellationToken cancellationToken)

Deletes a single AppGateway.

Parameters
Name Description
name string

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationEmptyAppGatewayOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appGateways/[APP_GATEWAY]";
// Make the request
Operation<Empty, AppGatewayOperationMetadata> response = await appGatewaysServiceClient.DeleteAppGatewayAsync(name);

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

GetAppGateway(AppGatewayName, CallSettings)

public virtual AppGateway GetAppGateway(AppGatewayName name, CallSettings callSettings = null)

Gets details of a single AppGateway.

Parameters
Name Description
name AppGatewayName

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AppGateway

The RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
AppGatewayName name = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
// Make the request
AppGateway response = appGatewaysServiceClient.GetAppGateway(name);

GetAppGateway(GetAppGatewayRequest, CallSettings)

public virtual AppGateway GetAppGateway(GetAppGatewayRequest request, CallSettings callSettings = null)

Gets details of a single AppGateway.

Parameters
Name Description
request GetAppGatewayRequest

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
AppGateway

The RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
GetAppGatewayRequest request = new GetAppGatewayRequest
{
    AppGatewayName = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]"),
};
// Make the request
AppGateway response = appGatewaysServiceClient.GetAppGateway(request);

GetAppGateway(string, CallSettings)

public virtual AppGateway GetAppGateway(string name, CallSettings callSettings = null)

Gets details of a single AppGateway.

Parameters
Name Description
name string

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AppGateway

The RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appGateways/[APP_GATEWAY]";
// Make the request
AppGateway response = appGatewaysServiceClient.GetAppGateway(name);

GetAppGatewayAsync(AppGatewayName, CallSettings)

public virtual Task<AppGateway> GetAppGatewayAsync(AppGatewayName name, CallSettings callSettings = null)

Gets details of a single AppGateway.

Parameters
Name Description
name AppGatewayName

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAppGateway

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
AppGatewayName name = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
// Make the request
AppGateway response = await appGatewaysServiceClient.GetAppGatewayAsync(name);

GetAppGatewayAsync(AppGatewayName, CancellationToken)

public virtual Task<AppGateway> GetAppGatewayAsync(AppGatewayName name, CancellationToken cancellationToken)

Gets details of a single AppGateway.

Parameters
Name Description
name AppGatewayName

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskAppGateway

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
AppGatewayName name = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]");
// Make the request
AppGateway response = await appGatewaysServiceClient.GetAppGatewayAsync(name);

GetAppGatewayAsync(GetAppGatewayRequest, CallSettings)

public virtual Task<AppGateway> GetAppGatewayAsync(GetAppGatewayRequest request, CallSettings callSettings = null)

Gets details of a single AppGateway.

Parameters
Name Description
request GetAppGatewayRequest

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
TaskAppGateway

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
GetAppGatewayRequest request = new GetAppGatewayRequest
{
    AppGatewayName = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]"),
};
// Make the request
AppGateway response = await appGatewaysServiceClient.GetAppGatewayAsync(request);

GetAppGatewayAsync(GetAppGatewayRequest, CancellationToken)

public virtual Task<AppGateway> GetAppGatewayAsync(GetAppGatewayRequest request, CancellationToken cancellationToken)

Gets details of a single AppGateway.

Parameters
Name Description
request GetAppGatewayRequest

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

A CancellationToken to use for this RPC.
Returns
Type Description
TaskAppGateway

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
GetAppGatewayRequest request = new GetAppGatewayRequest
{
    AppGatewayName = AppGatewayName.FromProjectLocationAppGateway("[PROJECT]", "[LOCATION]", "[APP_GATEWAY]"),
};
// Make the request
AppGateway response = await appGatewaysServiceClient.GetAppGatewayAsync(request);

GetAppGatewayAsync(string, CallSettings)

public virtual Task<AppGateway> GetAppGatewayAsync(string name, CallSettings callSettings = null)

Gets details of a single AppGateway.

Parameters
Name Description
name string

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAppGateway

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appGateways/[APP_GATEWAY]";
// Make the request
AppGateway response = await appGatewaysServiceClient.GetAppGatewayAsync(name);

GetAppGatewayAsync(string, CancellationToken)

public virtual Task<AppGateway> GetAppGatewayAsync(string name, CancellationToken cancellationToken)

Gets details of a single AppGateway.

Parameters
Name Description
name string

Required. BeyondCorp AppGateway name using the form: projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskAppGateway

A Task containing the RPC response.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/appGateways/[APP_GATEWAY]";
// Make the request
AppGateway response = await appGatewaysServiceClient.GetAppGatewayAsync(name);

ListAppGateways(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListAppGatewaysResponse, AppGateway> ListAppGateways(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists AppGateways in a given project and location.

Parameters
Name Description
parent LocationName

Required. The resource name of the AppGateway 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
PagedEnumerableListAppGatewaysResponseAppGateway

A pageable sequence of AppGateway resources.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListAppGatewaysResponse, AppGateway> response = appGatewaysServiceClient.ListAppGateways(parent);

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

ListAppGateways(ListAppGatewaysRequest, CallSettings)

public virtual PagedEnumerable<ListAppGatewaysResponse, AppGateway> ListAppGateways(ListAppGatewaysRequest request, CallSettings callSettings = null)

Lists AppGateways in a given project and location.

Parameters
Name Description
request ListAppGatewaysRequest

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
PagedEnumerableListAppGatewaysResponseAppGateway

A pageable sequence of AppGateway resources.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
ListAppGatewaysRequest request = new ListAppGatewaysRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListAppGatewaysResponse, AppGateway> response = appGatewaysServiceClient.ListAppGateways(request);

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

ListAppGateways(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListAppGatewaysResponse, AppGateway> ListAppGateways(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists AppGateways in a given project and location.

Parameters
Name Description
parent string

Required. The resource name of the AppGateway 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
PagedEnumerableListAppGatewaysResponseAppGateway

A pageable sequence of AppGateway resources.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = AppGatewaysServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListAppGatewaysResponse, AppGateway> response = appGatewaysServiceClient.ListAppGateways(parent);

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

ListAppGatewaysAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAppGatewaysResponse, AppGateway> ListAppGatewaysAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists AppGateways in a given project and location.

Parameters
Name Description
parent LocationName

Required. The resource name of the AppGateway 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
PagedAsyncEnumerableListAppGatewaysResponseAppGateway

A pageable asynchronous sequence of AppGateway resources.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListAppGatewaysResponse, AppGateway> response = appGatewaysServiceClient.ListAppGatewaysAsync(parent);

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

ListAppGatewaysAsync(ListAppGatewaysRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAppGatewaysResponse, AppGateway> ListAppGatewaysAsync(ListAppGatewaysRequest request, CallSettings callSettings = null)

Lists AppGateways in a given project and location.

Parameters
Name Description
request ListAppGatewaysRequest

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
PagedAsyncEnumerableListAppGatewaysResponseAppGateway

A pageable asynchronous sequence of AppGateway resources.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
ListAppGatewaysRequest request = new ListAppGatewaysRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListAppGatewaysResponse, AppGateway> response = appGatewaysServiceClient.ListAppGatewaysAsync(request);

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

ListAppGatewaysAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAppGatewaysResponse, AppGateway> ListAppGatewaysAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists AppGateways in a given project and location.

Parameters
Name Description
parent string

Required. The resource name of the AppGateway 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
PagedAsyncEnumerableListAppGatewaysResponseAppGateway

A pageable asynchronous sequence of AppGateway resources.
Example 
// Create client
AppGatewaysServiceClient appGatewaysServiceClient = await AppGatewaysServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListAppGatewaysResponse, AppGateway> response = appGatewaysServiceClient.ListAppGatewaysAsync(parent);

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

PollOnceCreateAppGateway(string, CallSettings)

public virtual Operation<AppGateway, AppGatewayOperationMetadata> PollOnceCreateAppGateway(string operationName, CallSettings callSettings = null)

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

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
OperationAppGatewayAppGatewayOperationMetadata

The result of polling the operation.

PollOnceCreateAppGatewayAsync(string, CallSettings)

public virtual Task<Operation<AppGateway, AppGatewayOperationMetadata>> PollOnceCreateAppGatewayAsync(string operationName, CallSettings callSettings = null)

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

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
TaskOperationAppGatewayAppGatewayOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteAppGateway(string, CallSettings)

public virtual Operation<Empty, AppGatewayOperationMetadata> PollOnceDeleteAppGateway(string operationName, CallSettings callSettings = null)

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

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
OperationEmptyAppGatewayOperationMetadata

The result of polling the operation.

PollOnceDeleteAppGatewayAsync(string, CallSettings)

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

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

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
TaskOperationEmptyAppGatewayOperationMetadata

A task representing the result of polling the operation.

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.