Class protos.google.cloud.recaptchaenterprise.v1beta1.Assessment (5.5.0)

Represents an Assessment.

Package

@google-cloud/recaptcha-enterprise

Constructors

(constructor)(properties)

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

Constructs a new Assessment.

Parameter
Name Description
properties IAssessment

Properties to set

Properties

accountDefenderAssessment

public accountDefenderAssessment?: (google.cloud.recaptchaenterprise.v1beta1.IAccountDefenderAssessment|null);

Assessment accountDefenderAssessment.

event

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

Assessment event.

fraudPreventionAssessment

public fraudPreventionAssessment?: (google.cloud.recaptchaenterprise.v1beta1.IFraudPreventionAssessment|null);

Assessment fraudPreventionAssessment.

name

public name: string;

Assessment name.

passwordLeakVerification

public passwordLeakVerification?: (google.cloud.recaptchaenterprise.v1beta1.IPasswordLeakVerification|null);

Assessment passwordLeakVerification.

reasons

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

Assessment reasons.

score

public score: number;

Assessment score.

tokenProperties

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

Assessment tokenProperties.

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
Name Description
properties IAssessment

Properties to set

Returns
Type Description
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
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
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
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
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
Name Description
message IAssessment

Assessment 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.recaptchaenterprise.v1beta1.IAssessment, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAssessment

Assessment 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.recaptchaenterprise.v1beta1.Assessment;

Creates an Assessment 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
Assessment

Assessment

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Assessment

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 Assessment to JSON.

Returns
Type Description
{ [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
Name Description
message Assessment

Assessment

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 an Assessment 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