Class protos.google.cloud.discoveryengine.v1alpha.UserEvent (1.9.0)

Represents a UserEvent.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1alpha.IUserEvent);

Constructs a new UserEvent.

Parameter
Name Description
properties IUserEvent

Properties to set

Properties

attributes

public attributes: { [k: string]: google.cloud.discoveryengine.v1alpha.ICustomAttribute };

UserEvent attributes.

attributionToken

public attributionToken: string;

UserEvent attributionToken.

completionInfo

public completionInfo?: (google.cloud.discoveryengine.v1alpha.ICompletionInfo|null);

UserEvent completionInfo.

dataStore

public dataStore: string;

UserEvent dataStore.

directUserRequest

public directUserRequest: boolean;

UserEvent directUserRequest.

documents

public documents: google.cloud.discoveryengine.v1alpha.IDocumentInfo[];

UserEvent documents.

engine

public engine: string;

UserEvent engine.

eventTime

public eventTime?: (google.protobuf.ITimestamp|null);

UserEvent eventTime.

eventType

public eventType: string;

UserEvent eventType.

filter

public filter: string;

UserEvent filter.

mediaInfo

public mediaInfo?: (google.cloud.discoveryengine.v1alpha.IMediaInfo|null);

UserEvent mediaInfo.

pageInfo

public pageInfo?: (google.cloud.discoveryengine.v1alpha.IPageInfo|null);

UserEvent pageInfo.

panel

public panel?: (google.cloud.discoveryengine.v1alpha.IPanelInfo|null);

UserEvent panel.

promotionIds

public promotionIds: string[];

UserEvent promotionIds.

searchInfo

public searchInfo?: (google.cloud.discoveryengine.v1alpha.ISearchInfo|null);

UserEvent searchInfo.

sessionId

public sessionId: string;

UserEvent sessionId.

tagIds

public tagIds: string[];

UserEvent tagIds.

transactionInfo

public transactionInfo?: (google.cloud.discoveryengine.v1alpha.ITransactionInfo|null);

UserEvent transactionInfo.

userInfo

public userInfo?: (google.cloud.discoveryengine.v1alpha.IUserInfo|null);

UserEvent userInfo.

userPseudoId

public userPseudoId: string;

UserEvent userPseudoId.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1alpha.IUserEvent): google.cloud.discoveryengine.v1alpha.UserEvent;

Creates a new UserEvent instance using the specified properties.

Parameter
Name Description
properties IUserEvent

Properties to set

Returns
Type Description
UserEvent

UserEvent instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.UserEvent;

Decodes a UserEvent message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
UserEvent

UserEvent

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.UserEvent;

Decodes a UserEvent message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
UserEvent

UserEvent

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1alpha.IUserEvent, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UserEvent message. Does not implicitly messages.

Parameters
Name Description
message IUserEvent

UserEvent message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.discoveryengine.v1alpha.IUserEvent, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified UserEvent message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IUserEvent

UserEvent message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1alpha.UserEvent;

Creates a UserEvent message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
UserEvent

UserEvent

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for UserEvent

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this UserEvent to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.discoveryengine.v1alpha.UserEvent, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a UserEvent message. Also converts values to other types if specified.

Parameters
Name Description
message UserEvent

UserEvent

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a UserEvent message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not