Google Cloud Gke Hub V1 Client - Class MonitoringConfig (0.8.2)

Reference documentation and code samples for the Google Cloud Gke Hub V1 Client class MonitoringConfig.

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

Generated from protobuf message google.cloud.gkehub.v1.MonitoringConfig

Namespace

Google \ Cloud \ GkeHub \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ project_id`	`string` Immutable. Project used to report Metrics
`↳ location`	`string` Immutable. Location used to report Metrics
`↳ cluster`	`string` 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`.
`↳ kubernetes_metrics_prefix`	`string` 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
`↳ cluster_hash`	`string` 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.

getProjectId

Immutable. Project used to report Metrics

Returns
Type	Description
`string`

setProjectId

Immutable. Project used to report Metrics

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLocation

Immutable. Location used to report Metrics

Returns
Type	Description
`string`

setLocation

Immutable. Location used to report Metrics

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCluster

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.

Returns
Type	Description
`string`

setCluster

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getKubernetesMetricsPrefix

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

Returns
Type	Description
`string`

setKubernetesMetricsPrefix

Kubernetes system metrics, if available, are written to this prefix.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getClusterHash

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.

Returns
Type	Description
`string`

setClusterHash

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`