Stackdriver Monitoring V3 Client - Class Service (1.6.0)

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` 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`	`Google\Cloud\Monitoring\V3\Service\Custom` Custom service type.
`↳ app_engine`	`Google\Cloud\Monitoring\V3\Service\AppEngine` Type used for App Engine services.
`↳ cloud_endpoints`	`Google\Cloud\Monitoring\V3\Service\CloudEndpoints` Type used for Cloud Endpoints services.
`↳ cluster_istio`	`Google\Cloud\Monitoring\V3\Service\ClusterIstio` Type used for Istio services that live in a Kubernetes cluster.
`↳ mesh_istio`	`Google\Cloud\Monitoring\V3\Service\MeshIstio` Type used for Istio services scoped to an Istio mesh.
`↳ istio_canonical_service`	`Google\Cloud\Monitoring\V3\Service\IstioCanonicalService` Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here
`↳ telemetry`	`Google\Cloud\Monitoring\V3\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

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

Returns
Type	Description
`string`

setName

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
`Google\Cloud\Monitoring\V3\Service\Custom\|null`

hasCustom

setCustom

Custom service type.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\Service\Custom`

Returns
Type	Description
`$this`

getAppEngine

Type used for App Engine services.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\Service\AppEngine\|null`

hasAppEngine

setAppEngine

Type used for App Engine services.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\Service\AppEngine`

Returns
Type	Description
`$this`

getCloudEndpoints

Type used for Cloud Endpoints services.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\Service\CloudEndpoints\|null`

hasCloudEndpoints

setCloudEndpoints

Type used for Cloud Endpoints services.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\Service\CloudEndpoints`

Returns
Type	Description
`$this`

getClusterIstio

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

Returns
Type	Description
`Google\Cloud\Monitoring\V3\Service\ClusterIstio\|null`

hasClusterIstio

setClusterIstio

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

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\Service\ClusterIstio`

Returns
Type	Description
`$this`

getMeshIstio

Type used for Istio services scoped to an Istio mesh.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\Service\MeshIstio\|null`

hasMeshIstio

setMeshIstio

Type used for Istio services scoped to an Istio mesh.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\Service\MeshIstio`

Returns
Type	Description
`$this`

getIstioCanonicalService

Type used for canonical services scoped to an Istio mesh.

Metrics for Istio are documented here

Returns
Type	Description
`Google\Cloud\Monitoring\V3\Service\IstioCanonicalService\|null`

hasIstioCanonicalService

setIstioCanonicalService

Type used for canonical services scoped to an Istio mesh.

Metrics for Istio are documented here

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\Service\IstioCanonicalService`

Returns
Type	Description
`$this`

getTelemetry

Configuration for how to query telemetry on a Service.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\Service\Telemetry\|null`

hasTelemetry

clearTelemetry

setTelemetry

Configuration for how to query telemetry on a Service.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\Service\Telemetry`

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
`Google\Protobuf\Internal\MapField`

setUserLabels

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getIdentifier

Returns
Type	Description
`string`