WafSettings

google.cloud.recaptchaenterprise.v1. WafSettings

Represents a WafSettings.

Constructor

new WafSettings(propertiesopt)

Constructs a new WafSettings.

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

Properties to set

Implements:
  • IWafSettings

Members

wafFeature

WafSettings wafFeature.

wafService

WafSettings wafService.

WafFeature

WafFeature enum.

Properties:
Name Type Description
WAF_FEATURE_UNSPECIFIED number

WAF_FEATURE_UNSPECIFIED value

CHALLENGE_PAGE number

CHALLENGE_PAGE value

SESSION_TOKEN number

SESSION_TOKEN value

ACTION_TOKEN number

ACTION_TOKEN value

EXPRESS number

EXPRESS value

WafService

WafService enum.

Properties:
Name Type Description
WAF_SERVICE_UNSPECIFIED number

WAF_SERVICE_UNSPECIFIED value

CA number

CA value

FASTLY number

FASTLY value

CLOUDFLARE number

CLOUDFLARE value

Methods

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

Converts this WafSettings to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new WafSettings instance using the specified properties.

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

Properties to set

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

WafSettings instance

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

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

WafSettings

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

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

WafSettings

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

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

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

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

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

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

WafSettings

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for WafSettings

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 a WafSettings message. Also converts values to other types if specified.

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

WafSettings

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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