Package google.api

Distribution 包含值母體的摘要統計資料。其中可選擇性包含直方圖，代表這些值在一組值區中的分布情形。

摘要統計資料包括值母體的計數、平均值、與平均值的平方偏差總和、最小值和最大值。直方圖是以一系列值區為基礎，並提供落入每個值區的值計數。範圍界限可明確指定，也可以透過公式計算，以取得固定或指數型遞增寬度的範圍。

雖然不禁止，但一般來說，在值母體中加入非有限值 (無限或 NaN) 並非好主意，因為這會使 mean 和 sum_of_squared_deviation 欄位變得毫無意義。

BucketOptions 說明用於建立分布直方圖的範圍界線。值區可以是線性序列、指數序列，也可以明確指定每個值區。BucketOptions 不包含每個值區中的值數量。

值區的下限值 (含) 和上限值 (不含) 之間的值，都會計入該值區。值區上限必須嚴格大於下限。分布的 N 個值區序列包含欠位值區 (編號 0)、零或多個有限值區 (編號 1 到 N - 2) 和溢位值區 (編號 N - 1)。值區是連續的：值區 i (i > 0) 的下限與值區 i - 1 的上限相同。這些值區涵蓋整個有限值範圍：欠位值區的下界為負無限大，溢位值區的上界為正無限大。有限值區之所以稱為有限，是因為上下限都是有限值。

指定任意寬度的一組值區。

共有 size(bounds) + 1 (= N) 個值區。值區 i 有下列邊界：

上限 (0 <= i < N-1)：bounds[i] 下限 (1 <= i < N)：bounds[i - 1]

bounds 欄位必須包含至少一個元素。如果 bounds 只有一個元素，則沒有有限值區，而該單一元素是溢位和欠位值區的共同界線。

指定寬度與下限值成正比的指數值區間序列。每個 bucket 代表 bucket 中特定值的相對不確定度常數。

共有 num_finite_buckets + 2 (= N) 個值區。值區 i 有下列邊界：

上限 (0 <= i < N-1)：scale * (growth_factor ^ i)。

下限 (1 <= i < N)：scale * (growth_factor ^ (i - 1))。

指定線性序列的 bucket，這些 bucket 的寬度都相同 (溢位和下溢除外)。每個值區代表值區中特定值的常數絕對不確定度。

共有 num_finite_buckets + 2 (= N) 個值區。值區 i 有下列邊界：

上限 (0 <= i < N-1)：offset + (width * i)。

下限 (1 <= i < N)：offset + (width * (i - 1))。

範例點可用於註解匯總的分布值。這些中繼資料會提供有關新增至 Distribution 值區的特定值資訊，例如新增值時處於活動狀態的追蹤 ID。可能包含更多資訊，例如範例值和時間戳記、來源等。

母體值的範圍。

用於表示任何 HTTP 主體的訊息；只能用於無法以 JSON 表示的酬載格式，例如未經處理的二進位檔或 HTML 網頁。

這個訊息可以用於要求及回應中的串流和非串流 API 方法。

這個訊息可以當做頂層要求欄位；想從網址或 HTTP 範本中將參數擷取至要求欄位，同時又想存取未經處理的 HTTP 主體時，這個做法就非常便利。

範例：

message GetResourceRequest {
  // A unique request id.
  string request_id = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

串流方法範例：

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

使用這個類型只會改變要求和回應主體的處理方式，所有其他功能的運作方式皆維持不變。

特定指標，透過為 MetricDescriptor 的所有標籤指定值來識別。

定義指標類型及其結構定義。建立指標描述元後，對其進行刪除或修改即會停止收集資料，並且使指標類型的現有資料變成無法使用。

測量的種類，其說明報告資料的方式。如要瞭解如何根據 MetricKind 設定開始時間和結束時間，請參閱 TimeInterval。

指標的值類型。

這是一個物件，代表可用於監控、記錄、計費或其他用途的資源。相關範例包括：虛擬機器執行個體、資料庫，以及儲存裝置 (例如磁碟)。type 欄位會識別描述資源結構定義的 MonitoredResourceDescriptor 物件。labels 欄位中的資訊會根據結構定義，識別實際資源及其屬性。舉例來說，特定 Compute Engine VM 執行個體可由下列物件表示，因為 "gce_instance" 的標籤為 "project_id"、"instance_id" 和 "zone"：MonitoredResourceDescriptor

{ "type": "gce_instance",
  "labels": { "project_id": "my-project",
              "instance_id": "12345678901234",
              "zone": "us-central1-a" }}

MonitoredResource 物件的輔助中繼資料。MonitoredResource 物件包含可明確識別受監控資源例項的最少資訊。另外還有一些有用的輔助中繼資料。Monitoring 和 Logging 透過擷取管道，為所有類型的雲端資源擷取中繼資料，並將中繼資料儲存在這則訊息中。