Class Principal.Builder (0.79.0)

public static final class Principal.Builder extends GeneratedMessage.Builder<Principal.Builder> implements PrincipalOrBuilder

Principal identifier of a user or a group.

Protobuf type google.cloud.discoveryengine.v1.Principal

Implements

PrincipalOrBuilder

Static Methods

getDescriptor()

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

Methods

build()

public Principal build()
Returns
Type Description
Principal

buildPartial()

public Principal buildPartial()
Returns
Type Description
Principal

clear()

public Principal.Builder clear()
Returns
Type Description
Principal.Builder
Overrides

clearExternalEntityId()

public Principal.Builder clearExternalEntityId()

For 3P application identities which are not present in the customer identity provider.

string external_entity_id = 3;

Returns
Type Description
Principal.Builder

This builder for chaining.

clearGroupId()

public Principal.Builder clearGroupId()

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
Principal.Builder

This builder for chaining.

clearPrincipal()

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

clearUserId()

public Principal.Builder clearUserId()

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
Principal.Builder

This builder for chaining.

getDefaultInstanceForType()

public Principal getDefaultInstanceForType()
Returns
Type Description
Principal

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getPrincipalCase()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Principal other)

public Principal.Builder mergeFrom(Principal other)
Parameter
Name Description
other Principal
Returns
Type Description
Principal.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Principal.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Principal.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Principal.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Principal.Builder
Overrides

setExternalEntityId(String value)

public Principal.Builder setExternalEntityId(String value)

For 3P application identities which are not present in the customer identity provider.

string external_entity_id = 3;

Parameter
Name Description
value String

The externalEntityId to set.

Returns
Type Description
Principal.Builder

This builder for chaining.

setExternalEntityIdBytes(ByteString value)

public Principal.Builder setExternalEntityIdBytes(ByteString value)

For 3P application identities which are not present in the customer identity provider.

string external_entity_id = 3;

Parameter
Name Description
value ByteString

The bytes for externalEntityId to set.

Returns
Type Description
Principal.Builder

This builder for chaining.

setGroupId(String value)

public Principal.Builder setGroupId(String value)

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;

Parameter
Name Description
value String

The groupId to set.

Returns
Type Description
Principal.Builder

This builder for chaining.

setGroupIdBytes(ByteString value)

public Principal.Builder setGroupIdBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for groupId to set.

Returns
Type Description
Principal.Builder

This builder for chaining.

setUserId(String value)

public Principal.Builder setUserId(String value)

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;

Parameter
Name Description
value String

The userId to set.

Returns
Type Description
Principal.Builder

This builder for chaining.

setUserIdBytes(ByteString value)

public Principal.Builder setUserIdBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for userId to set.

Returns
Type Description
Principal.Builder

This builder for chaining.