Google Cloud Discovery Engine V1 Client - Class UserLicense (1.6.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class UserLicense.

User License information assigned by the admin.

Generated from protobuf message google.cloud.discoveryengine.v1.UserLicense

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ user_principal`	`string` Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.
`↳ user_profile`	`string` Optional. The user profile. We user user full name(First name + Last name) as user profile.
`↳ license_assignment_state`	`int` Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;
`↳ license_config`	`string` Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. User created timestamp.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. User update timestamp.
`↳ last_login_time`	`Google\Protobuf\Timestamp` Output only. User last logged in time. If the user has not logged in yet, this field will be empty.

getUserPrincipal

Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.

Returns
Type	Description
`string`

setUserPrincipal

Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUserProfile

Optional. The user profile.

We user user full name(First name + Last name) as user profile.

Returns
Type	Description
`string`

setUserProfile

Optional. The user profile.

We user user full name(First name + Last name) as user profile.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLicenseAssignmentState

Output only. License assignment state of the user.

If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;

Returns
Type	Description
`int`

setLicenseAssignmentState

Output only. License assignment state of the user.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getLicenseConfig

Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.

Returns
Type	Description
`string`

setLicenseConfig

Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. User created timestamp.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime