Assessment

google.cloud.recaptchaenterprise.v1. Assessment

Represents an Assessment.

Constructor

new Assessment(propertiesopt)

Constructs a new Assessment.

Parameters:
Name Type Attributes Description
properties google.cloud.recaptchaenterprise.v1.IAssessment <optional>

Properties to set

Implements:
  • IAssessment

Members

accountDefenderAssessment

Assessment accountDefenderAssessment.

accountVerification

Assessment accountVerification.

event

Assessment event.

firewallPolicyAssessment

Assessment firewallPolicyAssessment.

fraudPreventionAssessment

Assessment fraudPreventionAssessment.

fraudSignals

Assessment fraudSignals.

name

Assessment name.

privatePasswordLeakVerification

Assessment privatePasswordLeakVerification.

riskAnalysis

Assessment riskAnalysis.

tokenProperties

Assessment tokenProperties.

Methods

toJSON() → {Object.<string, *>}

Converts this Assessment to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.recaptchaenterprise.v1.Assessment}

Creates a new Assessment instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.recaptchaenterprise.v1.IAssessment <optional>

Properties to set

Returns:
Type Description
google.cloud.recaptchaenterprise.v1.Assessment

Assessment instance

(static) decode(reader, lengthopt) → {google.cloud.recaptchaenterprise.v1.Assessment}

Decodes an Assessment message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.recaptchaenterprise.v1.Assessment

Assessment

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.recaptchaenterprise.v1.Assessment}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.recaptchaenterprise.v1.Assessment

Assessment

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Assessment message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.recaptchaenterprise.v1.IAssessment

Assessment message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.recaptchaenterprise.v1.IAssessment

Assessment message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.recaptchaenterprise.v1.Assessment}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.recaptchaenterprise.v1.Assessment

Assessment

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Assessment

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.recaptchaenterprise.v1.Assessment

Assessment

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an Assessment message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not