App Engine v1 API - Class ApplicationsClientImpl (2.3.0)

Version latest

• 2.3.0 (latest)
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class ApplicationsClientImpl : ApplicationsClient

Reference documentation and code samples for the App Engine v1 API class ApplicationsClientImpl.

Applications client wrapper implementation, for convenient use.

Inheritance

object > ApplicationsClient > ApplicationsClientImpl

Inherited Members

ApplicationsClient.DefaultEndpoint

ApplicationsClient.DefaultScopes

ApplicationsClient.ServiceMetadata

ApplicationsClient.CreateAsync(CancellationToken)

ApplicationsClient.Create()

ApplicationsClient.ShutdownDefaultChannelsAsync()

ApplicationsClient.GetApplicationAsync(GetApplicationRequest, CancellationToken)

ApplicationsClient.GetApplication(string, CallSettings)

ApplicationsClient.GetApplicationAsync(string, CallSettings)

ApplicationsClient.GetApplicationAsync(string, CancellationToken)

ApplicationsClient.CreateApplicationAsync(CreateApplicationRequest, CancellationToken)

ApplicationsClient.PollOnceCreateApplication(string, CallSettings)

ApplicationsClient.PollOnceCreateApplicationAsync(string, CallSettings)

ApplicationsClient.UpdateApplicationAsync(UpdateApplicationRequest, CancellationToken)

ApplicationsClient.PollOnceUpdateApplication(string, CallSettings)

ApplicationsClient.PollOnceUpdateApplicationAsync(string, CallSettings)

ApplicationsClient.RepairApplicationAsync(RepairApplicationRequest, CancellationToken)

ApplicationsClient.PollOnceRepairApplication(string, CallSettings)

ApplicationsClient.PollOnceRepairApplicationAsync(string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Remarks

Manages App Engine applications.

Constructors

ApplicationsClientImpl(ApplicationsClient, ApplicationsSettings, ILogger)

public ApplicationsClientImpl(Applications.ApplicationsClient grpcClient, ApplicationsSettings settings, ILogger logger)

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

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

Properties

CreateApplicationOperationsClient

public override OperationsClient CreateApplicationOperationsClient { get; }

The long-running operations client for CreateApplication.

Property Value
Type	Description
OperationsClient

Overrides

ApplicationsClient.CreateApplicationOperationsClient

GrpcClient

public override Applications.ApplicationsClient GrpcClient { get; }

The underlying gRPC Applications client

Property Value
Type	Description
ApplicationsApplicationsClient

Overrides

ApplicationsClient.GrpcClient

RepairApplicationOperationsClient

public override OperationsClient RepairApplicationOperationsClient { get; }

The long-running operations client for RepairApplication.

Property Value
Type	Description
OperationsClient

Overrides

ApplicationsClient.RepairApplicationOperationsClient

UpdateApplicationOperationsClient

public override OperationsClient UpdateApplicationOperationsClient { get; }

The long-running operations client for UpdateApplication.

Property Value
Type	Description
OperationsClient

Overrides

ApplicationsClient.UpdateApplicationOperationsClient

Methods

CreateApplication(CreateApplicationRequest, CallSettings)

public override Operation<Application, OperationMetadataV1> CreateApplication(CreateApplicationRequest request, CallSettings callSettings = null)

Creates an App Engine application for a Google Cloud Platform project. Required fields:

• id - The ID of the target Cloud Platform project.
• location - The region where you want the App Engine application located.

For more information about App Engine applications, see Managing Projects, Applications, and Billing.

Parameters
Name	Description
request	CreateApplicationRequest 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
OperationApplicationOperationMetadataV1	The RPC response.

Overrides

ApplicationsClient.CreateApplication(CreateApplicationRequest, CallSettings)

CreateApplicationAsync(CreateApplicationRequest, CallSettings)

public override Task<Operation<Application, OperationMetadataV1>> CreateApplicationAsync(CreateApplicationRequest request, CallSettings callSettings = null)

Creates an App Engine application for a Google Cloud Platform project. Required fields:

• id - The ID of the target Cloud Platform project.
• location - The region where you want the App Engine application located.

For more information about App Engine applications, see Managing Projects, Applications, and Billing.

Parameters
Name	Description
request	CreateApplicationRequest 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
TaskOperationApplicationOperationMetadataV1	A Task containing the RPC response.

Overrides

ApplicationsClient.CreateApplicationAsync(CreateApplicationRequest, CallSettings)

GetApplication(GetApplicationRequest, CallSettings)

public override Application GetApplication(GetApplicationRequest request, CallSettings callSettings = null)

Gets information about an application.

Parameters
Name	Description
request	GetApplicationRequest 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
Application	The RPC response.

Overrides

ApplicationsClient.GetApplication(GetApplicationRequest, CallSettings)

GetApplicationAsync(GetApplicationRequest, CallSettings)

public override Task<Application> GetApplicationAsync(GetApplicationRequest request, CallSettings callSettings = null)

Gets information about an application.

Parameters
Name	Description
request	GetApplicationRequest 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
TaskApplication	A Task containing the RPC response.

Overrides

ApplicationsClient.GetApplicationAsync(GetApplicationRequest, CallSettings)

RepairApplication(RepairApplicationRequest, CallSettings)

public override Operation<Application, OperationMetadataV1> RepairApplication(RepairApplicationRequest request, CallSettings callSettings = null)

Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.

Parameters
Name	Description
request	RepairApplicationRequest 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
OperationApplicationOperationMetadataV1	The RPC response.

Overrides

ApplicationsClient.RepairApplication(RepairApplicationRequest, CallSettings)

RepairApplicationAsync(RepairApplicationRequest, CallSettings)

public override Task<Operation<Application, OperationMetadataV1>> RepairApplicationAsync(RepairApplicationRequest request, CallSettings callSettings = null)

Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.

Parameters
Name	Description
request	RepairApplicationRequest 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
TaskOperationApplicationOperationMetadataV1	A Task containing the RPC response.

Overrides

ApplicationsClient.RepairApplicationAsync(RepairApplicationRequest, CallSettings)

UpdateApplication(UpdateApplicationRequest, CallSettings)

public override Operation<Application, OperationMetadataV1> UpdateApplication(UpdateApplicationRequest request, CallSettings callSettings = null)

Updates the specified Application resource. You can update the following fields:

• auth_domain - Google authentication domain for controlling user access to the application.
• default_cookie_expiration - Cookie expiration policy for the application.
• iap - Identity-Aware Proxy properties for the application.

Parameters
Name	Description
request	UpdateApplicationRequest 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
OperationApplicationOperationMetadataV1	The RPC response.

Overrides

ApplicationsClient.UpdateApplication(UpdateApplicationRequest, CallSettings)

UpdateApplicationAsync(UpdateApplicationRequest, CallSettings)

public override Task<Operation<Application, OperationMetadataV1>> UpdateApplicationAsync(UpdateApplicationRequest request, CallSettings callSettings = null)

Updates the specified Application resource. You can update the following fields:

• auth_domain - Google authentication domain for controlling user access to the application.
• default_cookie_expiration - Cookie expiration policy for the application.
• iap - Identity-Aware Proxy properties for the application.

Parameters
Name	Description
request	UpdateApplicationRequest 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
TaskOperationApplicationOperationMetadataV1	A Task containing the RPC response.

Overrides

ApplicationsClient.UpdateApplicationAsync(UpdateApplicationRequest, CallSettings)