Class AuthEventData.Builder (0.16.0)

public static final class AuthEventData.Builder extends GeneratedMessageV3.Builder<AuthEventData.Builder> implements AuthEventDataOrBuilder

The data within all Firebase Auth events.

Protobuf type google.events.firebase.auth.v1.AuthEventData

Static Methods

getDescriptor()

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

Methods

addAllProviderData(Iterable<? extends UserInfo> values)

public AuthEventData.Builder addAllProviderData(Iterable<? extends UserInfo> values)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameter
Name Description
values Iterable<? extends com.google.events.firebase.auth.v1.UserInfo>
Returns
Type Description
AuthEventData.Builder

addProviderData(UserInfo value)

public AuthEventData.Builder addProviderData(UserInfo value)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameter
Name Description
value UserInfo
Returns
Type Description
AuthEventData.Builder

addProviderData(UserInfo.Builder builderForValue)

public AuthEventData.Builder addProviderData(UserInfo.Builder builderForValue)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameter
Name Description
builderForValue UserInfo.Builder
Returns
Type Description
AuthEventData.Builder

addProviderData(int index, UserInfo value)

public AuthEventData.Builder addProviderData(int index, UserInfo value)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameters
Name Description
index int
value UserInfo
Returns
Type Description
AuthEventData.Builder

addProviderData(int index, UserInfo.Builder builderForValue)

public AuthEventData.Builder addProviderData(int index, UserInfo.Builder builderForValue)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameters
Name Description
index int
builderForValue UserInfo.Builder
Returns
Type Description
AuthEventData.Builder

addProviderDataBuilder()

public UserInfo.Builder addProviderDataBuilder()

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Returns
Type Description
UserInfo.Builder

addProviderDataBuilder(int index)

public UserInfo.Builder addProviderDataBuilder(int index)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameter
Name Description
index int
Returns
Type Description
UserInfo.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AuthEventData.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AuthEventData.Builder
Overrides

build()

public AuthEventData build()
Returns
Type Description
AuthEventData

buildPartial()

public AuthEventData buildPartial()
Returns
Type Description
AuthEventData

clear()

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

clearCustomClaims()

public AuthEventData.Builder clearCustomClaims()

User's custom claims, typically used to define user roles and propagated to an authenticated user's ID token.

.google.protobuf.Struct custom_claims = 10;

Returns
Type Description
AuthEventData.Builder

clearDisabled()

public AuthEventData.Builder clearDisabled()

Whether the user is disabled.

bool disabled = 6;

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

clearDisplayName()

public AuthEventData.Builder clearDisplayName()

The user's display name.

string display_name = 4;

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

clearEmail()

public AuthEventData.Builder clearEmail()

The user's primary email, if set.

string email = 2;

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

clearEmailVerified()

public AuthEventData.Builder clearEmailVerified()

Whether or not the user's primary email is verified.

bool email_verified = 3;

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AuthEventData.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AuthEventData.Builder
Overrides

clearMetadata()

public AuthEventData.Builder clearMetadata()

Additional metadata about the user.

.google.events.firebase.auth.v1.UserMetadata metadata = 7;

Returns
Type Description
AuthEventData.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AuthEventData.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AuthEventData.Builder
Overrides

clearPhoneNumber()

public AuthEventData.Builder clearPhoneNumber()

The user's phone number.

string phone_number = 9;

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

clearPhotoURL()

public AuthEventData.Builder clearPhotoURL()

The user's photo URL.

string photo_URL = 5;

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

clearProviderData()

public AuthEventData.Builder clearProviderData()

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Returns
Type Description
AuthEventData.Builder

clearUid()

public AuthEventData.Builder clearUid()

The user identifier in the Firebase app.

string uid = 1;

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

clone()

public AuthEventData.Builder clone()
Returns
Type Description
AuthEventData.Builder
Overrides

getCustomClaims()

public Struct getCustomClaims()

User's custom claims, typically used to define user roles and propagated to an authenticated user's ID token.

.google.protobuf.Struct custom_claims = 10;

Returns
Type Description
Struct

The customClaims.

getCustomClaimsBuilder()

public Struct.Builder getCustomClaimsBuilder()

User's custom claims, typically used to define user roles and propagated to an authenticated user's ID token.

.google.protobuf.Struct custom_claims = 10;

Returns
Type Description
Builder

getCustomClaimsOrBuilder()

public StructOrBuilder getCustomClaimsOrBuilder()

User's custom claims, typically used to define user roles and propagated to an authenticated user's ID token.

.google.protobuf.Struct custom_claims = 10;

Returns
Type Description
StructOrBuilder

getDefaultInstanceForType()

