Class: Google::Apis::MonitoringV3::InternalChecker

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/monitoring_v3/classes.rb,
lib/google/apis/monitoring_v3/representations.rb,
lib/google/apis/monitoring_v3/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InternalChecker

Returns a new instance of InternalChecker.



2026
2027
2028
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2026

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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. Corresponds to the JSON property displayName

Returns:

  • (String) 


1993
1994
1995
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1993

def display_name
  @display_name
end

#gcp_zone ⇒ String

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

Returns:

  • (String) 


1999
2000
2001
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1999

def gcp_zone
  @gcp_zone
end

#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. Corresponds to the JSON property name

Returns:

  • (String) 


2007
2008
2009
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2007

def name
  @name
end

#network ⇒ String

The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default"). Corresponds to the JSON property network

Returns:

  • (String) 


2013
2014
2015
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2013

def network
  @network
end

#peer_project_id ⇒ String

The GCP project ID where the internal checker lives. Not necessary the same as the Metrics Scope project. Corresponds to the JSON property peerProjectId

Returns:

  • (String) 


2019
2020
2021
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2019

def peer_project_id
  @peer_project_id
end

#state ⇒ String

The current operational state of the internal checker. Corresponds to the JSON property state

Returns:

  • (String) 


2024
2025
2026
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2024

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2031
2032
2033
2034
2035
2036
2037
2038
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2031

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @gcp_zone = args[:gcp_zone] if args.key?(:gcp_zone)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @peer_project_id = args[:peer_project_id] if args.key?(:peer_project_id)
  @state = args[:state] if args.key?(:state)
end