Google Cloud OsLogin Client - Class PosixAccount (1.8.0)

Reference documentation and code samples for the Google Cloud OsLogin Client class PosixAccount.

The POSIX account information associated with a Google account.

Generated from protobuf message google.cloud.oslogin.common.PosixAccount

Namespace

Google \ Cloud \ OsLogin \ Common

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ primary bool

Only one POSIX account can be marked as primary.

↳ username string

The username of the POSIX account.

↳ uid int|string

The user ID.

↳ gid int|string

The default group ID.

↳ home_directory string

The path to the home directory for this account.

↳ shell string

The path to the logic shell for this account.

↳ gecos string

The GECOS (user information) entry for this account.

↳ system_id string

System identifier for which account the username or uid applies to. By default, the empty value is used.

↳ account_id string

Output only. A POSIX account identifier.

↳ operating_system_type int

The operating system type where this account applies.

↳ name string

Output only. The canonical resource name.

getPrimary

Only one POSIX account can be marked as primary.

Returns
TypeDescription
bool

setPrimary

Only one POSIX account can be marked as primary.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getUsername

The username of the POSIX account.

Returns
TypeDescription
string

setUsername

The username of the POSIX account.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUid

The user ID.

Returns
TypeDescription
int|string

setUid

The user ID.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getGid

The default group ID.

Returns
TypeDescription
int|string

setGid

The default group ID.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getHomeDirectory

The path to the home directory for this account.

Returns
TypeDescription
string

setHomeDirectory

The path to the home directory for this account.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getShell

The path to the logic shell for this account.

Returns
TypeDescription
string

setShell

The path to the logic shell for this account.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getGecos

The GECOS (user information) entry for this account.

Returns
TypeDescription
string

setGecos

The GECOS (user information) entry for this account.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSystemId

System identifier for which account the username or uid applies to.

By default, the empty value is used.

Returns
TypeDescription
string

setSystemId

System identifier for which account the username or uid applies to.

By default, the empty value is used.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAccountId

Output only. A POSIX account identifier.

Returns
TypeDescription
string

setAccountId

Output only. A POSIX account identifier.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOperatingSystemType

The operating system type where this account applies.

Returns
TypeDescription
int

setOperatingSystemType

The operating system type where this account applies.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getName

Output only. The canonical resource name.

Returns
TypeDescription
string

setName

Output only. The canonical resource name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this