Cloud Shell v1 API - Class CloudShellService.CloudShellServiceClient (2.3.0)

Version 2.3.0

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.0

public class CloudShellService.CloudShellServiceClient : ClientBase<CloudShellService.CloudShellServiceClient>

Reference documentation and code samples for the Cloud Shell v1 API class CloudShellService.CloudShellServiceClient.

Client for CloudShellService

Inheritance

object > ClientBase > ClientBaseCloudShellServiceCloudShellServiceClient > CloudShellService.CloudShellServiceClient

Inherited Members

ClientBase<CloudShellService.CloudShellServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Shell.V1

Assembly

Google.Cloud.Shell.V1.dll

Constructors

CloudShellServiceClient()

protected CloudShellServiceClient()

Protected parameterless constructor to allow creation of test doubles.

CloudShellServiceClient(CallInvoker)

public CloudShellServiceClient(CallInvoker callInvoker)

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

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

CloudShellServiceClient(ChannelBase)

public CloudShellServiceClient(ChannelBase channel)

Creates a new client for CloudShellService

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

CloudShellServiceClient(ClientBaseConfiguration)

protected CloudShellServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AddPublicKey(AddPublicKeyRequest, CallOptions)

public virtual Operation AddPublicKey(AddPublicKeyRequest request, CallOptions options)

Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS.

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

Returns
Type	Description
Operation	The response received from the server.

AddPublicKey(AddPublicKeyRequest, Metadata, DateTime?, CancellationToken)

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

Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS.

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

AddPublicKeyAsync(AddPublicKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AddPublicKeyAsync(AddPublicKeyRequest request, CallOptions options)

Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

AddPublicKeyAsync(AddPublicKeyRequest, Metadata, DateTime?, CancellationToken)

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

Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS.

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

AuthorizeEnvironment(AuthorizeEnvironmentRequest, CallOptions)

public virtual Operation AuthorizeEnvironment(AuthorizeEnvironmentRequest request, CallOptions options)

Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.

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

Returns
Type	Description
Operation	The response received from the server.

AuthorizeEnvironment(AuthorizeEnvironmentRequest, Metadata, DateTime?, CancellationToken)

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

Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.

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

AuthorizeEnvironmentAsync(AuthorizeEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AuthorizeEnvironmentAsync(AuthorizeEnvironmentRequest request, CallOptions options)

Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

AuthorizeEnvironmentAsync(AuthorizeEnvironmentRequest, Metadata, DateTime?, CancellationToken)

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

Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.

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

GetEnvironment(GetEnvironmentRequest, CallOptions)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallOptions options)

Gets an environment. Returns NOT_FOUND if the environment does not exist.

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

Returns
Type	Description
Environment	The response received from the server.

GetEnvironment(GetEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an environment. Returns NOT_FOUND if the environment does not exist.

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

GetEnvironmentAsync(GetEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallOptions options)

Gets an environment. Returns NOT_FOUND if the environment does not exist.

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

Returns
Type	Description
AsyncUnaryCallEnvironment	The call object.

GetEnvironmentAsync(GetEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an environment. Returns NOT_FOUND if the environment does not exist.

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

NewInstance(ClientBaseConfiguration)

protected override CloudShellService.CloudShellServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
CloudShellServiceCloudShellServiceClient

Overrides

ClientBase<CloudShellService.CloudShellServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

RemovePublicKey(RemovePublicKeyRequest, CallOptions)

public virtual Operation RemovePublicKey(RemovePublicKeyRequest request, CallOptions options)

Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not present, this will error with NOT_FOUND.

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

Returns
Type	Description
Operation	The response received from the server.

RemovePublicKey(RemovePublicKeyRequest, Metadata, DateTime?, CancellationToken)

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

Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not present, this will error with NOT_FOUND.

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

RemovePublicKeyAsync(RemovePublicKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RemovePublicKeyAsync(RemovePublicKeyRequest request, CallOptions options)

Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not present, this will error with NOT_FOUND.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RemovePublicKeyAsync(RemovePublicKeyRequest, Metadata, DateTime?, CancellationToken)

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

Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not present, this will error with NOT_FOUND.

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

StartEnvironment(StartEnvironmentRequest, CallOptions)

public virtual Operation StartEnvironment(StartEnvironmentRequest request, CallOptions options)

Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.

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

Returns
Type	Description
Operation	The response received from the server.

StartEnvironment(StartEnvironmentRequest, Metadata, DateTime?, CancellationToken)

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

Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.

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

StartEnvironmentAsync(StartEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartEnvironmentAsync(StartEnvironmentRequest request, CallOptions options)

Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

StartEnvironmentAsync(StartEnvironmentRequest, Metadata, DateTime?, CancellationToken)

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

Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.

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