Represents a HTTPHealthCheck.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1.IHTTPHealthCheck);Constructs a new HTTPHealthCheck.
| Parameter | |
|---|---|
| Name | Description |
properties |
IHTTPHealthCheck
Properties to set |
Properties
_host
public _host?: "host";HTTPHealthCheck _host.
_port
public _port?: "port";HTTPHealthCheck _port.
_portName
public _portName?: "portName";HTTPHealthCheck _portName.
_portSpecification
public _portSpecification?: "portSpecification";HTTPHealthCheck _portSpecification.
_proxyHeader
public _proxyHeader?: "proxyHeader";HTTPHealthCheck _proxyHeader.
_requestPath
public _requestPath?: "requestPath";HTTPHealthCheck _requestPath.
_response
public _response?: "response";HTTPHealthCheck _response.
host
public host?: (string|null);HTTPHealthCheck host.
port
public port?: (number|null);HTTPHealthCheck port.
portName
public portName?: (string|null);HTTPHealthCheck portName.
portSpecification
public portSpecification?: (string|null);HTTPHealthCheck portSpecification.
proxyHeader
public proxyHeader?: (string|null);HTTPHealthCheck proxyHeader.
requestPath
public requestPath?: (string|null);HTTPHealthCheck requestPath.
response
public response?: (string|null);HTTPHealthCheck response.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1.IHTTPHealthCheck): google.cloud.compute.v1.HTTPHealthCheck;Creates a new HTTPHealthCheck instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IHTTPHealthCheck
Properties to set |
| Returns | |
|---|---|
| Type | Description |
HTTPHealthCheck | HTTPHealthCheck instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.HTTPHealthCheck;Decodes a HTTPHealthCheck 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 |
HTTPHealthCheck | HTTPHealthCheck |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.HTTPHealthCheck;Decodes a HTTPHealthCheck message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
HTTPHealthCheck | HTTPHealthCheck |
encode(message, writer)
public static encode(message: google.cloud.compute.v1.IHTTPHealthCheck, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified HTTPHealthCheck message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IHTTPHealthCheck
HTTPHealthCheck 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.IHTTPHealthCheck, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified HTTPHealthCheck message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IHTTPHealthCheck
HTTPHealthCheck 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.HTTPHealthCheck;Creates a HTTPHealthCheck 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 |
HTTPHealthCheck | HTTPHealthCheck |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for HTTPHealthCheck
| 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 HTTPHealthCheck to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.compute.v1.HTTPHealthCheck, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a HTTPHealthCheck message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
HTTPHealthCheck
HTTPHealthCheck |
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 HTTPHealthCheck message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|