Stackdriver Monitoring V3 Client - Class InternalChecker (1.4.0)

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

An internal checker allows Uptime checks to run on private/internal GCP resources.

Generated from protobuf message google.monitoring.v3.InternalChecker

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

A unique resource name for this InternalChecker. The format is: projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID] [PROJECT_ID_OR_NUMBER] is the Cloud Monitoring Metrics Scope project for the Uptime check config associated with the internal checker.

↳ display_name
string

The checker's human-readable name. The display name should be unique within a Cloud Monitoring Metrics Scope in order to make it easier to identify; however, uniqueness is not enforced.

↳ network
string

The GCP VPC network where the internal resource lives (ex: "default").

↳ gcp_zone
string

The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.

↳ peer_project_id
string

The GCP project ID where the internal checker lives. Not necessary the same as the Metrics Scope project.

↳ state
int

The current operational state of the internal checker.

getName

A unique resource name for this InternalChecker. The format is: projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID] [PROJECT_ID_OR_NUMBER] is the Cloud Monitoring Metrics Scope project for the Uptime check config associated with the internal checker.

Returns
Type
Description
string

setName

A unique resource name for this InternalChecker. The format is: projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID] [PROJECT_ID_OR_NUMBER] is the Cloud Monitoring Metrics Scope project for the Uptime check config associated with the internal checker.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

The checker's human-readable name. The display name should be unique within a Cloud Monitoring Metrics Scope in order to make it easier to identify; however, uniqueness is not enforced.

Returns
Type
Description
string

setDisplayName

The checker's human-readable name. The display name should be unique within a Cloud Monitoring Metrics Scope in order to make it easier to identify; however, uniqueness is not enforced.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNetwork

The GCP VPC network where the internal resource lives (ex: "default").

Returns
Type
Description
string

setNetwork

The GCP VPC network where the internal resource lives (ex: "default").

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getGcpZone

The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.

Returns
Type
Description
string

setGcpZone

The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPeerProjectId

The GCP project ID where the internal checker lives. Not necessary the same as the Metrics Scope project.

Returns
Type
Description
string

setPeerProjectId

The GCP project ID where the internal checker lives. Not necessary the same as the Metrics Scope project.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getState

The current operational state of the internal checker.

Returns
Type
Description
int

setState

The current operational state of the internal checker.

Parameter
Name
Description
var
int
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: