HTTPSHealthCheck

google.cloud.compute.v1. HTTPSHealthCheck

Represents a HTTPSHealthCheck.

Constructor

new HTTPSHealthCheck(propertiesopt)

Constructs a new HTTPSHealthCheck.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IHTTPSHealthCheck <optional>

Properties to set

Implements:
  • IHTTPSHealthCheck

Members

_host

HTTPSHealthCheck _host.

_port

HTTPSHealthCheck _port.

_portName

HTTPSHealthCheck _portName.

_portSpecification

HTTPSHealthCheck _portSpecification.

_proxyHeader

HTTPSHealthCheck _proxyHeader.

_requestPath

HTTPSHealthCheck _requestPath.

_response

HTTPSHealthCheck _response.

host

HTTPSHealthCheck host.

port

HTTPSHealthCheck port.

portName

HTTPSHealthCheck portName.

portSpecification

HTTPSHealthCheck portSpecification.

proxyHeader

HTTPSHealthCheck proxyHeader.

requestPath

HTTPSHealthCheck requestPath.

response

HTTPSHealthCheck response.

PortSpecification

PortSpecification enum.

Properties:
Name Type Description
UNDEFINED_PORT_SPECIFICATION number

UNDEFINED_PORT_SPECIFICATION value

USE_FIXED_PORT number

USE_FIXED_PORT value

USE_NAMED_PORT number

USE_NAMED_PORT value

USE_SERVING_PORT number

USE_SERVING_PORT value

ProxyHeader

ProxyHeader enum.

Properties:
Name Type Description
UNDEFINED_PROXY_HEADER number

UNDEFINED_PROXY_HEADER value

NONE number

NONE value

PROXY_V1 number

PROXY_V1 value

Methods

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

Converts this HTTPSHealthCheck to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.compute.v1.HTTPSHealthCheck}

Creates a new HTTPSHealthCheck instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IHTTPSHealthCheck <optional>

Properties to set

Returns:
Type Description
google.cloud.compute.v1.HTTPSHealthCheck

HTTPSHealthCheck instance

(static) decode(reader, lengthopt) → {google.cloud.compute.v1.HTTPSHealthCheck}

Decodes a HTTPSHealthCheck 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.compute.v1.HTTPSHealthCheck

HTTPSHealthCheck

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.compute.v1.HTTPSHealthCheck}

Decodes a HTTPSHealthCheck 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.compute.v1.HTTPSHealthCheck

HTTPSHealthCheck

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

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IHTTPSHealthCheck

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

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IHTTPSHealthCheck

HTTPSHealthCheck 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.compute.v1.HTTPSHealthCheck}

Creates a HTTPSHealthCheck 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.compute.v1.HTTPSHealthCheck

HTTPSHealthCheck

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for HTTPSHealthCheck

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

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.HTTPSHealthCheck

HTTPSHealthCheck

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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