Class: Google::Apis::GkehubV1alpha::MonitoringConfig

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

Overview

This field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MonitoringConfig

Returns a new instance of MonitoringConfig.



3330
3331
3332
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3330

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

Instance Attribute Details

#clusterString

Immutable. Cluster name used to report metrics. For Anthos on VMWare/Baremetal, it would be in format memberClusters/cluster_name; And for Anthos on MultiCloud, it would be in format `azureClusters, awsClusters/cluster_name. Corresponds to the JSON propertycluster`

Returns:

  • (String)


3302
3303
3304
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3302

def cluster
  @cluster
end

#cluster_hashString

Immutable. Cluster hash, this is a unique string generated by google code, which does not contain any PII, which we can use to reference the cluster. This is expected to be created by the monitoring stack and persisted into the Cluster object as well as to GKE-Hub. Corresponds to the JSON property clusterHash

Returns:

  • (String)


3310
3311
3312
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3310

def cluster_hash
  @cluster_hash
end

#kubernetes_metrics_prefixString

Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos Corresponds to the JSON property kubernetesMetricsPrefix

Returns:

  • (String)


3318
3319
3320
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3318

def kubernetes_metrics_prefix
  @kubernetes_metrics_prefix
end

#locationString

Immutable. Location used to report Metrics Corresponds to the JSON property location

Returns:

  • (String)


3323
3324
3325
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3323

def location
  @location
end

#project_idString

Immutable. Project used to report Metrics Corresponds to the JSON property projectId

Returns:

  • (String)


3328
3329
3330
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3328

def project_id
  @project_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3335
3336
3337
3338
3339
3340
3341
# File 'lib/google/apis/gkehub_v1alpha/classes.rb', line 3335

def update!(**args)
  @cluster = args[:cluster] if args.key?(:cluster)
  @cluster_hash = args[:cluster_hash] if args.key?(:cluster_hash)
  @kubernetes_metrics_prefix = args[:kubernetes_metrics_prefix] if args.key?(:kubernetes_metrics_prefix)
  @location = args[:location] if args.key?(:location)
  @project_id = args[:project_id] if args.key?(:project_id)
end