Class Principal (0.35.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
TypeDescription
int

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Principal getDefaultInstance()
Returns
TypeDescription
Principal

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Principal.Builder newBuilder()
Returns
TypeDescription
Principal.Builder

newBuilder(Principal prototype)

public static Principal.Builder newBuilder(Principal prototype)
Parameter
NameDescription
prototypePrincipal
Returns
TypeDescription
Principal.Builder

parseDelimitedFrom(InputStream input)

public static Principal parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Principal
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Principal parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Principal
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Principal parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Principal
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Principal parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Principal
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Principal parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Principal
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Principal parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Principal
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Principal parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Principal
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Principal parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Principal
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Principal parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Principal
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Principal parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Principal
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Principal parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Principal
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Principal parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Principal
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Principal> parser()
Returns
TypeDescription
Parser<Principal>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Principal getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for groupId.

getParserForType()

public Parser<Principal> getParserForType()
Returns
TypeDescription
Parser<Principal>
Overrides

getPrincipalCase()

public Principal.PrincipalCase getPrincipalCase()
Returns
TypeDescription
Principal.PrincipalCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the userId field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Principal.Builder newBuilderForType()
Returns
TypeDescription
Principal.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Principal.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Principal.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Principal.Builder toBuilder()
Returns
TypeDescription
Principal.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException