Send feedback
Class Principal (0.60.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class Principal extends GeneratedMessageV3 implements PrincipalOrBuilder
Principal identifier of a user or a group.
Protobuf type google.cloud.discoveryengine.v1.Principal
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
EXTERNAL_ENTITY_ID_FIELD_NUMBER
public static final int EXTERNAL_ENTITY_ID_FIELD_NUMBER
Field Value
Type Description
int
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Principal . Builder newBuilder ()
newBuilder(Principal prototype)
public static Principal . Builder newBuilder ( Principal prototype )
Parameter
Name Description
prototypePrincipal
public static Principal parseDelimitedFrom ( InputStream input )
public static Principal parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Principal parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Principal parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Principal parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Principal parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Principal parseFrom ( CodedInputStream input )
public static Principal parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Principal parseFrom ( InputStream input )
public static Principal parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Principal parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Principal parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Principal> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Principal getDefaultInstanceForType ()
getExternalEntityId()
public String getExternalEntityId ()
For 3P application identities which are not present in the customer
identity provider.
string external_entity_id = 3;
Returns
Type Description
String The externalEntityId.
getExternalEntityIdBytes()
public ByteString getExternalEntityIdBytes ()
For 3P application identities which are not present in the customer
identity provider.
string external_entity_id = 3;
Returns
Type Description
ByteString The bytes for externalEntityId.
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 ()
Overrides
getPrincipalCase()
public Principal . PrincipalCase getPrincipalCase ()
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.
hasExternalEntityId()
public boolean hasExternalEntityId ()
For 3P application identities which are not present in the customer
identity provider.
string external_entity_id = 3;
Returns
Type Description
boolean Whether the externalEntityId field is set.
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Principal . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Principal . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Principal . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-12 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-12 UTC."],[],[]]
