Class Authentication.Builder (0.3.0)

0.3.0 (latest) 0.2.0 0.1.0

public static final class Authentication.Builder extends GeneratedMessage.Builder<Authentication.Builder> implements AuthenticationOrBuilder

The Authentication extension captures details specific to authentication events. General guidelines for authentication events:

• Details about the source of the authentication event (for example, client IP or hostname), should be captured in principal. The principal may be empty if we have no details about the source of the login.
• Details about the target of the authentication event (for example, details about the machine that is being logged into or logged out of) should be captured in target.
• Some authentication events may involve a third-party. For example, a user logs into a cloud service (for example, Chronicle) via their company's SSO (the event is logged by their SSO solution). In this case, the principal captures information about the user's device, the target captures details about the cloud service they logged into, and the intermediary captures details about the SSO solution.

Protobuf type google.backstory.Authentication

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Authentication.Builder

Implements

AuthenticationOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllMechanism(Iterable<? extends Authentication.Mechanism> values)

public Authentication.Builder addAllMechanism(Iterable<? extends Authentication.Mechanism> values)

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Parameter
Name	Description
values	Iterable<? extends com.google.backstory.Authentication.Mechanism> The mechanism to add.

Returns
Type	Description
Authentication.Builder	This builder for chaining.

addAllMechanismValue(Iterable<Integer> values)

public Authentication.Builder addAllMechanismValue(Iterable<Integer> values)

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Parameter
Name	Description
values	Iterable<Integer> The enum numeric values on the wire for mechanism to add.

Returns
Type	Description
Authentication.Builder	This builder for chaining.

addMechanism(Authentication.Mechanism value)

public Authentication.Builder addMechanism(Authentication.Mechanism value)

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Parameter
Name	Description
value	Authentication.Mechanism The mechanism to add.

Returns
Type	Description
Authentication.Builder	This builder for chaining.

addMechanismValue(int value)

public Authentication.Builder addMechanismValue(int value)

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Parameter
Name	Description
value	int The enum numeric value on the wire for mechanism to add.

Returns
Type	Description
Authentication.Builder	This builder for chaining.

build()

public Authentication build()

Returns
Type	Description
Authentication

buildPartial()

public Authentication buildPartial()

Returns
Type	Description
Authentication

clear()

public Authentication.Builder clear()

Returns
Type	Description
Authentication.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAuthDetails()

public Authentication.Builder clearAuthDetails()

The vendor defined details of the authentication.

string auth_details = 3;

Returns
Type	Description
Authentication.Builder	This builder for chaining.

clearMechanism()

public Authentication.Builder clearMechanism()

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Returns
Type	Description
Authentication.Builder	This builder for chaining.

clearOutcome()

public Authentication.Builder clearOutcome()

The outcome of the authentication event.

.google.backstory.Authentication.Outcome outcome = 4;

Returns
Type	Description
Authentication.Builder	This builder for chaining.

clearType()

public Authentication.Builder clearType()

The type of authentication.

.google.backstory.Authentication.AuthType type = 1;

Returns
Type	Description
Authentication.Builder	This builder for chaining.

getAuthDetails()

public String getAuthDetails()

The vendor defined details of the authentication.

string auth_details = 3;

Returns
Type	Description
String	The authDetails.

getAuthDetailsBytes()

public ByteString getAuthDetailsBytes()

The vendor defined details of the authentication.

string auth_details = 3;

Returns
Type	Description
ByteString	The bytes for authDetails.

getDefaultInstanceForType()

public Authentication getDefaultInstanceForType()

Returns
Type	Description
Authentication

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getMechanism(int index)

public Authentication.Mechanism getMechanism(int index)

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
Authentication.Mechanism	The mechanism at the given index.

getMechanismCount()

public int getMechanismCount()

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Returns
Type	Description
int	The count of mechanism.

getMechanismList()

public List<Authentication.Mechanism> getMechanismList()

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Returns
Type	Description
List<Mechanism>	A list containing the mechanism.

