Represents an UptimeCheckConfig.
Package
@google-cloud/monitoringConstructors
(constructor)(properties)
constructor(properties?: google.monitoring.v3.IUptimeCheckConfig);Constructs a new UptimeCheckConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IUptimeCheckConfig
Properties to set |
Properties
checkRequestType
public checkRequestType?: ("httpCheck"|"tcpCheck");UptimeCheckConfig checkRequestType.
contentMatchers
public contentMatchers: google.monitoring.v3.UptimeCheckConfig.IContentMatcher[];UptimeCheckConfig contentMatchers.
displayName
public displayName: string;UptimeCheckConfig displayName.
httpCheck
public httpCheck?: (google.monitoring.v3.UptimeCheckConfig.IHttpCheck|null);UptimeCheckConfig httpCheck.
internalCheckers
public internalCheckers: google.monitoring.v3.IInternalChecker[];UptimeCheckConfig internalCheckers.
isInternal
public isInternal: boolean;UptimeCheckConfig isInternal.
monitoredResource
public monitoredResource?: (google.api.IMonitoredResource|null);UptimeCheckConfig monitoredResource.
name
public name: string;UptimeCheckConfig name.
period
public period?: (google.protobuf.IDuration|null);UptimeCheckConfig period.
resource
public resource?: ("monitoredResource"|"resourceGroup");UptimeCheckConfig resource.
resourceGroup
public resourceGroup?: (google.monitoring.v3.UptimeCheckConfig.IResourceGroup|null);UptimeCheckConfig resourceGroup.
selectedRegions
public selectedRegions: google.monitoring.v3.UptimeCheckRegion[];UptimeCheckConfig selectedRegions.
tcpCheck
public tcpCheck?: (google.monitoring.v3.UptimeCheckConfig.ITcpCheck|null);UptimeCheckConfig tcpCheck.
timeout
public timeout?: (google.protobuf.IDuration|null);UptimeCheckConfig timeout.
Methods
create(properties)
public static create(properties?: google.monitoring.v3.IUptimeCheckConfig): google.monitoring.v3.UptimeCheckConfig;Creates a new UptimeCheckConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IUptimeCheckConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.monitoring.v3.UptimeCheckConfig |
UptimeCheckConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.v3.UptimeCheckConfig;Decodes an UptimeCheckConfig 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.monitoring.v3.UptimeCheckConfig |
UptimeCheckConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.v3.UptimeCheckConfig;Decodes an UptimeCheckConfig 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.monitoring.v3.UptimeCheckConfig |
UptimeCheckConfig |
encode(message, writer)
public static encode(message: google.monitoring.v3.IUptimeCheckConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified UptimeCheckConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IUptimeCheckConfig
UptimeCheckConfig 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.IUptimeCheckConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified UptimeCheckConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IUptimeCheckConfig
UptimeCheckConfig 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;Creates an UptimeCheckConfig 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.monitoring.v3.UptimeCheckConfig |
UptimeCheckConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for UptimeCheckConfig
| 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 UptimeCheckConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.monitoring.v3.UptimeCheckConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an UptimeCheckConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.monitoring.v3.UptimeCheckConfig
UptimeCheckConfig |
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 an UptimeCheckConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|