Class protos.google.cloud.recaptchaenterprise.v1beta1.Assessment

Represents an Assessment.

Package

@google-cloud/recaptcha-enterprise!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.recaptchaenterprise.v1beta1.IAssessment);

Constructs a new Assessment.

Parameter
TypeNameDescription
IAssessmentproperties

Properties to set

Properties

event

public event?: (google.cloud.recaptchaenterprise.v1beta1.IEvent|null);

Assessment event.

Property Value
TypeDescription
(google.cloud.recaptchaenterprise.v1beta1.IEvent|null)

name

public name: string;

Assessment name.

Property Value
TypeDescription
string

reasons

public reasons: google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason[];

Assessment reasons.

Property Value
TypeDescription
google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason[]

score

public score: number;

Assessment score.

Property Value
TypeDescription
number

tokenProperties

public tokenProperties?: (google.cloud.recaptchaenterprise.v1beta1.ITokenProperties|null);

Assessment tokenProperties.

Property Value
TypeDescription
(google.cloud.recaptchaenterprise.v1beta1.ITokenProperties|null)

Methods

create(properties)

public static create(properties?: google.cloud.recaptchaenterprise.v1beta1.IAssessment): google.cloud.recaptchaenterprise.v1beta1.Assessment;

Creates a new Assessment instance using the specified properties.

Parameter
TypeNameDescription
IAssessmentproperties

Properties to set

Returns
TypeDescription
google.cloud.recaptchaenterprise.v1beta1.Assessment

Assessment instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.recaptchaenterprise.v1beta1.Assessment;

Decodes an Assessment message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.recaptchaenterprise.v1beta1.Assessment

Assessment

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.recaptchaenterprise.v1beta1.Assessment;

Decodes an Assessment message from the specified reader or buffer, length delimited.

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.recaptchaenterprise.v1beta1.Assessment

Assessment

encode(message, writer)

public static encode(message: google.cloud.recaptchaenterprise.v1beta1.IAssessment, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Assessment message. Does not implicitly messages.

Parameters
TypeNameDescription
IAssessmentmessage

Assessment message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.recaptchaenterprise.v1beta1.IAssessment, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
TypeNameDescription
IAssessmentmessage

Assessment message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.recaptchaenterprise.v1beta1.Assessment;

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

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.cloud.recaptchaenterprise.v1beta1.Assessment

Assessment

toJSON()

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

Converts this Assessment to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.cloud.recaptchaenterprise.v1beta1.Assessmentmessage

Assessment

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an Assessment message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not