Constructor
new OsLoginServiceClient(optionsopt, gaxInstanceopt)
Construct an instance of OsLoginServiceClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
close() → {Promise}
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves when the client is closed. |
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
initialize() → {Promise}
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to an authenticated service stub. |
matchFingerprintFromSshPublicKeyName(sshPublicKeyName) → {string}
Parse the fingerprint from SshPublicKey resource.
Parameters:
Name | Type | Description |
---|---|---|
sshPublicKeyName |
string |
A fully-qualified path representing SshPublicKey resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the fingerprint. |
matchProjectFromPosixAccountName(posixAccountName) → {string}
Parse the project from PosixAccount resource.
Parameters:
Name | Type | Description |
---|---|---|
posixAccountName |
string |
A fully-qualified path representing PosixAccount resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchUserFromPosixAccountName(posixAccountName) → {string}
Parse the user from PosixAccount resource.
Parameters:
Name | Type | Description |
---|---|---|
posixAccountName |
string |
A fully-qualified path representing PosixAccount resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the user. |
matchUserFromSshPublicKeyName(sshPublicKeyName) → {string}
Parse the user from SshPublicKey resource.
Parameters:
Name | Type | Description |
---|---|---|
sshPublicKeyName |
string |
A fully-qualified path representing SshPublicKey resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the user. |
matchUserFromUserName(userName) → {string}
Parse the user from User resource.
Parameters:
Name | Type | Description |
---|---|---|
userName |
string |
A fully-qualified path representing User resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the user. |
posixAccountPath(user, project) → {string}
Return a fully-qualified posixAccount resource name string.
Parameters:
Name | Type | Description |
---|---|---|
user |
string | |
project |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
sshPublicKeyPath(user, fingerprint) → {string}
Return a fully-qualified sshPublicKey resource name string.
Parameters:
Name | Type | Description |
---|---|---|
user |
string | |
fingerprint |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
userPath(user) → {string}
Return a fully-qualified user resource name string.
Parameters:
Name | Type | Description |
---|---|---|
user |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |