Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::InternalChecker.
An internal checker allows Uptime checks to run on private/internal GCP
resources.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#display_name
defdisplay_name()->::String
Returns
(::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.
#display_name=
defdisplay_name=(value)->::String
Parameter
value (::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.
Returns
(::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.
#gcp_zone
defgcp_zone()->::String
Returns
(::String) — The GCP zone the Uptime check should egress from. Only respected for
internal Uptime checks, where internal_network is specified.
#gcp_zone=
defgcp_zone=(value)->::String
Parameter
value (::String) — The GCP zone the Uptime check should egress from. Only respected for
internal Uptime checks, where internal_network is specified.
Returns
(::String) — The GCP zone the Uptime check should egress from. Only respected for
internal Uptime checks, where internal_network is specified.
#name
defname()->::String
Returns
(::String) — A unique resource name for this InternalChecker. The format is:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::InternalChecker (v1.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.6.1 (latest)](/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-InternalChecker)\n- [1.6.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.6.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [1.5.1](/ruby/docs/reference/google-cloud-monitoring-v3/1.5.1/Google-Cloud-Monitoring-V3-InternalChecker)\n- [1.4.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.4.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [1.3.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.3.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [1.2.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.2.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [1.1.0](/ruby/docs/reference/google-cloud-monitoring-v3/1.1.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [1.0.1](/ruby/docs/reference/google-cloud-monitoring-v3/1.0.1/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.18.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.18.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.17.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.17.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.16.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.16.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.15.2](/ruby/docs/reference/google-cloud-monitoring-v3/0.15.2/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.14.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.14.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.13.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.13.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.12.1](/ruby/docs/reference/google-cloud-monitoring-v3/0.12.1/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.11.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.11.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.10.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.10.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.9.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.9.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.8.0](/ruby/docs/reference/google-cloud-monitoring-v3/0.8.0/Google-Cloud-Monitoring-V3-InternalChecker)\n- [0.7.1](/ruby/docs/reference/google-cloud-monitoring-v3/0.7.1/Google-Cloud-Monitoring-V3-InternalChecker) \nReference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::InternalChecker.\n\nAn internal checker allows Uptime checks to run on private/internal GCP\nresources. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #gcp_zone\n\n def gcp_zone() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.\n\n### #gcp_zone=\n\n def gcp_zone=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified. \n**Returns**\n\n- (::String) --- The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A unique resource name for this InternalChecker. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID]\n\n `[PROJECT_ID_OR_NUMBER]` is the Cloud Monitoring Metrics Scope project for\n the Uptime check config associated with the internal checker.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A unique resource name for this InternalChecker. The format is:\n\n\n projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID]\n\n `[PROJECT_ID_OR_NUMBER]` is the Cloud Monitoring Metrics Scope project for\nthe Uptime check config associated with the internal checker. \n**Returns**\n\n- (::String) --- A unique resource name for this InternalChecker. The format is:\n\n projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID]\n\n `[PROJECT_ID_OR_NUMBER]` is the Cloud Monitoring Metrics Scope project for\n the Uptime check config associated with the internal checker.\n\n### #network\n\n def network() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The [GCP VPC network](https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: \"default\").\n\n### #network=\n\n def network=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The [GCP VPC network](https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: \"default\"). \n**Returns**\n\n- (::String) --- The [GCP VPC network](https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: \"default\").\n\n### #peer_project_id\n\n def peer_project_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The GCP project ID where the internal checker lives. Not necessary the same as the Metrics Scope project.\n\n### #peer_project_id=\n\n def peer_project_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The GCP project ID where the internal checker lives. Not necessary the same as the Metrics Scope project. \n**Returns**\n\n- (::String) --- The GCP project ID where the internal checker lives. Not necessary the same as the Metrics Scope project.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::Monitoring::V3::InternalChecker::State\n\n**Returns**\n\n- ([::Google::Cloud::Monitoring::V3::InternalChecker::State](./Google-Cloud-Monitoring-V3-InternalChecker-State)) --- The current operational state of the internal checker.\n\n### #state=\n\n def state=(value) -\u003e ::Google::Cloud::Monitoring::V3::InternalChecker::State\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Monitoring::V3::InternalChecker::State](./Google-Cloud-Monitoring-V3-InternalChecker-State)) --- The current operational state of the internal checker. \n**Returns**\n\n- ([::Google::Cloud::Monitoring::V3::InternalChecker::State](./Google-Cloud-Monitoring-V3-InternalChecker-State)) --- The current operational state of the internal checker."]]
