Class UserLicense (0.60.0)

public final class UserLicense extends GeneratedMessageV3 implements UserLicenseOrBuilder

User License information assigned by the admin.

Protobuf type google.cloud.discoveryengine.v1.UserLicense

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

LAST_LOGIN_TIME_FIELD_NUMBER

public static final int LAST_LOGIN_TIME_FIELD_NUMBER
Field Value
Type Description
int

LICENSE_ASSIGNMENT_STATE_FIELD_NUMBER

public static final int LICENSE_ASSIGNMENT_STATE_FIELD_NUMBER
Field Value
Type Description
int

LICENSE_CONFIG_FIELD_NUMBER

public static final int LICENSE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

USER_PRINCIPAL_FIELD_NUMBER

public static final int USER_PRINCIPAL_FIELD_NUMBER
Field Value
Type Description
int

USER_PROFILE_FIELD_NUMBER

public static final int USER_PROFILE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UserLicense getDefaultInstance()
Returns
Type Description
UserLicense

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static UserLicense.Builder newBuilder()
Returns
Type Description
UserLicense.Builder

newBuilder(UserLicense prototype)

public static UserLicense.Builder newBuilder(UserLicense prototype)
Parameter
Name Description
prototype UserLicense
Returns
Type Description
UserLicense.Builder

parseDelimitedFrom(InputStream input)

public static UserLicense parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UserLicense
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserLicense parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserLicense
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UserLicense parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UserLicense
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UserLicense parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserLicense
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UserLicense parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UserLicense
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UserLicense parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserLicense
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UserLicense parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UserLicense
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UserLicense parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserLicense
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UserLicense parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UserLicense
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserLicense parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserLicense
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UserLicense parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UserLicense
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UserLicense parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserLicense
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UserLicense> parser()
Returns
Type Description
Parser<UserLicense>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. User created timestamp.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. User created timestamp.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public UserLicense getDefaultInstanceForType()
Returns
Type Description
UserLicense

getLastLoginTime()

public Timestamp getLastLoginTime()

Output only. User last logged in time. If the user has not logged in yet, this field will be empty.

.google.protobuf.Timestamp last_login_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The lastLoginTime.

getLastLoginTimeOrBuilder()

public TimestampOrBuilder getLastLoginTimeOrBuilder()

Output only. User last logged in time. If the user has not logged in yet, this field will be empty.

.google.protobuf.Timestamp last_login_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getLicenseAssignmentState()

public UserLicense.LicenseAssignmentState 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;

.google.cloud.discoveryengine.v1.UserLicense.LicenseAssignmentState license_assignment_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
UserLicense.LicenseAssignmentState

The licenseAssignmentState.

getLicenseAssignmentStateValue()

public int getLicenseAssignmentStateValue()

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;

.google.cloud.discoveryengine.v1.UserLicense.LicenseAssignmentState license_assignment_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for licenseAssignmentState.

getLicenseConfig()

public String getLicenseConfig()

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

string license_config = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The licenseConfig.

getLicenseConfigBytes()

public ByteString getLicenseConfigBytes()

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

string license_config = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for licenseConfig.

getParserForType()

public Parser<UserLicense> getParserForType()
Returns
Type Description
Parser<UserLicense>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. User update timestamp.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. User update timestamp.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getUserPrincipal()

public String 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.

string user_principal = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The userPrincipal.

getUserPrincipalBytes()

public ByteString getUserPrincipalBytes()

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.

string user_principal = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for userPrincipal.

getUserProfile()

public String getUserProfile()

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

string user_profile = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The userProfile.

getUserProfileBytes()

public ByteString getUserProfileBytes()

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

string user_profile = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for userProfile.

hasCreateTime()

public boolean hasCreateTime()

Output only. User created timestamp.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasLastLoginTime()

public boolean hasLastLoginTime()

Output only. User last logged in time. If the user has not logged in yet, this field will be empty.

.google.protobuf.Timestamp last_login_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the lastLoginTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. User update timestamp.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UserLicense.Builder newBuilderForType()
Returns
Type Description
UserLicense.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UserLicense.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UserLicense.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UserLicense.Builder toBuilder()
Returns
Type Description
UserLicense.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException