Represents a HttpCheck.
Package
@google-cloud/monitoringConstructors
(constructor)(properties)
constructor(properties?: google.monitoring.v3.UptimeCheckConfig.IHttpCheck);Constructs a new HttpCheck.
| Parameter | |
|---|---|
| Name | Description |
properties |
IHttpCheck
Properties to set |
Properties
authInfo
public authInfo?: (google.monitoring.v3.UptimeCheckConfig.HttpCheck.IBasicAuthentication|null);HttpCheck authInfo.
body
public body: (Uint8Array|string);HttpCheck body.
contentType
public contentType: (google.monitoring.v3.UptimeCheckConfig.HttpCheck.ContentType|keyof typeof google.monitoring.v3.UptimeCheckConfig.HttpCheck.ContentType);HttpCheck contentType.
headers
public headers: { [k: string]: string };HttpCheck headers.
maskHeaders
public maskHeaders: boolean;HttpCheck maskHeaders.
path
public path: string;HttpCheck path.
port
public port: number;HttpCheck port.
requestMethod
public requestMethod: (google.monitoring.v3.UptimeCheckConfig.HttpCheck.RequestMethod|keyof typeof google.monitoring.v3.UptimeCheckConfig.HttpCheck.RequestMethod);HttpCheck requestMethod.
useSsl
public useSsl: boolean;HttpCheck useSsl.
validateSsl
public validateSsl: boolean;HttpCheck validateSsl.
Methods
create(properties)
public static create(properties?: google.monitoring.v3.UptimeCheckConfig.IHttpCheck): google.monitoring.v3.UptimeCheckConfig.HttpCheck;Creates a new HttpCheck instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IHttpCheck
Properties to set |
| Returns | |
|---|---|
| Type | Description |
HttpCheck | HttpCheck instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.v3.UptimeCheckConfig.HttpCheck;Decodes a HttpCheck 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 |
HttpCheck | HttpCheck |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.v3.UptimeCheckConfig.HttpCheck;Decodes a HttpCheck message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
HttpCheck | HttpCheck |
encode(message, writer)
public static encode(message: google.monitoring.v3.UptimeCheckConfig.IHttpCheck, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified HttpCheck message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IHttpCheck
HttpCheck 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.monitoring.v3.UptimeCheckConfig.IHttpCheck, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified HttpCheck message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IHttpCheck
HttpCheck 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.monitoring.v3.UptimeCheckConfig.HttpCheck;Creates a HttpCheck 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 |
HttpCheck | HttpCheck |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for HttpCheck
| 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 HttpCheck to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.monitoring.v3.UptimeCheckConfig.HttpCheck, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a HttpCheck message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
HttpCheck
HttpCheck |
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 HttpCheck message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|