Google Cloud OS Login v1 API - Class OsLoginService.OsLoginServiceClient (3.2.0)

Version 3.2.0

• 3.4.0 (latest)
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.3.0
• 2.2.0

public class OsLoginService.OsLoginServiceClient : ClientBase<OsLoginService.OsLoginServiceClient>

Reference documentation and code samples for the Google Cloud OS Login v1 API class OsLoginService.OsLoginServiceClient.

Client for OsLoginService

Inheritance

object > ClientBase > ClientBaseOsLoginServiceOsLoginServiceClient > OsLoginService.OsLoginServiceClient

Inherited Members

ClientBase<OsLoginService.OsLoginServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.OsLogin.V1

Assembly

Google.Cloud.OsLogin.V1.dll

Constructors

OsLoginServiceClient()

protected OsLoginServiceClient()

Protected parameterless constructor to allow creation of test doubles.

OsLoginServiceClient(CallInvoker)

public OsLoginServiceClient(CallInvoker callInvoker)

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

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

OsLoginServiceClient(ChannelBase)

public OsLoginServiceClient(ChannelBase channel)

Creates a new client for OsLoginService

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

OsLoginServiceClient(ClientBaseConfiguration)

protected OsLoginServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateSshPublicKey(CreateSshPublicKeyRequest, CallOptions)

public virtual SshPublicKey CreateSshPublicKey(CreateSshPublicKeyRequest request, CallOptions options)

Create an SSH public key

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

Returns
Type	Description
SshPublicKey	The response received from the server.

CreateSshPublicKey(CreateSshPublicKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual SshPublicKey CreateSshPublicKey(CreateSshPublicKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create an SSH public key

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

CreateSshPublicKeyAsync(CreateSshPublicKeyRequest, CallOptions)

public virtual AsyncUnaryCall<SshPublicKey> CreateSshPublicKeyAsync(CreateSshPublicKeyRequest request, CallOptions options)

Create an SSH public key

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

Returns
Type	Description
AsyncUnaryCallSshPublicKey	The call object.

CreateSshPublicKeyAsync(CreateSshPublicKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SshPublicKey> CreateSshPublicKeyAsync(CreateSshPublicKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create an SSH public key

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

DeletePosixAccount(DeletePosixAccountRequest, CallOptions)

public virtual Empty DeletePosixAccount(DeletePosixAccountRequest request, CallOptions options)

Deletes a POSIX account.

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

Returns
Type	Description
Empty	The response received from the server.

DeletePosixAccount(DeletePosixAccountRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeletePosixAccount(DeletePosixAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a POSIX account.

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

DeletePosixAccountAsync(DeletePosixAccountRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeletePosixAccountAsync(DeletePosixAccountRequest request, CallOptions options)

Deletes a POSIX account.

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

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeletePosixAccountAsync(DeletePosixAccountRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeletePosixAccountAsync(DeletePosixAccountRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a POSIX account.

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

DeleteSshPublicKey(DeleteSshPublicKeyRequest, CallOptions)

public virtual Empty DeleteSshPublicKey(DeleteSshPublicKeyRequest request, CallOptions options)

Deletes an SSH public key.

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

Returns
Type	Description
Empty	The response received from the server.

DeleteSshPublicKey(DeleteSshPublicKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteSshPublicKey(DeleteSshPublicKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an SSH public key.

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

DeleteSshPublicKeyAsync(DeleteSshPublicKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request, CallOptions options)

Deletes an SSH public key.

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

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteSshPublicKeyAsync(DeleteSshPublicKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteSshPublicKeyAsync(DeleteSshPublicKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an SSH public key.

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

GetLoginProfile(GetLoginProfileRequest, CallOptions)

public virtual LoginProfile GetLoginProfile(GetLoginProfileRequest request, CallOptions options)

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

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

Returns
Type	Description
LoginProfile	The response received from the server.

GetLoginProfile(GetLoginProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual LoginProfile GetLoginProfile(GetLoginProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

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

GetLoginProfileAsync(GetLoginProfileRequest, CallOptions)

public virtual AsyncUnaryCall<LoginProfile> GetLoginProfileAsync(GetLoginProfileRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallLoginProfile	The call object.

GetLoginProfileAsync(GetLoginProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<LoginProfile> GetLoginProfileAsync(GetLoginProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

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

GetSshPublicKey(GetSshPublicKeyRequest, CallOptions)

public virtual SshPublicKey GetSshPublicKey(GetSshPublicKeyRequest request, CallOptions options)

Retrieves an SSH public key.

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

Returns
Type	Description
SshPublicKey	The response received from the server.

GetSshPublicKey(GetSshPublicKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual SshPublicKey GetSshPublicKey(GetSshPublicKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an SSH public key.

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

GetSshPublicKeyAsync(GetSshPublicKeyRequest, CallOptions)

public virtual AsyncUnaryCall<SshPublicKey> GetSshPublicKeyAsync(GetSshPublicKeyRequest request, CallOptions options)

Retrieves an SSH public key.

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

Returns
Type	Description
AsyncUnaryCallSshPublicKey	The call object.

GetSshPublicKeyAsync(GetSshPublicKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SshPublicKey> GetSshPublicKeyAsync(GetSshPublicKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an SSH public key.

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

ImportSshPublicKey(ImportSshPublicKeyRequest, CallOptions)

public virtual ImportSshPublicKeyResponse ImportSshPublicKey(ImportSshPublicKeyRequest request, CallOptions options)

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
Name	Description
request	ImportSshPublicKeyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ImportSshPublicKeyResponse	The response received from the server.

ImportSshPublicKey(ImportSshPublicKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual ImportSshPublicKeyResponse ImportSshPublicKey(ImportSshPublicKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	ImportSshPublicKeyRequest 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
ImportSshPublicKeyResponse	The response received from the server.

ImportSshPublicKeyAsync(ImportSshPublicKeyRequest, CallOptions)

public virtual AsyncUnaryCall<ImportSshPublicKeyResponse> ImportSshPublicKeyAsync(ImportSshPublicKeyRequest request, CallOptions options)

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
Name	Description
request	ImportSshPublicKeyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallImportSshPublicKeyResponse	The call object.

ImportSshPublicKeyAsync(ImportSshPublicKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ImportSshPublicKeyResponse> ImportSshPublicKeyAsync(ImportSshPublicKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	ImportSshPublicKeyRequest 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
AsyncUnaryCallImportSshPublicKeyResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override OsLoginService.OsLoginServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
OsLoginServiceOsLoginServiceClient

Overrides

ClientBase<OsLoginService.OsLoginServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateSshPublicKey(UpdateSshPublicKeyRequest, CallOptions)

public virtual SshPublicKey UpdateSshPublicKey(UpdateSshPublicKeyRequest request, CallOptions options)

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

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

Returns
Type	Description
SshPublicKey	The response received from the server.

UpdateSshPublicKey(UpdateSshPublicKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual SshPublicKey UpdateSshPublicKey(UpdateSshPublicKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

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

UpdateSshPublicKeyAsync(UpdateSshPublicKeyRequest, CallOptions)

public virtual AsyncUnaryCall<SshPublicKey> UpdateSshPublicKeyAsync(UpdateSshPublicKeyRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallSshPublicKey	The call object.

UpdateSshPublicKeyAsync(UpdateSshPublicKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SshPublicKey> UpdateSshPublicKeyAsync(UpdateSshPublicKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

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