Class protos.google.cloud.compute.v1.TCPHealthCheck (4.6.0)

Represents a TCPHealthCheck.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.ITCPHealthCheck);

Constructs a new TCPHealthCheck.

Parameter
Name Description
properties ITCPHealthCheck

Properties to set

Properties

_port

public _port?: "port";

TCPHealthCheck _port.

_portName

public _portName?: "portName";

TCPHealthCheck _portName.

_portSpecification

public _portSpecification?: "portSpecification";

TCPHealthCheck _portSpecification.

_proxyHeader

public _proxyHeader?: "proxyHeader";

TCPHealthCheck _proxyHeader.

_request

public _request?: "request";

TCPHealthCheck _request.

_response

public _response?: "response";

TCPHealthCheck _response.

port

public port?: (number|null);

TCPHealthCheck port.

portName

public portName?: (string|null);

TCPHealthCheck portName.

portSpecification

public portSpecification?: (string|null);

TCPHealthCheck portSpecification.

proxyHeader

public proxyHeader?: (string|null);

TCPHealthCheck proxyHeader.

request

public request?: (string|null);

TCPHealthCheck request.

response

public response?: (string|null);

TCPHealthCheck response.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.ITCPHealthCheck): google.cloud.compute.v1.TCPHealthCheck;

Creates a new TCPHealthCheck instance using the specified properties.

Parameter
Name Description
properties ITCPHealthCheck

Properties to set

Returns
Type Description
TCPHealthCheck

TCPHealthCheck instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.TCPHealthCheck;

Decodes a TCPHealthCheck message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
TCPHealthCheck

TCPHealthCheck

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.TCPHealthCheck;

Decodes a TCPHealthCheck message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
TCPHealthCheck

TCPHealthCheck

encode(message, writer)

public static encode(message: google.cloud.compute.v1.ITCPHealthCheck, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TCPHealthCheck message. Does not implicitly messages.

Parameters
Name Description
message ITCPHealthCheck

TCPHealthCheck message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.compute.v1.ITCPHealthCheck, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TCPHealthCheck message, length delimited. Does not implicitly messages.

Parameters
Name Description
message ITCPHealthCheck

TCPHealthCheck message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.TCPHealthCheck;

Creates a TCPHealthCheck message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
TCPHealthCheck

TCPHealthCheck

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for TCPHealthCheck

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this TCPHealthCheck to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.compute.v1.TCPHealthCheck, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message TCPHealthCheck

TCPHealthCheck

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a TCPHealthCheck message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not