OsLoginService

google.cloud.oslogin.v1beta. OsLoginService

Represents an OsLoginService

Constructor

new OsLoginService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new OsLoginService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {OsLoginService}

Creates new OsLoginService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
OsLoginService

RPC service. Useful where requests and/or responses are streamed.

deletePosixAccount(request, callback) → {undefined}

Calls DeletePosixAccount.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IDeletePosixAccountRequest

DeletePosixAccountRequest message or plain object

callback google.cloud.oslogin.v1beta.OsLoginService.DeletePosixAccountCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deletePosixAccount(request) → {Promise.<google.protobuf.Empty>}

Calls DeletePosixAccount.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IDeletePosixAccountRequest

DeletePosixAccountRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteSshPublicKey(request, callback) → {undefined}

Calls DeleteSshPublicKey.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest

DeleteSshPublicKeyRequest message or plain object

callback google.cloud.oslogin.v1beta.OsLoginService.DeleteSshPublicKeyCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteSshPublicKey(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteSshPublicKey.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest

DeleteSshPublicKeyRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

getLoginProfile(request, callback) → {undefined}

Calls GetLoginProfile.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IGetLoginProfileRequest

GetLoginProfileRequest message or plain object

callback google.cloud.oslogin.v1beta.OsLoginService.GetLoginProfileCallback

Node-style callback called with the error, if any, and LoginProfile

Returns:
Type Description
undefined

getLoginProfile(request) → {Promise.<google.cloud.oslogin.v1beta.LoginProfile>}

Calls GetLoginProfile.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IGetLoginProfileRequest

GetLoginProfileRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.oslogin.v1beta.LoginProfile>

Promise

getSshPublicKey(request, callback) → {undefined}

Calls GetSshPublicKey.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest

GetSshPublicKeyRequest message or plain object

callback google.cloud.oslogin.v1beta.OsLoginService.GetSshPublicKeyCallback

Node-style callback called with the error, if any, and SshPublicKey

Returns:
Type Description
undefined

getSshPublicKey(request) → {Promise.<google.cloud.oslogin.common.SshPublicKey>}

Calls GetSshPublicKey.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest

GetSshPublicKeyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.oslogin.common.SshPublicKey>

Promise

importSshPublicKey(request, callback) → {undefined}

Calls ImportSshPublicKey.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest

ImportSshPublicKeyRequest message or plain object

callback google.cloud.oslogin.v1beta.OsLoginService.ImportSshPublicKeyCallback

Node-style callback called with the error, if any, and ImportSshPublicKeyResponse

Returns:
Type Description
undefined

importSshPublicKey(request) → {Promise.<google.cloud.oslogin.v1beta.ImportSshPublicKeyResponse>}

Calls ImportSshPublicKey.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest

ImportSshPublicKeyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.oslogin.v1beta.ImportSshPublicKeyResponse>

Promise

updateSshPublicKey(request, callback) → {undefined}

Calls UpdateSshPublicKey.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest

UpdateSshPublicKeyRequest message or plain object

callback google.cloud.oslogin.v1beta.OsLoginService.UpdateSshPublicKeyCallback

Node-style callback called with the error, if any, and SshPublicKey

Returns:
Type Description
undefined

updateSshPublicKey(request) → {Promise.<google.cloud.oslogin.common.SshPublicKey>}

Calls UpdateSshPublicKey.

Parameters:
Name Type Description
request google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest

UpdateSshPublicKeyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.oslogin.common.SshPublicKey>

Promise

Type Definitions

DeletePosixAccountCallback(error, responseopt)

Callback as used by google.cloud.oslogin.v1beta.OsLoginService#deletePosixAccount.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DeleteSshPublicKeyCallback(error, responseopt)

Callback as used by google.cloud.oslogin.v1beta.OsLoginService#deleteSshPublicKey.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

GetLoginProfileCallback(error, responseopt)

Callback as used by google.cloud.oslogin.v1beta.OsLoginService#getLoginProfile.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.oslogin.v1beta.LoginProfile <optional>

LoginProfile

GetSshPublicKeyCallback(error, responseopt)

Callback as used by google.cloud.oslogin.v1beta.OsLoginService#getSshPublicKey.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.oslogin.common.SshPublicKey <optional>

SshPublicKey

ImportSshPublicKeyCallback(error, responseopt)

Callback as used by google.cloud.oslogin.v1beta.OsLoginService#importSshPublicKey.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.oslogin.v1beta.ImportSshPublicKeyResponse <optional>

ImportSshPublicKeyResponse

UpdateSshPublicKeyCallback(error, responseopt)

Callback as used by google.cloud.oslogin.v1beta.OsLoginService#updateSshPublicKey.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.oslogin.common.SshPublicKey <optional>

SshPublicKey