Stackdriver Monitoring V3 Client - Class Service (2.1.2)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class Service.

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern ( Wikipedia ). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible.

Generated from protobuf message google.monitoring.v3.Service

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

↳ display_name
string

Name used for UI elements listing this Service.

↳ custom
Service\Custom

Custom service type.

↳ app_engine
Service\AppEngine

Type used for App Engine services.

↳ cloud_endpoints
Service\CloudEndpoints

Type used for Cloud Endpoints services.

↳ cluster_istio
Service\ClusterIstio

Type used for Istio services that live in a Kubernetes cluster.

↳ mesh_istio
Service\MeshIstio

Type used for Istio services scoped to an Istio mesh.

↳ istio_canonical_service
Service\IstioCanonicalService

Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here

↳ cloud_run
Service\CloudRun

Type used for Cloud Run services.

↳ gke_namespace
Service\GkeNamespace

Type used for GKE Namespaces.

↳ gke_workload
Service\GkeWorkload

Type used for GKE Workloads.

↳ gke_service
Service\GkeService

Type used for GKE Services (the Kubernetes concept of a service).

↳ basic_service
Service\BasicService

Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here .

↳ telemetry
Service\Telemetry

Configuration for how to query telemetry on a Service.

↳ user_labels
array| Google\Protobuf\Internal\MapField

Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.

getName

Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

Returns
Type
Description
string

setName

Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

Name used for UI elements listing this Service.

Returns
Type
Description
string

setDisplayName

Name used for UI elements listing this Service.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCustom

Custom service type.

Returns
Type
Description

hasCustom

setCustom

Custom service type.

Parameter
Name
Description
Returns
Type
Description
$this

getAppEngine

Type used for App Engine services.

Returns
Type
Description

hasAppEngine

setAppEngine

Type used for App Engine services.

Parameter
Name
Description
Returns
Type
Description
$this

getCloudEndpoints

Type used for Cloud Endpoints services.

Returns
Type
Description

hasCloudEndpoints

setCloudEndpoints

Type used for Cloud Endpoints services.

Parameter
Name
Description
Returns
Type
Description
$this

getClusterIstio

Type used for Istio services that live in a Kubernetes cluster.

Returns
Type
Description

hasClusterIstio

setClusterIstio

Type used for Istio services that live in a Kubernetes cluster.

Parameter
Name
Description
Returns
Type
Description
$this

getMeshIstio

Type used for Istio services scoped to an Istio mesh.

Returns
Type
Description

hasMeshIstio

setMeshIstio

Type used for Istio services scoped to an Istio mesh.

Parameter
Name
Description
Returns
Type
Description
$this

getIstioCanonicalService

Type used for canonical services scoped to an Istio mesh.

Metrics for Istio are documented here

Returns
Type
Description

hasIstioCanonicalService

setIstioCanonicalService

Type used for canonical services scoped to an Istio mesh.

Metrics for Istio are documented here

Parameter
Name
Description
Returns
Type
Description
$this

getCloudRun

Type used for Cloud Run services.

Returns
Type
Description

hasCloudRun

setCloudRun

Type used for Cloud Run services.

Parameter
Name
Description
Returns
Type
Description
$this

getGkeNamespace

Type used for GKE Namespaces.

Returns
Type
Description

hasGkeNamespace

setGkeNamespace

Type used for GKE Namespaces.

Parameter
Name
Description
Returns
Type
Description
$this

getGkeWorkload

Type used for GKE Workloads.

Returns
Type
Description

hasGkeWorkload

setGkeWorkload

Type used for GKE Workloads.

Parameter
Name
Description
Returns
Type
Description
$this

getGkeService

Type used for GKE Services (the Kubernetes concept of a service).

Returns
Type
Description

hasGkeService

setGkeService

Type used for GKE Services (the Kubernetes concept of a service).

Parameter
Name
Description
Returns
Type
Description
$this

getBasicService

Message that contains the service type and service labels of this service if it is a basic service.

Documentation and examples here .

Returns
Type
Description

hasBasicService

clearBasicService

setBasicService

Message that contains the service type and service labels of this service if it is a basic service.

Documentation and examples here .

Parameter
Name
Description
Returns
Type
Description
$this

getTelemetry

Configuration for how to query telemetry on a Service.

Returns
Type
Description

hasTelemetry

clearTelemetry

setTelemetry

Configuration for how to query telemetry on a Service.

Parameter
Name
Description
Returns
Type
Description
$this

getUserLabels

Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.

Returns
Type
Description

setUserLabels

Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.

Parameter
Name
Description
Returns
Type
Description
$this

getIdentifier

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: