App Engine v1 API - Class VersionsClientImpl (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 VersionsClientImpl : VersionsClient

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

Versions client wrapper implementation, for convenient use.

Inheritance

object > VersionsClient > VersionsClientImpl

Inherited Members

VersionsClient.DefaultEndpoint

VersionsClient.DefaultScopes

VersionsClient.ServiceMetadata

VersionsClient.CreateAsync(CancellationToken)

VersionsClient.Create()

VersionsClient.ShutdownDefaultChannelsAsync()

VersionsClient.GetVersionAsync(GetVersionRequest, CancellationToken)

VersionsClient.CreateVersionAsync(CreateVersionRequest, CancellationToken)

VersionsClient.PollOnceCreateVersion(string, CallSettings)

VersionsClient.PollOnceCreateVersionAsync(string, CallSettings)

VersionsClient.UpdateVersionAsync(UpdateVersionRequest, CancellationToken)

VersionsClient.PollOnceUpdateVersion(string, CallSettings)

VersionsClient.PollOnceUpdateVersionAsync(string, CallSettings)

VersionsClient.DeleteVersionAsync(DeleteVersionRequest, CancellationToken)

VersionsClient.PollOnceDeleteVersion(string, CallSettings)

VersionsClient.PollOnceDeleteVersionAsync(string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Remarks

Manages versions of a service.

Constructors

VersionsClientImpl(VersionsClient, VersionsSettings, ILogger)

public VersionsClientImpl(Versions.VersionsClient grpcClient, VersionsSettings settings, ILogger logger)

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

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

Properties

CreateVersionOperationsClient

public override OperationsClient CreateVersionOperationsClient { get; }

The long-running operations client for CreateVersion.

Property Value
Type	Description
OperationsClient

Overrides

VersionsClient.CreateVersionOperationsClient

DeleteVersionOperationsClient

public override OperationsClient DeleteVersionOperationsClient { get; }

The long-running operations client for DeleteVersion.

Property Value
Type	Description
OperationsClient

Overrides

VersionsClient.DeleteVersionOperationsClient

GrpcClient

public override Versions.VersionsClient GrpcClient { get; }

The underlying gRPC Versions client

Property Value
Type	Description
VersionsVersionsClient

Overrides

VersionsClient.GrpcClient

UpdateVersionOperationsClient

public override OperationsClient UpdateVersionOperationsClient { get; }

The long-running operations client for UpdateVersion.

Property Value
Type	Description
OperationsClient

Overrides

VersionsClient.UpdateVersionOperationsClient

Methods

CreateVersion(CreateVersionRequest, CallSettings)

public override Operation<Version, CreateVersionMetadataV1> CreateVersion(CreateVersionRequest request, CallSettings callSettings = null)

Deploys code and resource files to a new version.

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

Overrides

VersionsClient.CreateVersion(CreateVersionRequest, CallSettings)

CreateVersionAsync(CreateVersionRequest, CallSettings)

public override Task<Operation<Version, CreateVersionMetadataV1>> CreateVersionAsync(CreateVersionRequest request, CallSettings callSettings = null)

Deploys code and resource files to a new version.

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

Overrides

VersionsClient.CreateVersionAsync(CreateVersionRequest, CallSettings)

DeleteVersion(DeleteVersionRequest, CallSettings)

public override Operation<Empty, OperationMetadataV1> DeleteVersion(DeleteVersionRequest request, CallSettings callSettings = null)

Deletes an existing Version resource.

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

Overrides

VersionsClient.DeleteVersion(DeleteVersionRequest, CallSettings)

DeleteVersionAsync(DeleteVersionRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadataV1>> DeleteVersionAsync(DeleteVersionRequest request, CallSettings callSettings = null)

Deletes an existing Version resource.

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

Overrides

VersionsClient.DeleteVersionAsync(DeleteVersionRequest, CallSettings)

GetVersion(GetVersionRequest, CallSettings)

public override Version GetVersion(GetVersionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Version	The RPC response.

Overrides

VersionsClient.GetVersion(GetVersionRequest, CallSettings)

GetVersionAsync(GetVersionRequest, CallSettings)

public override Task<Version> GetVersionAsync(GetVersionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskVersion	A Task containing the RPC response.

Overrides

VersionsClient.GetVersionAsync(GetVersionRequest, CallSettings)

ListVersions(ListVersionsRequest, CallSettings)

public override PagedEnumerable<ListVersionsResponse, Version> ListVersions(ListVersionsRequest request, CallSettings callSettings = null)

Lists the versions of a service.

Parameters
Name	Description
request	ListVersionsRequest 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
PagedEnumerableListVersionsResponseVersion	A pageable sequence of Version resources.

Overrides

VersionsClient.ListVersions(ListVersionsRequest, CallSettings)

ListVersionsAsync(ListVersionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListVersionsResponse, Version> ListVersionsAsync(ListVersionsRequest request, CallSettings callSettings = null)

Lists the versions of a service.

Parameters
Name	Description
request	ListVersionsRequest 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
PagedAsyncEnumerableListVersionsResponseVersion	A pageable asynchronous sequence of Version resources.

Overrides

VersionsClient.ListVersionsAsync(ListVersionsRequest, CallSettings)

UpdateVersion(UpdateVersionRequest, CallSettings)

public override Operation<Version, OperationMetadataV1> UpdateVersion(UpdateVersionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationVersionOperationMetadataV1	The RPC response.

Overrides

VersionsClient.UpdateVersion(UpdateVersionRequest, CallSettings)

UpdateVersionAsync(UpdateVersionRequest, CallSettings)

public override Task<Operation<Version, OperationMetadataV1>> UpdateVersionAsync(UpdateVersionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationVersionOperationMetadataV1	A Task containing the RPC response.

Overrides

VersionsClient.UpdateVersionAsync(UpdateVersionRequest, CallSettings)