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] |
↳ display_name |
string
The checker's human-readable name. The display name should be unique within a Stackdriver Workspace 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 Workspace 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 Stackdriver Workspace project for the
Uptime check config associated with the internal checker.
Generated from protobuf field string name = 1;
| 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 Stackdriver Workspace project for the
Uptime check config associated with the internal checker.
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
The checker's human-readable name. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
Generated from protobuf field string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
The checker's human-readable name. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
Generated from protobuf field string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetwork
The GCP VPC network where the internal resource lives (ex: "default").
Generated from protobuf field string network = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setNetwork
The GCP VPC network where the internal resource lives (ex: "default").
Generated from protobuf field string network = 3;
| 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.
Generated from protobuf field string gcp_zone = 4;
| 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.
Generated from protobuf field string gcp_zone = 4;
| 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 Workspace project.
Generated from protobuf field string peer_project_id = 6;
| Returns | |
|---|---|
| Type | Description |
string | |
setPeerProjectId
The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.
Generated from protobuf field string peer_project_id = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
The current operational state of the internal checker.
Generated from protobuf field .google.monitoring.v3.InternalChecker.State state = 7;
| Returns | |
|---|---|
| Type | Description |
int | |
setState
The current operational state of the internal checker.
Generated from protobuf field .google.monitoring.v3.InternalChecker.State state = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |