WebKeySettings

google.cloud.recaptchaenterprise.v1. WebKeySettings

Represents a WebKeySettings.

Constructor

new WebKeySettings(propertiesopt)

Constructs a new WebKeySettings.

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

Properties to set
Implements:
  • IWebKeySettings

Members

ChallengeSecurityPreference

ChallengeSecurityPreference enum.

Properties:
Name Type Description
CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED number

CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED value
USABILITY number

USABILITY value
BALANCE number

BALANCE value
SECURITY number

SECURITY value

IntegrationType

IntegrationType enum.

Properties:
Name Type Description
INTEGRATION_TYPE_UNSPECIFIED number

INTEGRATION_TYPE_UNSPECIFIED value
SCORE number

SCORE value
CHECKBOX number

CHECKBOX value
INVISIBLE number

INVISIBLE value

allowAllDomains

WebKeySettings allowAllDomains.

allowAmpTraffic

WebKeySettings allowAmpTraffic.

allowedDomains

WebKeySettings allowedDomains.

challengeSecurityPreference

WebKeySettings challengeSecurityPreference.

integrationType

WebKeySettings integrationType.

Methods

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

Creates a new WebKeySettings instance using the specified properties.

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

Properties to set
Returns:
Type Description
google.cloud.recaptchaenterprise.v1.WebKeySettings

WebKeySettings instance

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

Decodes a WebKeySettings 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.WebKeySettings

WebKeySettings
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.WebKeySettings}

Decodes a WebKeySettings 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.WebKeySettings

WebKeySettings
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 WebKeySettings message. Does not implicitly verify messages.

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

WebKeySettings 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 WebKeySettings message, length delimited. Does not implicitly verify messages.

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

WebKeySettings 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.WebKeySettings}

Creates a WebKeySettings 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.WebKeySettings

WebKeySettings

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

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

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

WebKeySettings
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a WebKeySettings 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

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

Converts this WebKeySettings to JSON.

Returns:
Type Description
Object.<string, *>

JSON object