第1章 バージョン v1
1.1. AdministrationEventService
1.1.1. ListAdministrationEvents
GET /v1/administration/events
ListAdministrationEvents は、要求されたフィールドに基づいてフィルタリングした後のイベントのリストを返します。
1.1.1.1. 説明
1.1.1.2. パラメーター
1.1.1.2.1. クエリーパラメーター
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
pagination.limit | - | null | ||
pagination.offset | - | null | ||
pagination.sortOption.field | - | null | ||
pagination.sortOption.reversed | - | null | ||
pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
pagination.sortOption.aggregateBy.distinct | - | null | ||
filter.from | 特定のタイムスタンプ (下限) より後の last_occurred_at が含まれるイベントを特定します。 | - | null | |
filter.until | 特定のタイムスタンプ (上限) より前の last_occurred_at が含まれるイベントを特定します。 | - | null | |
filter.domain |
特定のドメインからのイベントを特定します。 | - | null | |
filter.resourceType |
特定のリソース型に関連するイベントを特定します。 | - | null | |
filter.type |
それらの型に基づいてイベントを特定します。 | - | null | |
filter.level |
レベルに基づいてイベントを特定します。 | - | null |
1.1.1.3. 戻り値のタイプ
1.1.1.4. コンテンツタイプ
- application/json
1.1.1.5. レスポンス
コード | メッセージ | データ型 |
---|---|---|
200 | 正常な応答。 | |
0 | 予期しないエラーの応答。 |
1.1.1.6. サンプル
1.1.1.7. 共通のオブジェクト参照
1.1.1.7.1. GooglerpcStatus
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
code | Integer | int32 | |||
message | String | ||||
details | ProtobufAny のリスト |
1.1.1.7.2. ProtobufAny
Any
には、任意のシリアル化されたプロトコルバッファーメッセージと、シリアル化されたメッセージの型を記述する URL が含まれます。
Protobuf ライブラリーは、ユーティリティー関数または Any 型の追加の生成メソッドといった形式で Any 値をパック/アンパックするためのサポートを提供します。
例 1: C++ のメッセージをパックしてアンパックします。
Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
例 2: Java でメッセージをパックしてアンパックします。
Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); }
Example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }
protobuf ライブラリーによって提供される pack メソッドは、デフォルトで型 URL として 'type.googleapis.com/full.type.name' を使用し、unpack メソッドは型 URL の最後の '/' の後の完全修飾型名のみを使用します。たとえば、"foo.bar.com/x/y.z" は型名 "y.z" を生成します。
1.1.1.7.2.1. JSON 表現
Any
値の JSON 表現では、逆シリアル化された埋め込みメッセージの通常の表現が使用され、型 URL を含む追加のフィールド @type
が含まれます。以下に例を示します。
package google.profile; message Person { string first_name = 1; string last_name = 2; }
{ "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> }
埋め込まれたメッセージ型が一般的であり、カスタム JSON 表現がある場合、その表現には、@type
フィールドに加えてカスタム JSON を保持するフィールドの 値
が追加されて埋め込まれます。例 ([google.protobuf.Duration][] メッセージの場合):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
@type | String |
シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: |
1.1.1.7.3. V1AdministrationEvent
AdministrationEvents は、Central によって出力される管理イベントです。これらは、非同期のバックグラウンドタスクについてユーザーに対して透明性を提供するために使用されます。イベントは、Central のシステムヘルスビューの一部です。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
id | String | イベントの UUID。 | |||
type | ADMINISTRATION_EVENT_TYPE_UNKNOWN, ADMINISTRATION_EVENT_TYPE_GENERIC, ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE, | ||||
level | ADMINISTRATION_EVENT_LEVEL_UNKNOWN, ADMINISTRATION_EVENT_LEVEL_INFO, ADMINISTRATION_EVENT_LEVEL_SUCCESS, ADMINISTRATION_EVENT_LEVEL_WARNING, ADMINISTRATION_EVENT_LEVEL_ERROR, | ||||
message | String | イベントに関連するメッセージ。メッセージには、この特定のイベントの詳細情報が含まれる場合があります。 | |||
hint | String | イベントに関連するヒント。ヒントには、イベントの種類に応じて異なる情報が含まれる場合があります。イベントを解決するための手順や情報のヒントを含めることができます。 | |||
domain | String | イベントに関連するドメイン。イベントのドメインは、イベントが作成されたフィーチャドメインの概要を示します。例として、\"Image Scanning\" などが挙げられます。特定のドメインに関連付けることができないイベントの場合、これは \"General\" になります。 | |||
resource | |||||
numOccurrences | String | イベントに付随して発生した内容。イベントが複数回発生する可能性がある場合、それぞれの発生が追跡され、その回数が記録されます。 | int64 | ||
lastOccurredAt | Date | イベントが最後に発生した時刻を指定します。 | date-time | ||
createdAt | Date | イベントが作成された時刻を指定します。 | date-time |
1.1.1.7.4. V1AdministrationEventLevel
AdministrationEventLevel は、さまざまなレベルのイベントを公開します。
列挙値 |
---|
ADMINISTRATION_EVENT_LEVEL_UNKNOWN |
ADMINISTRATION_EVENT_LEVEL_INFO |
ADMINISTRATION_EVENT_LEVEL_SUCCESS |
ADMINISTRATION_EVENT_LEVEL_WARNING |
ADMINISTRATION_EVENT_LEVEL_ERROR |
1.1.1.7.5. V1AdministrationEventResource
リソースは、イベントに関連するリソースのすべての情報を保持します。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
type | String | イベントに関連するリソース型。イベントは、特定のイメージなど、基盤となるリソースを参照する場合があります。その場合、リソース型がここに入力されます。 | |||
id | String | イベントに関連するリソース ID。イベントが基になるリソースを参照する場合、リソース ID 別に、基になるリソースが識別されます。管理イベントのコンテキストによっては、リソース ID が必ず設定されるとは限りません。 | |||
name | String | イベントに関連するリソース名。イベントが基になるリソースを参照する場合、リソース名別に、基になるリソースが識別されます。管理イベントのコンテキストによっては、リソース名が必ず設定されるとは限りません。 |
1.1.1.7.6. V1AdministrationEventType
AdministrationEventType はさまざまな種類のイベントを公開します。
列挙値 |
---|
ADMINISTRATION_EVENT_TYPE_UNKNOWN |
ADMINISTRATION_EVENT_TYPE_GENERIC |
ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE |
1.1.1.7.7. V1ListAdministrationEventsResponse
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
events |
1.1.2. GetAdministrationEvent
GET /v1/administration/events/{id}
GetAdministrationEvent は ID によってイベントを取得します。
1.1.2.1. 説明
1.1.2.2. パラメーター
1.1.2.2.1. パスパラメーター
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
id | X | null |
1.1.2.3. 戻り値のタイプ
1.1.2.4. コンテンツタイプ
- application/json
1.1.2.5. レスポンス
コード | メッセージ | データ型 |
---|---|---|
200 | 正常な応答。 | |
0 | 予期しないエラーの応答。 |
1.1.2.6. サンプル
1.1.2.7. 共通のオブジェクト参照
1.1.2.7.1. GooglerpcStatus
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
code | Integer | int32 | |||
message | String | ||||
details | ProtobufAny のリスト |
1.1.2.7.2. ProtobufAny
Any
には、任意のシリアル化されたプロトコルバッファーメッセージと、シリアル化されたメッセージの型を記述する URL が含まれます。
Protobuf ライブラリーは、ユーティリティー関数または Any 型の追加の生成メソッドといった形式で Any 値をパック/アンパックするためのサポートを提供します。
例 1: C++ のメッセージをパックしてアンパックします。
Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
例 2: Java でメッセージをパックしてアンパックします。
Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); }
Example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }
protobuf ライブラリーによって提供される pack メソッドは、デフォルトで型 URL として 'type.googleapis.com/full.type.name' を使用し、unpack メソッドは型 URL の最後の '/' の後の完全修飾型名のみを使用します。たとえば、"foo.bar.com/x/y.z" は型名 "y.z" を生成します。
1.1.2.7.2.1. JSON 表現
Any
値の JSON 表現では、逆シリアル化された埋め込みメッセージの通常の表現が使用され、型 URL を含む追加のフィールド @type
が含まれます。以下に例を示します。
package google.profile; message Person { string first_name = 1; string last_name = 2; }
{ "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> }
埋め込まれたメッセージ型が一般的であり、カスタム JSON 表現がある場合、その表現には、@type
フィールドに加えてカスタム JSON を保持するフィールドの 値
が追加されて埋め込まれます。例 ([google.protobuf.Duration][] メッセージの場合):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
@type | String |
シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: |
1.1.2.7.3. V1AdministrationEvent
AdministrationEvents は、Central によって出力される管理イベントです。これらは、非同期のバックグラウンドタスクについてユーザーに対して透明性を提供するために使用されます。イベントは、Central のシステムヘルスビューの一部です。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
id | String | イベントの UUID。 | |||
type | ADMINISTRATION_EVENT_TYPE_UNKNOWN, ADMINISTRATION_EVENT_TYPE_GENERIC, ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE, | ||||
level | ADMINISTRATION_EVENT_LEVEL_UNKNOWN, ADMINISTRATION_EVENT_LEVEL_INFO, ADMINISTRATION_EVENT_LEVEL_SUCCESS, ADMINISTRATION_EVENT_LEVEL_WARNING, ADMINISTRATION_EVENT_LEVEL_ERROR, | ||||
message | String | イベントに関連するメッセージ。メッセージには、この特定のイベントの詳細情報が含まれる場合があります。 | |||
hint | String | イベントに関連するヒント。ヒントには、イベントの種類に応じて異なる情報が含まれる場合があります。イベントを解決するための手順や情報のヒントを含めることができます。 | |||
domain | String | イベントに関連するドメイン。イベントのドメインは、イベントが作成されたフィーチャドメインの概要を示します。例として、\"Image Scanning\" などが挙げられます。特定のドメインに関連付けることができないイベントの場合、これは \"General\" になります。 | |||
resource | |||||
numOccurrences | String | イベントに付随して発生した内容。イベントが複数回発生する可能性がある場合、それぞれの発生が追跡され、その回数が記録されます。 | int64 | ||
lastOccurredAt | Date | イベントが最後に発生した時刻を指定します。 | date-time | ||
createdAt | Date | イベントが作成された時刻を指定します。 | date-time |
1.1.2.7.4. V1AdministrationEventLevel
AdministrationEventLevel は、さまざまなレベルのイベントを公開します。
列挙値 |
---|
ADMINISTRATION_EVENT_LEVEL_UNKNOWN |
ADMINISTRATION_EVENT_LEVEL_INFO |
ADMINISTRATION_EVENT_LEVEL_SUCCESS |
ADMINISTRATION_EVENT_LEVEL_WARNING |
ADMINISTRATION_EVENT_LEVEL_ERROR |
1.1.2.7.5. V1AdministrationEventResource
リソースは、イベントに関連するリソースのすべての情報を保持します。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
type | String | イベントに関連するリソース型。イベントは、特定のイメージなど、基盤となるリソースを参照する場合があります。その場合、リソース型がここに入力されます。 | |||
id | String | イベントに関連するリソース ID。イベントが基になるリソースを参照する場合、リソース ID 別に、基になるリソースが識別されます。管理イベントのコンテキストによっては、リソース ID が必ず設定されるとは限りません。 | |||
name | String | イベントに関連するリソース名。イベントが基になるリソースを参照する場合、リソース名別に、基になるリソースが識別されます。管理イベントのコンテキストによっては、リソース名が必ず設定されるとは限りません。 |
1.1.2.7.6. V1AdministrationEventType
AdministrationEventType はさまざまな種類のイベントを公開します。
列挙値 |
---|
ADMINISTRATION_EVENT_TYPE_UNKNOWN |
ADMINISTRATION_EVENT_TYPE_GENERIC |
ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE |
1.1.2.7.7. V1GetAdministrationEventResponse
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
event |
1.1.3. CountAdministrationEvents
GET /v1/count/administration/events
CountAdministrationEvents は、要求されたフィールドでフィルタリングした後のイベントの数を返します。
1.1.3.1. 説明
1.1.3.2. パラメーター
1.1.3.2.1. クエリーパラメーター
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
filter.from | 特定のタイムスタンプ (下限) より後の last_occurred_at が含まれるイベントを特定します。 | - | null | |
filter.until | 特定のタイムスタンプ (上限) より前の last_occurred_at が含まれるイベントを特定します。 | - | null | |
filter.domain |
特定のドメインからのイベントを特定します。 | - | null | |
filter.resourceType |
特定のリソース型に関連するイベントを特定します。 | - | null | |
filter.type |
それらの型に基づいてイベントを特定します。 | - | null | |
filter.level |
レベルに基づいてイベントを特定します。 | - | null |
1.1.3.3. 戻り値のタイプ
1.1.3.4. コンテンツタイプ
- application/json
1.1.3.5. レスポンス
コード | メッセージ | データ型 |
---|---|---|
200 | 正常な応答。 | |
0 | 予期しないエラーの応答。 |
1.1.3.6. サンプル
1.1.3.7. 共通のオブジェクト参照
1.1.3.7.1. GooglerpcStatus
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
code | Integer | int32 | |||
message | String | ||||
details | ProtobufAny のリスト |
1.1.3.7.2. ProtobufAny
Any
には、任意のシリアル化されたプロトコルバッファーメッセージと、シリアル化されたメッセージの型を記述する URL が含まれます。
Protobuf ライブラリーは、ユーティリティー関数または Any 型の追加の生成メソッドといった形式で Any 値をパック/アンパックするためのサポートを提供します。
例 1: C++ のメッセージをパックしてアンパックします。
Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
例 2: Java でメッセージをパックしてアンパックします。
Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); }
Example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }
protobuf ライブラリーによって提供される pack メソッドは、デフォルトで型 URL として 'type.googleapis.com/full.type.name' を使用し、unpack メソッドは型 URL の最後の '/' の後の完全修飾型名のみを使用します。たとえば、"foo.bar.com/x/y.z" は型名 "y.z" を生成します。
1.1.3.7.2.1. JSON 表現
Any
値の JSON 表現では、逆シリアル化された埋め込みメッセージの通常の表現が使用され、型 URL を含む追加のフィールド @type
が含まれます。以下に例を示します。
package google.profile; message Person { string first_name = 1; string last_name = 2; }
{ "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> }
埋め込まれたメッセージ型が一般的であり、カスタム JSON 表現がある場合、その表現には、@type
フィールドに加えてカスタム JSON を保持するフィールドの 値
が追加されて埋め込まれます。例 ([google.protobuf.Duration][] メッセージの場合):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
@type | String |
シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: |
1.1.3.7.3. V1CountAdministrationEventsResponse
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
count | Integer | フィルタリングと重複排除後のイベントの合計数。 | int32 |