getMechanismValue(int index)

public int getMechanismValue(int index)

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
int	The enum numeric value on the wire of mechanism at the given index.

getMechanismValueList()

public List<Integer> getMechanismValueList()

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for mechanism.

getOutcome()

public Authentication.Outcome getOutcome()

The outcome of the authentication event.

.google.backstory.Authentication.Outcome outcome = 4;

Returns
Type	Description
Authentication.Outcome	The outcome.

getOutcomeValue()

public int getOutcomeValue()

The outcome of the authentication event.

.google.backstory.Authentication.Outcome outcome = 4;

Returns
Type	Description
int	The enum numeric value on the wire for outcome.

getType()

public Authentication.AuthType getType()

The type of authentication.

.google.backstory.Authentication.AuthType type = 1;

Returns
Type	Description
Authentication.AuthType	The type.

getTypeValue()

public int getTypeValue()

The type of authentication.

.google.backstory.Authentication.AuthType type = 1;

Returns
Type	Description
int	The enum numeric value on the wire for type.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(Authentication other)

public Authentication.Builder mergeFrom(Authentication other)

Parameter
Name	Description
other	Authentication

Returns
Type	Description
Authentication.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Authentication.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Authentication.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Authentication.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Authentication.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setAuthDetails(String value)

public Authentication.Builder setAuthDetails(String value)

The vendor defined details of the authentication.

string auth_details = 3;

Parameter
Name	Description
value	String The authDetails to set.

Returns
Type	Description
Authentication.Builder	This builder for chaining.

setAuthDetailsBytes(ByteString value)

public Authentication.Builder setAuthDetailsBytes(ByteString value)

The vendor defined details of the authentication.

string auth_details = 3;

Parameter
Name	Description
value	ByteString The bytes for authDetails to set.

Returns
Type	Description
Authentication.Builder	This builder for chaining.

setMechanism(int index, Authentication.Mechanism value)

public Authentication.Builder setMechanism(int index, Authentication.Mechanism value)

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Parameters
Name	Description
index	int The index to set the value at.
value	Authentication.Mechanism The mechanism to set.

Returns
Type	Description
Authentication.Builder	This builder for chaining.

setMechanismValue(int index, int value)

public Authentication.Builder setMechanismValue(int index, int value)

The authentication mechanism.

repeated .google.backstory.Authentication.Mechanism mechanism = 2;

Parameters
Name	Description
index	int The index to set the value at.
value	int The enum numeric value on the wire for mechanism to set.

Returns
Type	Description
Authentication.Builder	This builder for chaining.

setOutcome(Authentication.Outcome value)

public Authentication.Builder setOutcome(Authentication.Outcome value)

The outcome of the authentication event.

.google.backstory.Authentication.Outcome outcome = 4;

Parameter
Name	Description
value	Authentication.Outcome The outcome to set.

Returns
Type	Description
Authentication.Builder	This builder for chaining.

setOutcomeValue(int value)

public Authentication.Builder setOutcomeValue(int value)

The outcome of the authentication event.

.google.backstory.Authentication.Outcome outcome = 4;

Parameter
Name	Description
value	int The enum numeric value on the wire for outcome to set.

Returns
Type	Description
Authentication.Builder	This builder for chaining.

setType(Authentication.AuthType value)

public Authentication.Builder setType(Authentication.AuthType value)

The type of authentication.

.google.backstory.Authentication.AuthType type = 1;

Parameter
Name	Description
value	Authentication.AuthType The type to set.

Returns
Type	Description
Authentication.Builder	This builder for chaining.

setTypeValue(int value)

public Authentication.Builder setTypeValue(int value)

The type of authentication.

.google.backstory.Authentication.AuthType type = 1;

Parameter
Name	Description
value	int The enum numeric value on the wire for type to set.

Returns
Type	Description
Authentication.Builder	This builder for chaining.