public AuthEventData getDefaultInstanceForType()
Returns
Type Description
AuthEventData

getDescriptorForType()

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

getDisabled()

public boolean getDisabled()

Whether the user is disabled.

bool disabled = 6;

Returns
Type Description
boolean

The disabled.

getDisplayName()

public String getDisplayName()

The user's display name.

string display_name = 4;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The user's display name.

string display_name = 4;

Returns
Type Description
ByteString

The bytes for displayName.

getEmail()

public String getEmail()

The user's primary email, if set.

string email = 2;

Returns
Type Description
String

The email.

getEmailBytes()

public ByteString getEmailBytes()

The user's primary email, if set.

string email = 2;

Returns
Type Description
ByteString

The bytes for email.

getEmailVerified()

public boolean getEmailVerified()

Whether or not the user's primary email is verified.

bool email_verified = 3;

Returns
Type Description
boolean

The emailVerified.

getMetadata()

public UserMetadata getMetadata()

Additional metadata about the user.

.google.events.firebase.auth.v1.UserMetadata metadata = 7;

Returns
Type Description
UserMetadata

The metadata.

getMetadataBuilder()

public UserMetadata.Builder getMetadataBuilder()

Additional metadata about the user.

.google.events.firebase.auth.v1.UserMetadata metadata = 7;

Returns
Type Description
UserMetadata.Builder

getMetadataOrBuilder()

public UserMetadataOrBuilder getMetadataOrBuilder()

Additional metadata about the user.

.google.events.firebase.auth.v1.UserMetadata metadata = 7;

Returns
Type Description
UserMetadataOrBuilder

getPhoneNumber()

public String getPhoneNumber()

The user's phone number.

string phone_number = 9;

Returns
Type Description
String

The phoneNumber.

getPhoneNumberBytes()

public ByteString getPhoneNumberBytes()

The user's phone number.

string phone_number = 9;

Returns
Type Description
ByteString

The bytes for phoneNumber.

getPhotoURL()

public String getPhotoURL()

The user's photo URL.

string photo_URL = 5;

Returns
Type Description
String

The photoURL.

getPhotoURLBytes()

public ByteString getPhotoURLBytes()

The user's photo URL.

string photo_URL = 5;

Returns
Type Description
ByteString

The bytes for photoURL.

getProviderData(int index)

public UserInfo getProviderData(int index)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameter
Name Description
index int
Returns
Type Description
UserInfo

getProviderDataBuilder(int index)

public UserInfo.Builder getProviderDataBuilder(int index)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameter
Name Description
index int
Returns
Type Description
UserInfo.Builder

getProviderDataBuilderList()

public List<UserInfo.Builder> getProviderDataBuilderList()

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Returns
Type Description
List<Builder>

getProviderDataCount()

public int getProviderDataCount()

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Returns
Type Description
int

getProviderDataList()

public List<UserInfo> getProviderDataList()

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Returns
Type Description
List<UserInfo>

getProviderDataOrBuilder(int index)

public UserInfoOrBuilder getProviderDataOrBuilder(int index)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameter
Name Description
index int
Returns
Type Description
UserInfoOrBuilder

getProviderDataOrBuilderList()

public List<? extends UserInfoOrBuilder> getProviderDataOrBuilderList()

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Returns
Type Description
List<? extends com.google.events.firebase.auth.v1.UserInfoOrBuilder>

getUid()

public String getUid()

The user identifier in the Firebase app.

string uid = 1;

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

The user identifier in the Firebase app.

string uid = 1;

Returns
Type Description
ByteString

The bytes for uid.

hasCustomClaims()

public boolean hasCustomClaims()

User's custom claims, typically used to define user roles and propagated to an authenticated user's ID token.

.google.protobuf.Struct custom_claims = 10;

Returns
Type Description
boolean

Whether the customClaims field is set.

hasMetadata()

public boolean hasMetadata()

Additional metadata about the user.

.google.events.firebase.auth.v1.UserMetadata metadata = 7;

Returns
Type Description
boolean

Whether the metadata field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCustomClaims(Struct value)

public AuthEventData.Builder mergeCustomClaims(Struct value)

User's custom claims, typically used to define user roles and propagated to an authenticated user's ID token.

.google.protobuf.Struct custom_claims = 10;

Parameter
Name Description
value Struct
Returns
Type Description
AuthEventData.Builder

