Google Cloud OS Login v1beta API - Class OsLoginServiceClientImpl (3.0.0-beta07) 

public sealed class OsLoginServiceClientImpl : OsLoginServiceClient

Reference documentation and code samples for the Google Cloud OS Login v1beta API class OsLoginServiceClientImpl.

OsLoginService client wrapper implementation, for convenient use.

Inheritance

object > OsLoginServiceClient > OsLoginServiceClientImpl

Namespace

Google.Cloud.OsLogin.V1Beta

Assembly

Google.Cloud.OsLogin.V1Beta.dll

Remarks

Cloud OS Login API

The Cloud OS Login API allows you to manage users and their associated SSH public keys for logging into virtual machines on Google Cloud Platform.

Constructors

OsLoginServiceClientImpl(OsLoginServiceClient, OsLoginServiceSettings, ILogger)

public OsLoginServiceClientImpl(OsLoginService.OsLoginServiceClient grpcClient, OsLoginServiceSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientOsLoginServiceOsLoginServiceClient

The underlying gRPC client.

settingsOsLoginServiceSettings

The base OsLoginServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override OsLoginService.OsLoginServiceClient GrpcClient { get; }

The underlying gRPC OsLoginService client

Property Value
TypeDescription
OsLoginServiceOsLoginServiceClient
Overrides

Methods

CreateSshPublicKey(CreateSshPublicKeyRequest, CallSettings)

public override SshPublicKey CreateSshPublicKey(CreateSshPublicKeyRequest request, CallSettings callSettings = null)

Create an SSH public key

Parameters
NameDescription
requestCreateSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SshPublicKey

The RPC response.

Overrides

CreateSshPublicKeyAsync(CreateSshPublicKeyRequest, CallSettings)

public override Task<SshPublicKey> CreateSshPublicKeyAsync(CreateSshPublicKeyRequest request, CallSettings callSettings = null)

Create an SSH public key

Parameters
NameDescription
requestCreateSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskSshPublicKey

A Task containing the RPC response.

Overrides

DeletePosixAccount(DeletePosixAccountRequest, CallSettings)

public override void DeletePosixAccount(DeletePosixAccountRequest request, CallSettings callSettings = null)

Deletes a POSIX account.

Parameters
NameDescription
requestDeletePosixAccountRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeletePosixAccountAsync(DeletePosixAccountRequest, CallSettings)

public override Task DeletePosixAccountAsync(DeletePosixAccountRequest request, CallSettings callSettings = null)

Deletes a POSIX account.

Parameters
NameDescription
requestDeletePosixAccountRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

DeleteSshPublicKey(DeleteSshPublicKeyRequest, CallSettings)

public override void DeleteSshPublicKey(DeleteSshPublicKeyRequest request, CallSettings callSettings = null)

Deletes an SSH public key.

Parameters
NameDescription
requestDeleteSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteSshPublicKeyAsync(DeleteSshPublicKeyRequest, CallSettings)

public override Task DeleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request, CallSettings callSettings = null)

Deletes an SSH public key.

Parameters
NameDescription
requestDeleteSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GetLoginProfile(GetLoginProfileRequest, CallSettings)

public override LoginProfile GetLoginProfile(GetLoginProfileRequest request, CallSettings callSettings = null)

Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

Parameters
NameDescription
requestGetLoginProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
LoginProfile

The RPC response.

Overrides

GetLoginProfileAsync(GetLoginProfileRequest, CallSettings)

public override Task<LoginProfile> GetLoginProfileAsync(GetLoginProfileRequest request, CallSettings callSettings = null)

Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

Parameters
NameDescription
requestGetLoginProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskLoginProfile

A Task containing the RPC response.

Overrides

GetSshPublicKey(GetSshPublicKeyRequest, CallSettings)

public override SshPublicKey GetSshPublicKey(GetSshPublicKeyRequest request, CallSettings callSettings = null)

Retrieves an SSH public key.

Parameters
NameDescription
requestGetSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SshPublicKey

The RPC response.

Overrides

GetSshPublicKeyAsync(GetSshPublicKeyRequest, CallSettings)

public override Task<SshPublicKey> GetSshPublicKeyAsync(GetSshPublicKeyRequest request, CallSettings callSettings = null)

Retrieves an SSH public key.

Parameters
NameDescription
requestGetSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskSshPublicKey

A Task containing the RPC response.

Overrides

ImportSshPublicKey(ImportSshPublicKeyRequest, CallSettings)

public override ImportSshPublicKeyResponse ImportSshPublicKey(ImportSshPublicKeyRequest request, CallSettings callSettings = null)

Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.

Parameters
NameDescription
requestImportSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ImportSshPublicKeyResponse

The RPC response.

Overrides

ImportSshPublicKeyAsync(ImportSshPublicKeyRequest, CallSettings)

public override Task<ImportSshPublicKeyResponse> ImportSshPublicKeyAsync(ImportSshPublicKeyRequest request, CallSettings callSettings = null)

Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.

Parameters
NameDescription
requestImportSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskImportSshPublicKeyResponse

A Task containing the RPC response.

Overrides

SignSshPublicKey(SignSshPublicKeyRequest, CallSettings)

public override SignSshPublicKeyResponse SignSshPublicKey(SignSshPublicKeyRequest request, CallSettings callSettings = null)

Signs an SSH public key for a user to authenticate to an instance.

Parameters
NameDescription
requestSignSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SignSshPublicKeyResponse

The RPC response.

Overrides

SignSshPublicKeyAsync(SignSshPublicKeyRequest, CallSettings)

public override Task<SignSshPublicKeyResponse> SignSshPublicKeyAsync(SignSshPublicKeyRequest request, CallSettings callSettings = null)

Signs an SSH public key for a user to authenticate to an instance.

Parameters
NameDescription
requestSignSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskSignSshPublicKeyResponse

A Task containing the RPC response.

Overrides

UpdateSshPublicKey(UpdateSshPublicKeyRequest, CallSettings)

public override SshPublicKey UpdateSshPublicKey(UpdateSshPublicKeyRequest request, CallSettings callSettings = null)

Updates an SSH public key and returns the profile information. This method supports patch semantics.

Parameters
NameDescription
requestUpdateSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SshPublicKey

The RPC response.

Overrides

UpdateSshPublicKeyAsync(UpdateSshPublicKeyRequest, CallSettings)

public override Task<SshPublicKey> UpdateSshPublicKeyAsync(UpdateSshPublicKeyRequest request, CallSettings callSettings = null)

Updates an SSH public key and returns the profile information. This method supports patch semantics.

Parameters
NameDescription
requestUpdateSshPublicKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskSshPublicKey

A Task containing the RPC response.

Overrides