Package google.cloud.observability.v1

索引

オブザーバビリティ

リソースのハンドラを記述するサービス

CreateTraceScope

rpc CreateTraceScope(CreateTraceScopeRequest) returns (TraceScope)

新しい TraceScope を作成します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • observability.traceScopes.create

詳細については、IAM のドキュメントをご覧ください。
DeleteTraceScope

rpc DeleteTraceScope(DeleteTraceScopeRequest) returns (Empty)

TraceScope を削除します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • observability.traceScopes.delete

詳細については、IAM のドキュメントをご覧ください。
GetScope

rpc GetScope(GetScopeRequest) returns (Scope)

単一スコープの詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • observability.scopes.get

詳細については、IAM のドキュメントをご覧ください。
GetTraceScope

rpc GetTraceScope(GetTraceScopeRequest) returns (TraceScope)

TraceScope リソースを取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • observability.traceScopes.get

詳細については、IAM のドキュメントをご覧ください。
ListTraceScopes

rpc ListTraceScopes(ListTraceScopesRequest) returns (ListTraceScopesResponse)

特定のロケーションにあるプロジェクトの TraceScope を一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • observability.traceScopes.list

詳細については、IAM のドキュメントをご覧ください。
UpdateScope

rpc UpdateScope(UpdateScopeRequest) returns (Scope)

単一スコープのパラメータを更新します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • observability.scopes.update

詳細については、IAM のドキュメントをご覧ください。
UpdateTraceScope

rpc UpdateTraceScope(UpdateTraceScopeRequest) returns (TraceScope)

TraceScope を更新します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • observability.traceScopes.update

詳細については、IAM のドキュメントをご覧ください。

CreateTraceScopeRequest

TraceScope の作成のリクエスト。

フィールド
parent

string

必須。トレース スコープを作成するロケーションの完全なリソース名。

projects/[PROJECT_ID]/locations/[LOCATION_ID]

例:

projects/my-project/locations/global
trace_scope_id

string

必須。トレース スコープのクライアント割り当て識別子。
trace_scope

TraceScope

必須。新しいトレース スコープ。

DeleteTraceScopeRequest

TraceScope の削除のリクエスト。

フィールド
name

string

必須。削除するトレース スコープの完全なリソース名。

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

例:

projects/my-project/locations/global/traceScopes/my-trace-scope

GetScopeRequest

スコープを取得するためのメッセージ。

フィールド
name

string

必須。リソースの名前。書式は次のとおりです。

projects/{project}/locations/{location}/scopes/{scope}

{location} フィールドは global に設定する必要があります。{scope} フィールドは _Default に設定する必要があります。

GetTraceScopeRequest

TraceScope の取得のリクエスト。

フィールド
name

string

必須。トレース スコープのリソース名。

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

例:

projects/my-project/locations/global/traceScopes/my-trace-scope

ListTraceScopesRequest

TraceScope の一覧表示のリクエスト。

フィールド
parent

string

必須。トレース スコープを検索するロケーションの完全なリソース名。

projects/[PROJECT_ID]/locations/[LOCATION_ID]

例:

projects/my-project/locations/global
page_size

int32

省略可。このリクエストから返される結果の最大数。

正でない値は無視されます。レスポンスに next_page_token が含まれている場合、追加の結果がある可能性があることを示しています。
page_token

string

省略可。指定された場合、このメソッドの前の呼び出しから次の結果のバッチを取得します。page_token は、前のレスポンスの next_page_token の値である必要があります。他のメソッド パラメータの値は、前の呼び出しでのそれらの値と同じである必要があります。

ListTraceScopesResponse

TraceScope の一覧表示に対するレスポンス。

フィールド
trace_scopes[]

TraceScope

省略可。トレース スコープのリスト。
next_page_token

string

省略可。 このレスポンスに表示されたものより多くの結果がある可能性がある場合は、next_page_token が含まれます。次の結果セットを取得するには、next_page_token の値を page_token として使用して、同じメソッドを再度呼び出します。

OperationMetadata

長時間実行されているオペレーションのメタデータを表します。

フィールド
create_time

Timestamp

出力専用。オペレーションが作成された時刻。
end_time

Timestamp

出力専用。オペレーションの実行が終了した時刻。
target

string

出力専用。オペレーションのターゲットに対応するサーバー定義のリソースパス。
verb

string

出力専用。オペレーションによって実行される動詞の名前。
status_message

string

出力専用。人が読める形式のオペレーションのステータス（存在する場合）。
requested_cancellation

bool

出力専用。ユーザーがオペレーションのキャンセルをリクエストしたかどうかを示します。正常にキャンセルされたオペレーションは、google.rpc.Status.code が 1 の [Operation.error][] 値を持ちます。これは Code.CANCELLED に相当します。
api_version

string

出力専用。オペレーションを開始するために使用された API のバージョン。

Scope

Scope オブジェクトについて説明するメッセージ

フィールド
name

string

ID。リソースの名前。書式は次のとおりです。

projects/{project}/locations/{location}/scopes/{scope}

{location} フィールドは global に設定する必要があります。{scope} フィールドは _Default に設定する必要があります。
update_time

Timestamp

出力専用。更新タイムスタンプ。注: デフォルト スコープの更新タイムスタンプは、最初は未設定です。
log_scope

string

必須。LogScope の完全なリソース名。例:

//logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope
trace_scope

string

必須。TraceScope のリソース名。例:

projects/myproject/locations/global/traceScopes/my-trace-scope

TraceScope

トレース スコープは、トレースが一緒にクエリされるリソースのコレクションです。

フィールド
name

string

ID。トレース スコープのリソース名。

例:

projects/my-project/locations/global/traceScopes/my-trace-scope
resource_names[]

string

必須。このトレース スコープに含まれるプロジェクトの名前。

  • projects/[PROJECT_ID]

トレース スコープに含めることができるプロジェクトは最大 20 個です。
description

string

省略可。このトレース スコープの説明。

説明の最大長は 8,000 文字です。
create_time

Timestamp

出力専用。トレース スコープの作成タイムスタンプ。
update_time

Timestamp

出力専用。トレース スコープの最終更新タイムスタンプ。

UpdateScopeRequest

Scope の更新に関するメッセージ。

フィールド
update_mask

FieldMask

省略可。フィールド マスクは、更新によって Scope リソース内で上書きされるフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスク内にあるフィールドは上書きされます。ユーザーがマスクを指定しなければ、リクエスト内のすべてのフィールドが上書きされます。
scope

Scope

必須。更新されるリソース。

UpdateTraceScopeRequest

TraceScope の更新のリクエスト。

フィールド
trace_scope

TraceScope

必須。更新されたトレース スコープ。
update_mask

FieldMask

省略可。更新するフィールドのリスト。