mergeFrom(AuthEventData other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMetadata(UserMetadata value)

public AuthEventData.Builder mergeMetadata(UserMetadata value)

Additional metadata about the user.

.google.events.firebase.auth.v1.UserMetadata metadata = 7;

Parameter
Name Description
value UserMetadata
Returns
Type Description
AuthEventData.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AuthEventData.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AuthEventData.Builder
Overrides

removeProviderData(int index)

public AuthEventData.Builder removeProviderData(int index)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameter
Name Description
index int
Returns
Type Description
AuthEventData.Builder

setCustomClaims(Struct value)

public AuthEventData.Builder setCustomClaims(Struct value)

User's custom claims, typically used to define user roles and propagated to an authenticated user's ID token.

.google.protobuf.Struct custom_claims = 10;

Parameter
Name Description
value Struct
Returns
Type Description
AuthEventData.Builder

setCustomClaims(Struct.Builder builderForValue)

public AuthEventData.Builder setCustomClaims(Struct.Builder builderForValue)

User's custom claims, typically used to define user roles and propagated to an authenticated user's ID token.

.google.protobuf.Struct custom_claims = 10;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AuthEventData.Builder

setDisabled(boolean value)

public AuthEventData.Builder setDisabled(boolean value)

Whether the user is disabled.

bool disabled = 6;

Parameter
Name Description
value boolean

The disabled to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setDisplayName(String value)

public AuthEventData.Builder setDisplayName(String value)

The user's display name.

string display_name = 4;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public AuthEventData.Builder setDisplayNameBytes(ByteString value)

The user's display name.

string display_name = 4;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setEmail(String value)

public AuthEventData.Builder setEmail(String value)

The user's primary email, if set.

string email = 2;

Parameter
Name Description
value String

The email to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setEmailBytes(ByteString value)

public AuthEventData.Builder setEmailBytes(ByteString value)

The user's primary email, if set.

string email = 2;

Parameter
Name Description
value ByteString

The bytes for email to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setEmailVerified(boolean value)

public AuthEventData.Builder setEmailVerified(boolean value)

Whether or not the user's primary email is verified.

bool email_verified = 3;

Parameter
Name Description
value boolean

The emailVerified to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AuthEventData.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AuthEventData.Builder
Overrides

setMetadata(UserMetadata value)

public AuthEventData.Builder setMetadata(UserMetadata value)

Additional metadata about the user.

.google.events.firebase.auth.v1.UserMetadata metadata = 7;

Parameter
Name Description
value UserMetadata
Returns
Type Description
AuthEventData.Builder

setMetadata(UserMetadata.Builder builderForValue)

public AuthEventData.Builder setMetadata(UserMetadata.Builder builderForValue)

Additional metadata about the user.

.google.events.firebase.auth.v1.UserMetadata metadata = 7;

Parameter
Name Description
builderForValue UserMetadata.Builder
Returns
Type Description
AuthEventData.Builder

setPhoneNumber(String value)

public AuthEventData.Builder setPhoneNumber(String value)

The user's phone number.

string phone_number = 9;

Parameter
Name Description
value String

The phoneNumber to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setPhoneNumberBytes(ByteString value)

public AuthEventData.Builder setPhoneNumberBytes(ByteString value)

The user's phone number.

string phone_number = 9;

Parameter
Name Description
value ByteString

The bytes for phoneNumber to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setPhotoURL(String value)

public AuthEventData.Builder setPhotoURL(String value)

The user's photo URL.

string photo_URL = 5;

Parameter
Name Description
value String

The photoURL to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setPhotoURLBytes(ByteString value)

public AuthEventData.Builder setPhotoURLBytes(ByteString value)

The user's photo URL.

string photo_URL = 5;

Parameter
Name Description
value ByteString

The bytes for photoURL to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setProviderData(int index, UserInfo value)

public AuthEventData.Builder setProviderData(int index, UserInfo value)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameters
Name Description
index int
value UserInfo
Returns
Type Description
AuthEventData.Builder

setProviderData(int index, UserInfo.Builder builderForValue)

public AuthEventData.Builder setProviderData(int index, UserInfo.Builder builderForValue)

User's info at the providers

repeated .google.events.firebase.auth.v1.UserInfo provider_data = 8;

Parameters
Name Description
index int
builderForValue UserInfo.Builder
Returns
Type Description
AuthEventData.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AuthEventData.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AuthEventData.Builder
Overrides

setUid(String value)

public AuthEventData.Builder setUid(String value)

The user identifier in the Firebase app.

string uid = 1;

Parameter
Name Description
value String

The uid to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setUidBytes(ByteString value)

public AuthEventData.Builder setUidBytes(ByteString value)

The user identifier in the Firebase app.

string uid = 1;

Parameter
Name Description
value ByteString

The bytes for uid to set.

Returns
Type Description
AuthEventData.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AuthEventData.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AuthEventData.Builder
Overrides