HttpCheck

google.monitoring.v3.UptimeCheckConfig. HttpCheck

Represents a HttpCheck.

Constructor

new HttpCheck(propertiesopt)

Constructs a new HttpCheck.

Parameters:
Name Type Attributes Description
properties google.monitoring.v3.UptimeCheckConfig.IHttpCheck <optional>

Properties to set

Implements:
  • IHttpCheck

Classes

BasicAuthentication

Members

authInfo

HttpCheck authInfo.

body

HttpCheck body.

contentType

HttpCheck contentType.

headers

HttpCheck headers.

maskHeaders

HttpCheck maskHeaders.

path

HttpCheck path.

port

HttpCheck port.

requestMethod

HttpCheck requestMethod.

useSsl

HttpCheck useSsl.

validateSsl

HttpCheck validateSsl.

ContentType

ContentType enum.

Properties:
Name Type Description
TYPE_UNSPECIFIED number

TYPE_UNSPECIFIED value

URL_ENCODED number

URL_ENCODED value

RequestMethod

RequestMethod enum.

Properties:
Name Type Description
METHOD_UNSPECIFIED number

METHOD_UNSPECIFIED value

GET number

GET value

POST number

POST value

Methods

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

Converts this HttpCheck to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.monitoring.v3.UptimeCheckConfig.HttpCheck}

Creates a new HttpCheck instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.monitoring.v3.UptimeCheckConfig.IHttpCheck <optional>

Properties to set

Returns:
Type Description
google.monitoring.v3.UptimeCheckConfig.HttpCheck

HttpCheck instance

(static) decode(reader, lengthopt) → {google.monitoring.v3.UptimeCheckConfig.HttpCheck}

Decodes a HttpCheck 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.monitoring.v3.UptimeCheckConfig.HttpCheck

HttpCheck

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.monitoring.v3.UptimeCheckConfig.HttpCheck}

Decodes a HttpCheck 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.monitoring.v3.UptimeCheckConfig.HttpCheck

HttpCheck

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

Parameters:
Name Type Attributes Description
message google.monitoring.v3.UptimeCheckConfig.IHttpCheck

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

Parameters:
Name Type Attributes Description
message google.monitoring.v3.UptimeCheckConfig.IHttpCheck

HttpCheck message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.monitoring.v3.UptimeCheckConfig.HttpCheck}

Creates a HttpCheck 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.monitoring.v3.UptimeCheckConfig.HttpCheck

HttpCheck

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for HttpCheck

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

Parameters:
Name Type Attributes Description
message google.monitoring.v3.UptimeCheckConfig.HttpCheck

HttpCheck

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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