Google Cloud Container V1 Client - Class SetMonitoringServiceRequest (1.9.1)

Reference documentation and code samples for the Google Cloud Container V1 Client class SetMonitoringServiceRequest.

SetMonitoringServiceRequest sets the monitoring service of a cluster.

Generated from protobuf message google.container.v1.SetMonitoringServiceRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ project_id string

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

↳ zone string

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

↳ cluster_id string

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

↳ monitoring_service string

Required. The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * none - No metrics will be exported from the cluster. If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

↳ name string

The name (project, location, cluster) of the cluster to set monitoring. Specified in the format projects/*/locations/*/clusters/*.

getProjectId

Deprecated. The Google Developers Console project ID or project number.

This field has been deprecated and replaced by the name field.

Generated from protobuf field string project_id = 1 [deprecated = true];

Returns
TypeDescription
string

setProjectId

Deprecated. The Google Developers Console project ID or project number.

This field has been deprecated and replaced by the name field.

Generated from protobuf field string project_id = 1 [deprecated = true];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getZone

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

Generated from protobuf field string zone = 2 [deprecated = true];

Returns
TypeDescription
string

setZone

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

Generated from protobuf field string zone = 2 [deprecated = true];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClusterId

Deprecated. The name of the cluster to upgrade.

This field has been deprecated and replaced by the name field.

Generated from protobuf field string cluster_id = 3 [deprecated = true];

Returns
TypeDescription
string

setClusterId

Deprecated. The name of the cluster to upgrade.

This field has been deprecated and replaced by the name field.

Generated from protobuf field string cluster_id = 3 [deprecated = true];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMonitoringService

Required. The monitoring service the cluster should use to write metrics.

Currently available options:

  • "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
  • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
  • none - No metrics will be exported from the cluster. If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

Generated from protobuf field string monitoring_service = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setMonitoringService

Required. The monitoring service the cluster should use to write metrics.

Currently available options:

  • "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
  • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
  • none - No metrics will be exported from the cluster. If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

Generated from protobuf field string monitoring_service = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

The name (project, location, cluster) of the cluster to set monitoring.

Specified in the format projects/*/locations/*/clusters/*.

Generated from protobuf field string name = 6;

Returns
TypeDescription
string

setName

The name (project, location, cluster) of the cluster to set monitoring.

Specified in the format projects/*/locations/*/clusters/*.

Generated from protobuf field string name = 6;

Parameter
NameDescription
var string
Returns
TypeDescription
$this