PosixAccount

google.cloud.oslogin.common. PosixAccount

Represents a PosixAccount.

Constructor

new PosixAccount(propertiesopt)

Constructs a new PosixAccount.

Parameters:
Name Type Attributes Description
properties google.cloud.oslogin.common.IPosixAccount <optional>

Properties to set

Implements:
  • IPosixAccount

Members

accountId

PosixAccount accountId.

gecos

PosixAccount gecos.

gid

PosixAccount gid.

homeDirectory

PosixAccount homeDirectory.

name

PosixAccount name.

operatingSystemType

PosixAccount operatingSystemType.

primary

PosixAccount primary.

shell

PosixAccount shell.

systemId

PosixAccount systemId.

uid

PosixAccount uid.

username

PosixAccount username.

Methods

(static) create(propertiesopt) → {google.cloud.oslogin.common.PosixAccount}

Creates a new PosixAccount instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.oslogin.common.IPosixAccount <optional>

Properties to set

Returns:
Type Description
google.cloud.oslogin.common.PosixAccount

PosixAccount instance

(static) decode(reader, lengthopt) → {google.cloud.oslogin.common.PosixAccount}

Decodes a PosixAccount message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.oslogin.common.PosixAccount

PosixAccount

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.oslogin.common.PosixAccount}

Decodes a PosixAccount message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.oslogin.common.PosixAccount

PosixAccount

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified PosixAccount message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.oslogin.common.IPosixAccount

PosixAccount message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified PosixAccount message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.oslogin.common.IPosixAccount

PosixAccount message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.oslogin.common.PosixAccount}

Creates a PosixAccount message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.oslogin.common.PosixAccount

PosixAccount

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a PosixAccount message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.oslogin.common.PosixAccount

PosixAccount

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a PosixAccount message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this PosixAccount to JSON.

Returns:
Type Description
Object.<string, *>

JSON object