第54章 SecretService
54.1. CountSecrets
GET /v1/secretscount
CountSecrets はシークレットの数を返します。
54.1.1. 説明
54.1.2. パラメーター
54.1.2.1. クエリーパラメーター
名前 | 説明 | 必須 | デフォルト | パターン |
---|---|---|---|---|
query | - | null | ||
pagination.limit | - | null | ||
pagination.offset | - | null | ||
pagination.sortOption.field | - | null | ||
pagination.sortOption.reversed | - | null | ||
pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
pagination.sortOption.aggregateBy.distinct | - | null |
54.1.3. 戻り値のタイプ
54.1.4. コンテンツタイプ
- application/json
54.1.5. レスポンス
コード | メッセージ | データ型 |
---|---|---|
200 | 正常な応答。 | |
0 | 予期しないエラーの応答。 |
54.1.6. サンプル
54.1.7. 共通のオブジェクト参照
54.1.7.1. GooglerpcStatus
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
code | Integer | int32 | |||
message | String | ||||
details | ProtobufAny のリスト |
54.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" を生成します。
54.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 のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: |
54.1.7.3. V1CountSecretsResponse
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
count | Integer | int32 |