Class Principal (0.40.0)

public final class Principal extends GeneratedMessageV3 implements PrincipalOrBuilder

Principal identifier of a user or a group.

Protobuf type google.cloud.discoveryengine.v1alpha.Principal

Implements

PrincipalOrBuilder

Static Fields

GROUP_ID_FIELD_NUMBER

public static final int GROUP_ID_FIELD_NUMBER
Field Value
Type Description
int

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Principal getDefaultInstance()
Returns
Type Description
Principal

getDescriptor()

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

newBuilder()

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

newBuilder(Principal prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Principal getDefaultInstanceForType()
Returns
Type Description
Principal

getGroupId()

public String getGroupId()

Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.

string group_id = 2;

Returns
Type Description
String

The groupId.

getGroupIdBytes()

public ByteString getGroupIdBytes()

Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.

string group_id = 2;

Returns
Type Description
ByteString

The bytes for groupId.

getParserForType()

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

getPrincipalCase()

public Principal.PrincipalCase getPrincipalCase()
Returns
Type Description
Principal.PrincipalCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUserId()

public String getUserId()

User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.

string user_id = 1;

Returns
Type Description
String

The userId.

getUserIdBytes()

public ByteString getUserIdBytes()

User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.

string user_id = 1;

Returns
Type Description
ByteString

The bytes for userId.

hasGroupId()

public boolean hasGroupId()

Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.

string group_id = 2;

Returns
Type Description
boolean

Whether the groupId field is set.

hasUserId()

public boolean hasUserId()

User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.

string user_id = 1;

Returns
Type Description
boolean

Whether the userId 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 Principal.Builder newBuilderForType()
Returns
Type Description
Principal.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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