Stackdriver Monitoring V3 Client - Class UptimeCheckIp (1.2.2)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class UptimeCheckIp.

Contains the region, location, and list of IP addresses where checkers in the location run from.

Generated from protobuf message google.monitoring.v3.UptimeCheckIp

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ region int

A broad region category in which the IP address is located.

↳ location string

A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.

↳ ip_address string

The IP address from which the Uptime check originates. This is a fully specified IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely, and should support interpreting this field in either IPv4 or IPv6 format.

getRegion

A broad region category in which the IP address is located.

Generated from protobuf field .google.monitoring.v3.UptimeCheckRegion region = 1;

Returns
TypeDescription
int

setRegion

A broad region category in which the IP address is located.

Generated from protobuf field .google.monitoring.v3.UptimeCheckRegion region = 1;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getLocation

A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.

Generated from protobuf field string location = 2;

Returns
TypeDescription
string

setLocation

A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.

Generated from protobuf field string location = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIpAddress

The IP address from which the Uptime check originates. This is a fully specified IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely, and should support interpreting this field in either IPv4 or IPv6 format.

Generated from protobuf field string ip_address = 3;

Returns
TypeDescription
string

setIpAddress

The IP address from which the Uptime check originates. This is a fully specified IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely, and should support interpreting this field in either IPv4 or IPv6 format.

Generated from protobuf field string ip_address = 3;

Parameter
NameDescription
var string
Returns
TypeDescription
$this