Google Cloud Container V1 Client - Class SetMonitoringServiceRequest (2.5.0)

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

Namespace

Google \ Cloud \ Container \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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.

Returns
Type Description
string

setProjectId

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

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

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterId

Deprecated. The name of the cluster to upgrade.

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

Returns
Type Description
string

setClusterId

Deprecated. The name of the cluster to upgrade.

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

Parameter
Name Description
var string
Returns
Type Description
$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.
Returns
Type Description
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.
Parameter
Name Description
var string
Returns
Type Description
$this

getName

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

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

Returns
Type Description
string

setName

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
projectId 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.
clusterId string

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
monitoringService 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.
Returns
Type Description
SetMonitoringServiceRequest

static::buildFromNameMonitoringService

Parameters
Name Description
name string

The name (project, location, cluster) of the cluster to set monitoring. Specified in the format projects/*/locations/*/clusters/*.
monitoringService 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.
Returns
Type Description
SetMonitoringServiceRequest