App Engine v1 API - Class InstancesClientImpl (2.3.0)

public sealed class InstancesClientImpl : InstancesClient

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

Instances client wrapper implementation, for convenient use.

Inheritance

object > InstancesClient > InstancesClientImpl

Inherited Members

InstancesClient.DefaultEndpoint

InstancesClient.DefaultScopes

InstancesClient.ServiceMetadata

InstancesClient.CreateAsync(CancellationToken)

InstancesClient.Create()

InstancesClient.ShutdownDefaultChannelsAsync()

InstancesClient.GetInstanceAsync(GetInstanceRequest, CancellationToken)

InstancesClient.DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

InstancesClient.PollOnceDeleteInstance(string, CallSettings)

InstancesClient.PollOnceDeleteInstanceAsync(string, CallSettings)

InstancesClient.DebugInstanceAsync(DebugInstanceRequest, CancellationToken)

InstancesClient.PollOnceDebugInstance(string, CallSettings)

InstancesClient.PollOnceDebugInstanceAsync(string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AppEngine.V1

Assembly

Google.Cloud.AppEngine.V1.dll

Remarks

Manages instances of a version.

Constructors

InstancesClientImpl(InstancesClient, InstancesSettings, ILogger)

public InstancesClientImpl(Instances.InstancesClient grpcClient, InstancesSettings settings, ILogger logger)

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

Parameters
Name	Description
`grpcClient`	`InstancesInstancesClient` The underlying gRPC client.
`settings`	`InstancesSettings` The base InstancesSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

DebugInstanceOperationsClient

public override OperationsClient DebugInstanceOperationsClient { get; }

The long-running operations client for DebugInstance.

Property Value
Type	Description
`OperationsClient`

Overrides

InstancesClient.DebugInstanceOperationsClient

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type	Description
`OperationsClient`

Overrides

InstancesClient.DeleteInstanceOperationsClient

GrpcClient

public override Instances.InstancesClient GrpcClient { get; }

The underlying gRPC Instances client

Property Value
Type	Description
`InstancesInstancesClient`

Overrides

InstancesClient.GrpcClient

Methods

DebugInstance(DebugInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadataV1> DebugInstance(DebugInstanceRequest request, CallSettings callSettings = null)

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.

Only applicable for instances in App Engine flexible environment.

Parameters
Name	Description
`request`	`DebugInstanceRequest` 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
`OperationInstanceOperationMetadataV1`	The RPC response.

Overrides

InstancesClient.DebugInstance(DebugInstanceRequest, CallSettings)

DebugInstanceAsync(DebugInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadataV1>> DebugInstanceAsync(DebugInstanceRequest request, CallSettings callSettings = null)

Only applicable for instances in App Engine flexible environment.

Parameters
Name	Description
`request`	`DebugInstanceRequest` 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
`TaskOperationInstanceOperationMetadataV1`	A Task containing the RPC response.

Overrides

InstancesClient.DebugInstanceAsync(DebugInstanceRequest, CallSettings)

DeleteInstance(DeleteInstanceRequest, CallSettings)

public override Operation<Empty, OperationMetadataV1> DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)

Stops a running instance.

The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment | flexible environment).

To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch method.

Parameters
Name	Description
`request`	`DeleteInstanceRequest` 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

InstancesClient.DeleteInstance(DeleteInstanceRequest, CallSettings)

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

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

Stops a running instance.

The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment | flexible environment).

Parameters
Name	Description
`request`	`DeleteInstanceRequest` 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

InstancesClient.DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

GetInstance(GetInstanceRequest, CallSettings)

public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)

Gets instance information.

Parameters
Name	Description
`request`	`GetInstanceRequest` 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
`Instance`	The RPC response.

Overrides

InstancesClient.GetInstance(GetInstanceRequest, CallSettings)

GetInstanceAsync(GetInstanceRequest, CallSettings)

public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)

Gets instance information.

Parameters
Name	Description
`request`	`GetInstanceRequest` 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
`TaskInstance`	A Task containing the RPC response.

Overrides

InstancesClient.GetInstanceAsync(GetInstanceRequest, CallSettings)

ListInstances(ListInstancesRequest, CallSettings)

public override PagedEnumerable<ListInstancesResponse, Instance> ListInstances(ListInstancesRequest request, CallSettings callSettings = null)

Lists the instances of a version.

Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API.

Parameters
Name	Description
`request`	`ListInstancesRequest` 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
`PagedEnumerableListInstancesResponseInstance`	A pageable sequence of Instance resources.

Overrides

InstancesClient.ListInstances(ListInstancesRequest, CallSettings)

ListInstancesAsync(ListInstancesRequest, CallSettings)

public override PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)

Lists the instances of a version.

Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API.

Parameters
Name	Description
`request`	`ListInstancesRequest` 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
`PagedAsyncEnumerableListInstancesResponseInstance`	A pageable asynchronous sequence of Instance resources.

Overrides

InstancesClient.ListInstancesAsync(ListInstancesRequest, CallSettings)