App Engine v1 API - Class Applications.ApplicationsClient (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 class Applications.ApplicationsClient : ClientBase<Applications.ApplicationsClient>

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

Client for Applications

Inheritance

object > ClientBase > ClientBaseApplicationsApplicationsClient > Applications.ApplicationsClient

Inherited Members

ClientBase<Applications.ApplicationsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Constructors

ApplicationsClient()

protected ApplicationsClient()

Protected parameterless constructor to allow creation of test doubles.

ApplicationsClient(CallInvoker)

public ApplicationsClient(CallInvoker callInvoker)

Creates a new client for Applications that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ApplicationsClient(ChannelBase)

public ApplicationsClient(ChannelBase channel)

Creates a new client for Applications

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

ApplicationsClient(ClientBaseConfiguration)

protected ApplicationsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateApplication(CreateApplicationRequest, CallOptions)

public virtual Operation CreateApplication(CreateApplicationRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateApplication(CreateApplicationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateApplication(CreateApplicationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateApplicationAsync(CreateApplicationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateApplicationAsync(CreateApplicationRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateApplicationAsync(CreateApplicationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateApplicationAsync(CreateApplicationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

GetApplication(GetApplicationRequest, CallOptions)

public virtual Application GetApplication(GetApplicationRequest request, CallOptions options)

Gets information about an application.

Parameters
Name	Description
request	GetApplicationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Application	The response received from the server.

GetApplication(GetApplicationRequest, Metadata, DateTime?, CancellationToken)

public virtual Application GetApplication(GetApplicationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about an application.

Parameters
Name	Description
request	GetApplicationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Application	The response received from the server.

GetApplicationAsync(GetApplicationRequest, CallOptions)

public virtual AsyncUnaryCall<Application> GetApplicationAsync(GetApplicationRequest request, CallOptions options)

Gets information about an application.

Parameters
Name	Description
request	GetApplicationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallApplication	The call object.

GetApplicationAsync(GetApplicationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Application> GetApplicationAsync(GetApplicationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about an application.

Parameters
Name	Description
request	GetApplicationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallApplication	The call object.

NewInstance(ClientBaseConfiguration)

protected override Applications.ApplicationsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ApplicationsApplicationsClient

Overrides

ClientBase<Applications.ApplicationsClient>.NewInstance(ClientBase.ClientBaseConfiguration)

RepairApplication(RepairApplicationRequest, CallOptions)

public virtual Operation RepairApplication(RepairApplicationRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

RepairApplication(RepairApplicationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RepairApplication(RepairApplicationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

RepairApplicationAsync(RepairApplicationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RepairApplicationAsync(RepairApplicationRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RepairApplicationAsync(RepairApplicationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RepairApplicationAsync(RepairApplicationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateApplication(UpdateApplicationRequest, CallOptions)

public virtual Operation UpdateApplication(UpdateApplicationRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateApplication(UpdateApplicationRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateApplication(UpdateApplicationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateApplicationAsync(UpdateApplicationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateApplicationAsync(UpdateApplicationRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateApplicationAsync(UpdateApplicationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateApplicationAsync(UpdateApplicationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.