App Engine v1 API - Class Versions.VersionsClient (2.2.0)

Version 2.2.0

• 2.4.0 (latest)
• 2.3.0
• 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 Versions.VersionsClient : ClientBase<Versions.VersionsClient>

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

Client for Versions

Inheritance

object > ClientBase > ClientBaseVersionsVersionsClient > Versions.VersionsClient

Inherited Members

ClientBase<Versions.VersionsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Constructors

VersionsClient()

protected VersionsClient()

Protected parameterless constructor to allow creation of test doubles.

VersionsClient(CallInvoker)

public VersionsClient(CallInvoker callInvoker)

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

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

VersionsClient(ChannelBase)

public VersionsClient(ChannelBase channel)

Creates a new client for Versions

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

VersionsClient(ClientBaseConfiguration)

protected VersionsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

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.

CreateVersion(CreateVersionRequest, CallOptions)

public virtual Operation CreateVersion(CreateVersionRequest request, CallOptions options)

Deploys code and resource files to a new version.

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

Returns
Type	Description
Operation	The response received from the server.

CreateVersion(CreateVersionRequest, Metadata, DateTime?, CancellationToken)

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

Deploys code and resource files to a new version.

Parameters
Name	Description
request	CreateVersionRequest 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.

CreateVersionAsync(CreateVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateVersionAsync(CreateVersionRequest request, CallOptions options)

Deploys code and resource files to a new version.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateVersionAsync(CreateVersionRequest, Metadata, DateTime?, CancellationToken)

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

Deploys code and resource files to a new version.

Parameters
Name	Description
request	CreateVersionRequest 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.

DeleteVersion(DeleteVersionRequest, CallOptions)

public virtual Operation DeleteVersion(DeleteVersionRequest request, CallOptions options)

Deletes an existing Version resource.

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

Returns
Type	Description
Operation	The response received from the server.

DeleteVersion(DeleteVersionRequest, Metadata, DateTime?, CancellationToken)

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

Deletes an existing Version resource.

Parameters
Name	Description
request	DeleteVersionRequest 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.

DeleteVersionAsync(DeleteVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteVersionAsync(DeleteVersionRequest request, CallOptions options)

Deletes an existing Version resource.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteVersionAsync(DeleteVersionRequest, Metadata, DateTime?, CancellationToken)

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

Deletes an existing Version resource.

Parameters
Name	Description
request	DeleteVersionRequest 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.

GetVersion(GetVersionRequest, CallOptions)

public virtual Version GetVersion(GetVersionRequest request, CallOptions options)

Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

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

Returns
Type	Description
Version	The response received from the server.

GetVersion(GetVersionRequest, Metadata, DateTime?, CancellationToken)

public virtual Version GetVersion(GetVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

Parameters
Name	Description
request	GetVersionRequest 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
Version	The response received from the server.

GetVersionAsync(GetVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Version> GetVersionAsync(GetVersionRequest request, CallOptions options)

Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

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

Returns
Type	Description
AsyncUnaryCallVersion	The call object.

GetVersionAsync(GetVersionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Version> GetVersionAsync(GetVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

Parameters
Name	Description
request	GetVersionRequest 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
AsyncUnaryCallVersion	The call object.

ListVersions(ListVersionsRequest, CallOptions)

public virtual ListVersionsResponse ListVersions(ListVersionsRequest request, CallOptions options)

Lists the versions of a service.

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

Returns
Type	Description
ListVersionsResponse	The response received from the server.

ListVersions(ListVersionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListVersionsResponse ListVersions(ListVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the versions of a service.

Parameters
Name	Description
request	ListVersionsRequest 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
ListVersionsResponse	The response received from the server.

ListVersionsAsync(ListVersionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListVersionsResponse> ListVersionsAsync(ListVersionsRequest request, CallOptions options)

Lists the versions of a service.

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

Returns
Type	Description
AsyncUnaryCallListVersionsResponse	The call object.

ListVersionsAsync(ListVersionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListVersionsResponse> ListVersionsAsync(ListVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the versions of a service.

Parameters
Name	Description
request	ListVersionsRequest 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
AsyncUnaryCallListVersionsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override Versions.VersionsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
VersionsVersionsClient

Overrides

ClientBase<Versions.VersionsClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateVersion(UpdateVersionRequest, CallOptions)

public virtual Operation UpdateVersion(UpdateVersionRequest request, CallOptions options)

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:

Standard environment

• instance_class

automatic scaling in the standard environment:

• automatic_scaling.min_idle_instances
• automatic_scaling.max_idle_instances
• automaticScaling.standard_scheduler_settings.max_instances
• automaticScaling.standard_scheduler_settings.min_instances
• automaticScaling.standard_scheduler_settings.target_cpu_utilization
• automaticScaling.standard_scheduler_settings.target_throughput_utilization

basic scaling or manual scaling in the standard environment:

• serving_status
• manual_scaling.instances

Flexible environment

• serving_status

automatic scaling in the flexible environment:

• automatic_scaling.min_total_instances
• automatic_scaling.max_total_instances
• automatic_scaling.cool_down_period_sec
• automatic_scaling.cpu_utilization.target_utilization

manual scaling in the flexible environment:

• manual_scaling.instances

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

Returns
Type	Description
Operation	The response received from the server.

UpdateVersion(UpdateVersionRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:

Standard environment

• instance_class

automatic scaling in the standard environment:

• automatic_scaling.min_idle_instances
• automatic_scaling.max_idle_instances
• automaticScaling.standard_scheduler_settings.max_instances
• automaticScaling.standard_scheduler_settings.min_instances
• automaticScaling.standard_scheduler_settings.target_cpu_utilization
• automaticScaling.standard_scheduler_settings.target_throughput_utilization

basic scaling or manual scaling in the standard environment:

• serving_status
• manual_scaling.instances

Flexible environment

• serving_status

automatic scaling in the flexible environment:

• automatic_scaling.min_total_instances
• automatic_scaling.max_total_instances
• automatic_scaling.cool_down_period_sec
• automatic_scaling.cpu_utilization.target_utilization

manual scaling in the flexible environment:

• manual_scaling.instances

Parameters
Name	Description
request	UpdateVersionRequest 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.

UpdateVersionAsync(UpdateVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateVersionAsync(UpdateVersionRequest request, CallOptions options)

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:

Standard environment

• instance_class

automatic scaling in the standard environment:

• automatic_scaling.min_idle_instances
• automatic_scaling.max_idle_instances
• automaticScaling.standard_scheduler_settings.max_instances
• automaticScaling.standard_scheduler_settings.min_instances
• automaticScaling.standard_scheduler_settings.target_cpu_utilization
• automaticScaling.standard_scheduler_settings.target_throughput_utilization

basic scaling or manual scaling in the standard environment:

• serving_status
• manual_scaling.instances

Flexible environment

• serving_status

automatic scaling in the flexible environment:

• automatic_scaling.min_total_instances
• automatic_scaling.max_total_instances
• automatic_scaling.cool_down_period_sec
• automatic_scaling.cpu_utilization.target_utilization

manual scaling in the flexible environment:

• manual_scaling.instances

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateVersionAsync(UpdateVersionRequest, Metadata, DateTime?, CancellationToken)

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

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:

Standard environment

• instance_class

automatic scaling in the standard environment:

• automatic_scaling.min_idle_instances
• automatic_scaling.max_idle_instances
• automaticScaling.standard_scheduler_settings.max_instances
• automaticScaling.standard_scheduler_settings.min_instances
• automaticScaling.standard_scheduler_settings.target_cpu_utilization
• automaticScaling.standard_scheduler_settings.target_throughput_utilization

basic scaling or manual scaling in the standard environment:

• serving_status
• manual_scaling.instances

Flexible environment

• serving_status

automatic scaling in the flexible environment:

• automatic_scaling.min_total_instances
• automatic_scaling.max_total_instances
• automatic_scaling.cool_down_period_sec
• automatic_scaling.cpu_utilization.target_utilization

manual scaling in the flexible environment:

• manual_scaling.instances

Parameters
Name	Description
request	UpdateVersionRequest 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.