Cloud Run Admin v2 API - Class InstancesClientImpl (2.19.0)

Version latest

• 2.19.0 (latest)
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0-beta02

public sealed class InstancesClientImpl : InstancesClient

Reference documentation and code samples for the Cloud Run Admin v2 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.CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

InstancesClient.PollOnceCreateInstance(string, CallSettings)

InstancesClient.PollOnceCreateInstanceAsync(string, CallSettings)

InstancesClient.CreateInstance(string, Instance, CallSettings)

InstancesClient.CreateInstanceAsync(string, Instance, CallSettings)

InstancesClient.CreateInstanceAsync(string, Instance, CancellationToken)

InstancesClient.CreateInstance(LocationName, Instance, CallSettings)

InstancesClient.CreateInstanceAsync(LocationName, Instance, CallSettings)

InstancesClient.CreateInstanceAsync(LocationName, Instance, CancellationToken)

InstancesClient.DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

InstancesClient.PollOnceDeleteInstance(string, CallSettings)

InstancesClient.PollOnceDeleteInstanceAsync(string, CallSettings)

InstancesClient.DeleteInstance(string, CallSettings)

InstancesClient.DeleteInstanceAsync(string, CallSettings)

InstancesClient.DeleteInstanceAsync(string, CancellationToken)

InstancesClient.DeleteInstance(InstanceName, CallSettings)

InstancesClient.DeleteInstanceAsync(InstanceName, CallSettings)

InstancesClient.DeleteInstanceAsync(InstanceName, CancellationToken)

InstancesClient.GetInstanceAsync(GetInstanceRequest, CancellationToken)

InstancesClient.GetInstance(string, CallSettings)

InstancesClient.GetInstanceAsync(string, CallSettings)

InstancesClient.GetInstanceAsync(string, CancellationToken)

InstancesClient.GetInstance(InstanceName, CallSettings)

InstancesClient.GetInstanceAsync(InstanceName, CallSettings)

InstancesClient.GetInstanceAsync(InstanceName, CancellationToken)

InstancesClient.ListInstances(string, string, int?, CallSettings)

InstancesClient.ListInstancesAsync(string, string, int?, CallSettings)

InstancesClient.ListInstances(LocationName, string, int?, CallSettings)

InstancesClient.ListInstancesAsync(LocationName, string, int?, CallSettings)

InstancesClient.StopInstanceAsync(StopInstanceRequest, CancellationToken)

InstancesClient.PollOnceStopInstance(string, CallSettings)

InstancesClient.PollOnceStopInstanceAsync(string, CallSettings)

InstancesClient.StopInstance(string, CallSettings)

InstancesClient.StopInstanceAsync(string, CallSettings)

InstancesClient.StopInstanceAsync(string, CancellationToken)

InstancesClient.StopInstance(InstanceName, CallSettings)

InstancesClient.StopInstanceAsync(InstanceName, CallSettings)

InstancesClient.StopInstanceAsync(InstanceName, CancellationToken)

InstancesClient.StartInstanceAsync(StartInstanceRequest, CancellationToken)

InstancesClient.PollOnceStartInstance(string, CallSettings)

InstancesClient.PollOnceStartInstanceAsync(string, CallSettings)

InstancesClient.StartInstance(string, CallSettings)

InstancesClient.StartInstanceAsync(string, CallSettings)

InstancesClient.StartInstanceAsync(string, CancellationToken)

InstancesClient.StartInstance(InstanceName, CallSettings)

InstancesClient.StartInstanceAsync(InstanceName, CallSettings)

InstancesClient.StartInstanceAsync(InstanceName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Run.V2

Assembly

Google.Cloud.Run.V2.dll

Remarks

The Cloud Run Instances API allows you to manage Cloud Run Instances.

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

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type	Description
OperationsClient

Overrides

InstancesClient.CreateInstanceOperationsClient

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

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

InstancesClient.LocationsClient

StartInstanceOperationsClient

public override OperationsClient StartInstanceOperationsClient { get; }

The long-running operations client for StartInstance.

Property Value
Type	Description
OperationsClient

Overrides

InstancesClient.StartInstanceOperationsClient

StopInstanceOperationsClient

public override OperationsClient StopInstanceOperationsClient { get; }

The long-running operations client for StopInstance.

Property Value
Type	Description
OperationsClient

Overrides

InstancesClient.StopInstanceOperationsClient

Methods

CreateInstance(CreateInstanceRequest, CallSettings)

public override Operation<Instance, Instance> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)

Creates an Instance.

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

Overrides

InstancesClient.CreateInstance(CreateInstanceRequest, CallSettings)

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

public override Task<Operation<Instance, Instance>> CreateInstanceAsync(CreateInstanceRequest request, CallSettings callSettings = null)

Creates an Instance.

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

Overrides

InstancesClient.CreateInstanceAsync(CreateInstanceRequest, CallSettings)

DeleteInstance(DeleteInstanceRequest, CallSettings)

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

Deletes a Instance

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
OperationInstanceInstance	The RPC response.

Overrides

InstancesClient.DeleteInstance(DeleteInstanceRequest, CallSettings)

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

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

Deletes a Instance

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
TaskOperationInstanceInstance	A Task containing the RPC response.

Overrides

InstancesClient.DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

GetInstance(GetInstanceRequest, CallSettings)

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

Gets a Instance

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 a Instance

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 Instances. Results are sorted by creation time, descending.

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 Instances. Results are sorted by creation time, descending.

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)

StartInstance(StartInstanceRequest, CallSettings)

public override Operation<Instance, Instance> StartInstance(StartInstanceRequest request, CallSettings callSettings = null)

Starts an Instance.

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

Overrides

InstancesClient.StartInstance(StartInstanceRequest, CallSettings)

StartInstanceAsync(StartInstanceRequest, CallSettings)

public override Task<Operation<Instance, Instance>> StartInstanceAsync(StartInstanceRequest request, CallSettings callSettings = null)

Starts an Instance.

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

Overrides

InstancesClient.StartInstanceAsync(StartInstanceRequest, CallSettings)

StopInstance(StopInstanceRequest, CallSettings)

public override Operation<Instance, Instance> StopInstance(StopInstanceRequest request, CallSettings callSettings = null)

Stops an Instance.

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

Overrides

InstancesClient.StopInstance(StopInstanceRequest, CallSettings)

StopInstanceAsync(StopInstanceRequest, CallSettings)

public override Task<Operation<Instance, Instance>> StopInstanceAsync(StopInstanceRequest request, CallSettings callSettings = null)

Stops an Instance.

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

Overrides

InstancesClient.StopInstanceAsync(StopInstanceRequest, CallSettings)