Update this Service.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/monitoring

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: monitoring3 --scope <scope> services patch ...

Required Scalar Argument

• <name> (string)
  • Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Service:
  app-engine:
    module-id: string
  basic-service:
    service-labels: { string: string }
    service-type: string
  cloud-endpoints:
    service: string
  cloud-run:
    location: string
    service-name: string
  cluster-istio:
    cluster-name: string
    location: string
    service-name: string
    service-namespace: string
  display-name: string
  gke-namespace:
    cluster-name: string
    location: string
    namespace-name: string
    project-id: string
  gke-service:
    cluster-name: string
    location: string
    namespace-name: string
    project-id: string
    service-name: string
  gke-workload:
    cluster-name: string
    location: string
    namespace-name: string
    project-id: string
    top-level-controller-name: string
    top-level-controller-type: string
  istio-canonical-service:
    canonical-service: string
    canonical-service-namespace: string
    mesh-uid: string
  mesh-istio:
    mesh-uid: string
    service-name: string
    service-namespace: string
  name: string
  telemetry:
    resource-name: string
  user-labels: { string: string }

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r .app-engine module-id=at

  • The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource (https://cloud.google.com/monitoring/api/resources#tag_gae_app).

• ..basic-service service-labels=key=sit

  • Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this Service. Documentation and valid values for given service types here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).
  • the value will be associated with the given key

• service-type=duo

  • The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid values here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).

• ..cloud-endpoints service=sit

  • The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource (https://cloud.google.com/monitoring/api/resources#tag_api).

• ..cloud-run location=magna

  • The location the service is run. Corresponds to the location resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision).

• service-name=et

  • The name of the Cloud Run service. Corresponds to the service_name resource label in the cloud_run_revision monitored resource (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision).

• ..cluster-istio cluster-name=rebum.

  • The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the cluster_name resource label in k8s_cluster resources.
• location=dolor
  • The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources.
• service-name=lorem
  • The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.

• service-namespace=justo

  • The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.

• .. display-name=amet.

  • Name used for UI elements listing this Service.
• gke-namespace cluster-name=no
  • The name of the parent cluster.
• location=nonumy
  • The location of the parent cluster. This may be a zone or region.
• namespace-name=sed
  • The name of this namespace.

• project-id=kasd

  • Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself.

• ..gke-service cluster-name=lorem

  • The name of the parent cluster.
• location=sanctus
  • The location of the parent cluster. This may be a zone or region.
• namespace-name=nonumy
  • The name of the parent namespace.
• project-id=rebum.
  • Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself.

• service-name=tempor

  • The name of this service.

• ..gke-workload cluster-name=dolore

  • The name of the parent cluster.
• location=eos
  • The location of the parent cluster. This may be a zone or region.
• namespace-name=amet.
  • The name of the parent namespace.
• project-id=dolore
  • Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself.
• top-level-controller-name=amet
  • The name of this workload.

• top-level-controller-type=ut

  • The type of this workload (for example, "Deployment" or "DaemonSet")

• ..istio-canonical-service canonical-service=at

  • The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).
• canonical-service-namespace=sit
  • The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).

• mesh-uid=vero

  • Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).

• ..mesh-istio mesh-uid=duo

  • Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics.
• service-name=sadipscing
  • The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics.

• service-namespace=ut

  • The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics.

• .. name=rebum.

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

• telemetry resource-name=duo

  • The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names.

• .. user-labels=key=kasd

  • 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.
  • the value will be associated with the given key

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p update-mask=string
  • A set of field paths defining which fields to use for the update.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").