Represents a PosixAccount.
Package
@google-cloud/os-loginConstructors
(constructor)(properties)
constructor(properties?: google.cloud.oslogin.common.IPosixAccount);Constructs a new PosixAccount.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPosixAccount
Properties to set |
Properties
accountId
public accountId: string;PosixAccount accountId.
gecos
public gecos: string;PosixAccount gecos.
gid
public gid: (number|Long|string);PosixAccount gid.
homeDirectory
public homeDirectory: string;PosixAccount homeDirectory.
name
public name: string;PosixAccount name.
operatingSystemType
public operatingSystemType: (google.cloud.oslogin.common.OperatingSystemType|keyof typeof google.cloud.oslogin.common.OperatingSystemType);PosixAccount operatingSystemType.
primary
public primary: boolean;PosixAccount primary.
shell
public shell: string;PosixAccount shell.
systemId
public systemId: string;PosixAccount systemId.
uid
public uid: (number|Long|string);PosixAccount uid.
username
public username: string;PosixAccount username.
Methods
create(properties)
public static create(properties?: google.cloud.oslogin.common.IPosixAccount): google.cloud.oslogin.common.PosixAccount;Creates a new PosixAccount instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IPosixAccount
Properties to set |
| Returns | |
|---|---|
| Type | Description |
PosixAccount | PosixAccount instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.oslogin.common.PosixAccount;Decodes a PosixAccount message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
PosixAccount | PosixAccount |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.oslogin.common.PosixAccount;Decodes a PosixAccount message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
PosixAccount | PosixAccount |
encode(message, writer)
public static encode(message: google.cloud.oslogin.common.IPosixAccount, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PosixAccount message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPosixAccount
PosixAccount message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.oslogin.common.IPosixAccount, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified PosixAccount message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IPosixAccount
PosixAccount message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.oslogin.common.PosixAccount;Creates a PosixAccount message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
PosixAccount | PosixAccount |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for PosixAccount
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this PosixAccount to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.oslogin.common.PosixAccount, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a PosixAccount message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
PosixAccount
PosixAccount |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a PosixAccount message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|