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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/monitoring_v3/classes.rb,
generated/google/apis/monitoring_v3/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ InternalChecker

Returns a new instance of InternalChecker.



1546
1547
1548
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1546

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 Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Corresponds to the JSON property displayName

Returns:

  • (String) 


1513
1514
1515
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1513

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) 


1519
1520
1521
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1519

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 Stackdriver Workspace project for the Uptime check config associated with the internal checker. Corresponds to the JSON property name

Returns:

  • (String) 


1527
1528
1529
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1527

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) 


1533
1534
1535
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1533

def network
  @network
end

#peer_project_id ⇒ String

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

Returns:

  • (String) 


1539
1540
1541
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1539

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) 


1544
1545
1546
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1544

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1551
1552
1553
1554
1555
1556
1557
1558
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1551

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