GRPCHealthCheck

google.cloud.compute.v1. GRPCHealthCheck

Represents a GRPCHealthCheck.

Constructor

new GRPCHealthCheck(propertiesopt)

Constructs a new GRPCHealthCheck.

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

Properties to set

Implements:
  • IGRPCHealthCheck

Members

_grpcServiceName

GRPCHealthCheck _grpcServiceName.

_port

GRPCHealthCheck _port.

_portName

GRPCHealthCheck _portName.

_portSpecification

GRPCHealthCheck _portSpecification.

grpcServiceName

GRPCHealthCheck grpcServiceName.

port

GRPCHealthCheck port.

portName

GRPCHealthCheck portName.

portSpecification

GRPCHealthCheck portSpecification.

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

Methods

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

Converts this GRPCHealthCheck to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new GRPCHealthCheck instance using the specified properties.

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

Properties to set

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

GRPCHealthCheck instance

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

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

GRPCHealthCheck

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

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

GRPCHealthCheck

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

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

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

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

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

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

GRPCHealthCheck

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for GRPCHealthCheck

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

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

GRPCHealthCheck

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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