Class protos.google.cloud.compute.v1.HTTPSHealthCheck (3.0.0)

Represents a HTTPSHealthCheck.

Package

Constructors

(constructor)(properties)

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

Constructs a new HTTPSHealthCheck.

Parameter

Name	Description
properties	`IHTTPSHealthCheck` Properties to set

Properties

_host

public _host?: "host";

HTTPSHealthCheck _host.

_port

public _port?: "port";

HTTPSHealthCheck _port.

_portName

public _portName?: "portName";

HTTPSHealthCheck _portName.

_portSpecification

public _portSpecification?: "portSpecification";

HTTPSHealthCheck _portSpecification.

_proxyHeader

public _proxyHeader?: "proxyHeader";

HTTPSHealthCheck _proxyHeader.

_requestPath

public _requestPath?: "requestPath";

HTTPSHealthCheck _requestPath.

_response

public _response?: "response";

HTTPSHealthCheck _response.

host

public host?: (string|null);

HTTPSHealthCheck host.

port

public port?: (number|null);

HTTPSHealthCheck port.

portName

public portName?: (string|null);

HTTPSHealthCheck portName.

portSpecification

public portSpecification?: (google.cloud.compute.v1.HTTPSHealthCheck.PortSpecification|keyof typeof google.cloud.compute.v1.HTTPSHealthCheck.PortSpecification|null);

HTTPSHealthCheck portSpecification.

proxyHeader

public proxyHeader?: (google.cloud.compute.v1.HTTPSHealthCheck.ProxyHeader|keyof typeof google.cloud.compute.v1.HTTPSHealthCheck.ProxyHeader|null);

HTTPSHealthCheck proxyHeader.

requestPath

public requestPath?: (string|null);

HTTPSHealthCheck requestPath.

response

public response?: (string|null);

HTTPSHealthCheck response.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IHTTPSHealthCheck): google.cloud.compute.v1.HTTPSHealthCheck;

Creates a new HTTPSHealthCheck instance using the specified properties.

Parameter

Name	Description
properties	`IHTTPSHealthCheck` Properties to set

Returns

Type	Description
google.cloud.compute.v1.HTTPSHealthCheck	HTTPSHealthCheck instance

decode(reader, length)

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

Decodes a HTTPSHealthCheck message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

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

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

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

encode(message, writer)

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

Encodes the specified HTTPSHealthCheck message. Does not implicitly messages.

Parameters

Name	Description
message	`IHTTPSHealthCheck` HTTPSHealthCheck 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.IHTTPSHealthCheck, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IHTTPSHealthCheck` HTTPSHealthCheck 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.HTTPSHealthCheck;

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

toJSON()

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

Converts this HTTPSHealthCheck to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.compute.v1.HTTPSHealthCheck` HTTPSHealthCheck
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 HTTPSHealthCheck 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