Package google.cloud.gkehub.v1alpha

索引

GkeHub

GKE Hub サービスは、多数の Kubernetes クラスタを Google Cloud に登録し、それらのクラスタに対するマルチクラスタ機能を管理します。

GKE Hub サービスは、次のリソースで動作します。

現在、GKE Hub はグローバル リージョンと、https://cloud.google.com/compute/docs/regions-zones に記載されているすべてのリージョンで利用できます。機能はグローバル リージョンでのみ利用できますが、メンバーシップはグローバル リージョンとすべてのリージョンで利用できます。

メンバーシップの管理は簡単ではない場合があります。メンバーシップ リソースを操作する場合は、可能な限り Google 提供のクライアント ライブラリまたはツールのいずれかを使用することをおすすめします。

CreateFeature

rpc CreateFeature(CreateFeatureRequest) returns (Operation)

新しい Feature を追加します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
CreateFleet

rpc CreateFleet(CreateFleetRequest) returns (Operation)

フリートを作成します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Operation)

新しい Membership を作成します。

これは現在、Google Cloud 上の GKE クラスタでのみサポートされています。他のクラスタを登録するには、https://cloud.google.com/kubernetes-engine/enterprise/multicluster-management/connect/registering-a-cluster の手順に沿ってください。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
CreateMembershipBinding

rpc CreateMembershipBinding(CreateMembershipBindingRequest) returns (Operation)

MembershipBinding を作成します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
CreateMembershipRBACRoleBinding

rpc CreateMembershipRBACRoleBinding(CreateMembershipRBACRoleBindingRequest) returns (Operation)

Membership の RBACRoleBinding を作成します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
CreateScope

rpc CreateScope(CreateScopeRequest) returns (Operation)

Scope を作成します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
CreateScopeNamespace

rpc CreateScopeNamespace(CreateScopeNamespaceRequest) returns (Operation)

フリートの Namespace を作成します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
CreateScopeRBACRoleBinding

rpc CreateScopeRBACRoleBinding(CreateScopeRBACRoleBindingRequest) returns (Operation)

Scope の RBACRoleBinding を作成します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
DeleteFeature

rpc DeleteFeature(DeleteFeatureRequest) returns (Operation)

Feature を削除します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
DeleteFleet

rpc DeleteFleet(DeleteFleetRequest) returns (Operation)

Fleet を削除します。Fleet にメンバーシップが残っていない場合にのみ削除を実行します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Operation)

Membership を削除します。

これは現在、Google Cloud 上の GKE クラスタでのみサポートされています。他のクラスタの登録を解除するには、https://cloud.google.com/kubernetes-engine/enterprise/multicluster-management/connect/unregistering-a-cluster の手順に沿ってください。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
DeleteMembershipBinding

rpc DeleteMembershipBinding(DeleteMembershipBindingRequest) returns (Operation)

MembershipBinding を削除します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
DeleteMembershipRBACRoleBinding

rpc DeleteMembershipRBACRoleBinding(DeleteMembershipRBACRoleBindingRequest) returns (Operation)

Membership の RBACRoleBinding を削除します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
DeleteScope

rpc DeleteScope(DeleteScopeRequest) returns (Operation)

Scope を削除します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
DeleteScopeNamespace

rpc DeleteScopeNamespace(DeleteScopeNamespaceRequest) returns (Operation)

フリートの Namespace を削除します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
DeleteScopeRBACRoleBinding

rpc DeleteScopeRBACRoleBinding(DeleteScopeRBACRoleBindingRequest) returns (Operation)

Scope の RBACRoleBinding を削除します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
GenerateConnectManifest

rpc GenerateConnectManifest(GenerateConnectManifestRequest) returns (GenerateConnectManifestResponse)

GKE Connect エージェントのデプロイ用のマニフェストを生成します。

このメソッドは、Google 提供のライブラリで内部的に使用されます。ほとんどのクライアントは、このメソッドを直接呼び出す必要はありません。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
GenerateMembershipRBACRoleBindingYAML

rpc GenerateMembershipRBACRoleBindingYAML(GenerateMembershipRBACRoleBindingYAMLRequest) returns (GenerateMembershipRBACRoleBindingYAMLResponse)

指定された RoleBinding とそれに関連付けられた権限借用リソースの RBAC ポリシーの YAML を生成します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
GetFeature

rpc GetFeature(GetFeatureRequest) returns (Feature)

1 つの Feature の詳細を取得します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
GetFleet

rpc GetFleet(GetFleetRequest) returns (Fleet)

フリートの詳細を返します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

Membership の詳細を取得します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
GetMembershipBinding

rpc GetMembershipBinding(GetMembershipBindingRequest) returns (MembershipBinding)

MembershipBinding の詳細を返します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
GetMembershipRBACRoleBinding

rpc GetMembershipRBACRoleBinding(GetMembershipRBACRoleBindingRequest) returns (RBACRoleBinding)

Membership の RBACRoleBinding の詳細を返します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
GetScope

rpc GetScope(GetScopeRequest) returns (Scope)

Scope の詳細を返します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
GetScopeNamespace

rpc GetScopeNamespace(GetScopeNamespaceRequest) returns (Namespace)

フリートの Namespace の詳細を返します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
GetScopeRBACRoleBinding

rpc GetScopeRBACRoleBinding(GetScopeRBACRoleBindingRequest) returns (RBACRoleBinding)

Scope の RBACRoleBinding の詳細を返します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
ListAdminClusterMemberships

rpc ListAdminClusterMemberships(ListAdminClusterMembershipsRequest) returns (ListAdminClusterMembershipsResponse)

指定されたプロジェクトとロケーションの管理クラスタの Membership を一覧表示します。

このメソッドは内部でのみ使用されます。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
ListFeatures

rpc ListFeatures(ListFeaturesRequest) returns (ListFeaturesResponse)

指定されたプロジェクトとロケーションの Feature を一覧表示します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
ListFleets

rpc ListFleets(ListFleetsRequest) returns (ListFleetsResponse)

呼び出し元がアクセスできる組織またはプロジェクト内のすべてのフリートを返します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
ListMembershipBindings

rpc ListMembershipBindings(ListMembershipBindingsRequest) returns (ListMembershipBindingsResponse)

MembershipBinding を一覧表示します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
ListMembershipRBACRoleBindings

rpc ListMembershipRBACRoleBindings(ListMembershipRBACRoleBindingsRequest) returns (ListMembershipRBACRoleBindingsResponse)

すべてのメンバーシップ RBACRoleBinding を一覧表示します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

指定されたプロジェクトとロケーションの Membership を一覧表示します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
ListScopeNamespaces

rpc ListScopeNamespaces(ListScopeNamespacesRequest) returns (ListScopeNamespacesResponse)

フリートの Namespace を一覧表示します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
ListScopeRBACRoleBindings

rpc ListScopeRBACRoleBindings(ListScopeRBACRoleBindingsRequest) returns (ListScopeRBACRoleBindingsResponse)

すべての Scope の RBACRoleBinding を一覧表示します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
ListScopes

rpc ListScopes(ListScopesRequest) returns (ListScopesResponse)

Scope を一覧表示します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
UpdateFeature

rpc UpdateFeature(UpdateFeatureRequest) returns (Operation)

既存の Feature を更新します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
UpdateFleet

rpc UpdateFleet(UpdateFleetRequest) returns (Operation)

フリートを更新します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Operation)

既存の Membership を更新します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
UpdateMembershipBinding

rpc UpdateMembershipBinding(UpdateMembershipBindingRequest) returns (Operation)

MembershipBinding を更新します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
UpdateMembershipRBACRoleBinding

rpc UpdateMembershipRBACRoleBinding(UpdateMembershipRBACRoleBindingRequest) returns (Operation)

Membership の RBACRoleBinding を更新します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
UpdateScope

rpc UpdateScope(UpdateScopeRequest) returns (Operation)

スコープを更新します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
UpdateScopeNamespace

rpc UpdateScopeNamespace(UpdateScopeNamespaceRequest) returns (Operation)

フリートの Namespace を更新します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
UpdateScopeRBACRoleBinding

rpc UpdateScopeRBACRoleBinding(UpdateScopeRBACRoleBindingRequest) returns (Operation)

Scope の RBACRoleBinding を更新します。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。
ValidateCreateMembership

rpc ValidateCreateMembership(ValidateCreateMembershipRequest) returns (ValidateCreateMembershipResponse)

ValidateCreateMembership は、CreateMembership のプリフライト チェックです。次の点を確認します。1. 呼び出し元には必要な gkehub.memberships.create 権限がある。2. membership_id が引き続き使用できる。

認可スコープ

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

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

詳細については、認証の概要をご覧ください。

ApplianceCluster

ApplianceCluster には、GDC Edge アプライアンス クラスタに固有の情報が含まれています。

フィールド

Authority

Authority は、Google がこのメンバーシップの ID をどのように認識するかを表します。詳細については、Workload Identity のドキュメント（https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity）をご覧ください。

フィールド
issuer

string

省略可。JSON Web Token（JWT）の発行者 URI。issuer は https:// で始まり、長さが 2,000 文字未満の有効な URL であることが必要です。GKE クラスタでは、zone ではなく location を使用する必要があります。

設定されている場合、Google は、この発行元の有効な OIDC トークンが workload_identity_pool 内で認証されるようにします。この URI で OIDC ディスカバリが行われ、発行者からのトークンが検証されます。

issuer をクリアすると、Workload Identity が無効になります。issuer は直接変更できません。新しい発行元を使用する前にクリア（Workload Identity を無効に）して、Workload Identity を再度有効にする必要があります。
workload_identity_pool

string

出力専用。issuer が認識される Workload Identity プールの名前。

Hub ごとに 1 つの Workload Identity プールがあり、ハブに属するすべてのメンバーシップ間で共有されます。{PROJECT_ID} でホストされているハブの場合、ワークロード プールの形式は {PROJECT_ID}.hub.id.goog ですが、この API の新しいバージョンで変更される可能性があります。
identity_provider

string

出力専用。Workload Identity プールの issuer を反映する ID プロバイダ。
oidc_jwks

bytes

省略可。この Membership の OIDC 検証鍵（JWKS 形式）（RFC 7517）。

このフィールドが設定されている場合、OIDC ディスカバリは issuer で実行されず、代わりにこのフィールドを使用して OIDC トークンが検証されます。

BinaryAuthorizationConfig

BinaryAuthorizationConfig は、バイナリ認証機能のフリートレベルの構成を定義します。

フィールド
evaluation_mode

BinaryAuthorizationConfig.EvaluationMode

省略可。binauthz ポリシー評価のオペレーション モード。
policy_bindings[]

BinaryAuthorizationConfig.PolicyBinding

省略可。このクラスタに適用される Binauthz ポリシー。

EvaluationMode

Binary Authorization の動作モード。

列挙型
EVALUATION_MODE_UNSPECIFIED デフォルト値
DISABLED BinaryAuthorization を無効にする
POLICY_BINDINGS policy_bindings で指定されたポリシーで Binary Authorization を使用します。

PolicyBinding

このクラスタに適用される Binauthz ポリシー。

フィールド
name

string

監査する binauthz プラットフォーム ポリシーの相対リソース名。GKE プラットフォーム ポリシーの形式は projects/{project_number}/platforms/gke/policies/{policy_id} です。

CommonFeatureSpec

CommonFeatureSpec には、Hub 全体の構成情報が含まれています

フィールド

共用体フィールド feature_spec。

feature_spec は次のいずれかになります。
multiclusteringress

FeatureSpec

マルチクラスタ Ingress 固有の仕様。
cloudauditlogging

FeatureSpec

Cloud Audit Logging 固有の仕様。
workloadcertificate

FeatureSpec

ワークロード証明書の仕様。
appdevexperience

AppDevExperienceFeatureSpec

Appdevexperience 固有の仕様。
anthosobservability

AnthosObservabilityFeatureSpec

Anthos Observability の仕様
fleetobservability

FeatureSpec

FleetObservability 機能の使用
namespaceactuation

FeatureSpec

Namespace Actuation 機能の仕様
clusterupgrade

FleetSpec

ClusterUpgrade（フリートベース）機能の仕様。
dataplanev2

FeatureSpec

DataplaneV2 機能の仕様。

CommonFeatureState

CommonFeatureState には、Hub 全体の Feature のステータス情報が含まれます。

フィールド
state

FeatureState

出力専用。この Hub の Feature の「実行状態」。

共用体フィールド feature_state。

feature_state は次のいずれかになります。
servicemesh

FeatureState

サービス メッシュ固有の状態。
appdevexperience

AppDevExperienceFeatureState

Appdevexperience 固有の状態。
fleetobservability

FeatureState

FleetObservability 機能の状態。
namespaceactuation

FeatureState

Namespace Actuation 機能の状態。
clusterupgrade

FleetState

ClusterUpgrade フリートレベルの状態。

CommonFleetDefaultMemberConfigSpec

CommonFleetDefaultMemberConfigSpec には、フリートのメンバーシップに関するデフォルトの構成情報が含まれています。

フィールド

共用体フィールド feature_spec。

feature_spec は次のいずれかになります。
mesh

MembershipSpec

Anthos Service Mesh 固有の仕様
configmanagement

MembershipSpec

Config Management 固有の仕様。
identityservice

MembershipSpec

Identity Service 固有の仕様。
policycontroller

MembershipSpec

Policy Controller の仕様。

ConnectAgentResource

ConnectAgentResource は、Connect Agent デプロイの Kubernetes リソース マニフェストを表します。

フィールド
type

TypeMeta

リソースの Kubernetes タイプ。
manifest

string

リソースの YAML マニフェスト。

CreateFeatureRequest

GkeHub.CreateFeature メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。Feature が作成される親（プロジェクトとロケーション）。projects/*/locations/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.features.create
feature_id

string

作成する機能の ID。
resource

Feature

作成する Feature リソース。
request_id

string

リクエストを識別するリクエスト ID。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

CreateFleetRequest

GkeHub.CreateFleet メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。Fleet が作成される親（プロジェクトとロケーション）。projects/*/locations/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.fleet.create
fleet

Fleet

必須。作成するフリート。

CreateMembershipBindingRequest

MembershipBinding の作成リクエスト。

フィールド
parent

string

必須。MembershipBinding が作成される親（プロジェクトとロケーション）。projects/*/locations/*/memberships/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.membershipbindings.create
membership_binding

MembershipBinding

必須。作成する MembershipBinding。
membership_binding_id

string

必須。MembershipBinding に使用する ID。

CreateMembershipRBACRoleBindingRequest

rbacrolebindings の作成リクエスト。

フィールド
parent

string

必須。RBACRoleBinding が作成される親（プロジェクトとロケーション）。projects/*/locations/*/memberships/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.rbacrolebindings.create
rbacrolebinding_id

string

必須。クライアントが選択した RBACRoleBinding の ID。rbacrolebinding_id は、RFC 1123 に準拠した有効な DNS ラベルにする必要があります。

  1. 最大 63 文字
  2. 小文字の英数字または - で構成する必要があります
  3. 先頭と末尾は英数字にする必要があります

これは正規表現 [a-z0-9]([-a-z0-9]*[a-z0-9])? で表され、最大 63 文字です。
rbacrolebinding

RBACRoleBinding

必須。作成する rbacrolebindings。

CreateMembershipRequest

GkeHub.CreateMembership メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。Membership が作成される親（プロジェクトとロケーション）。projects/*/locations/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.memberships.create
membership_id

string

必須。メンバーシップ用にクライアントが選択した ID。membership_id は、RFC 1123 に準拠した有効な DNS ラベルにする必要があります。

  1. 最大 63 文字
  2. 小文字の英数字または - で構成する必要があります
  3. 先頭と末尾は英数字にする必要があります

これは正規表現 [a-z0-9]([-a-z0-9]*[a-z0-9])? で表され、最大 63 文字です。
resource

Membership

必須。作成するメンバーシップ。
request_id

string

省略可。リクエストを識別するリクエスト ID。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

CreateScopeNamespaceRequest

フリートの Namespace の作成リクエスト。

フィールド
parent

string

必須。Namespace が作成される親（プロジェクトとロケーション）。projects/*/locations/*/scopes/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.namespaces.create
scope_namespace_id

string

必須。クライアントが選択した Namespace の ID。namespace_id は、RFC 1123 に準拠した有効な DNS ラベルにする必要があります。

  1. 最大 63 文字
  2. 小文字の英数字または - で構成する必要があります
  3. 先頭と末尾は英数字にする必要があります

これは正規表現 [a-z0-9]([-a-z0-9]*[a-z0-9])? で表され、最大 63 文字です。
scope_namespace

Namespace

必須。作成するフリートの Namespace。

CreateScopeRBACRoleBindingRequest

rbacrolebindings の作成リクエスト。

フィールド
parent

string

必須。RBACRoleBinding が作成される親（プロジェクトとロケーション）。projects/*/locations/*/scopes/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.rbacrolebindings.create
rbacrolebinding_id

string

必須。クライアントが選択した RBACRoleBinding の ID。rbacrolebinding_id は、RFC 1123 に準拠した有効な DNS ラベルにする必要があります。

  1. 最大 63 文字
  2. 小文字の英数字または - で構成する必要があります
  3. 先頭と末尾は英数字にする必要があります

これは正規表現 [a-z0-9]([-a-z0-9]*[a-z0-9])? で表され、最大 63 文字です。
rbacrolebinding

RBACRoleBinding

必須。作成する rbacrolebindings。

CreateScopeRequest

Scope の作成リクエスト。

フィールド
parent

string

必須。Scope が作成される親（プロジェクトとロケーション）。projects/*/locations/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.scopes.create
scope_id

string

必須。クライアントが選択した Scope の ID。scope_id は ???? にする必要があります。
scope

Scope

必須。作成する Scope。

DefaultClusterConfig

DefaultClusterConfig は、フリート内で作成されたすべてのクラスタに適用されるデフォルトのクラスタ構成を記述します。

フィールド
security_posture_config

SecurityPostureConfig

クラスタのセキュリティ ポスチャー機能を有効または無効にします。
binary_authorization_config

BinaryAuthorizationConfig

省略可。クラスタの Binary Authorization 機能を有効または無効にします。

DeleteFeatureRequest

GkeHub.DeleteFeature メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。projects/*/locations/*/features/* 形式の Feature リソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.features.delete
force

bool

true に設定すると、削除時にこの Feature の未処理リソースが無視されます（つまり、FeatureState.has_resources が true に設定されます）。これらのリソースは、クリーンアップも変更もされません。
request_id

string

省略可。リクエストを識別するリクエスト ID。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

DeleteFleetRequest

GkeHub.DeleteFleet メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。Fleet リソース名（projects/*/locations/*/fleets/* の形式）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.fleet.delete

DeleteMembershipBindingRequest

Binding を削除するリクエスト。

フィールド
name

string

必須。MembershipBinding リソース名（projects/*/locations/*/memberships/*/bindings/* の形式）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.membershipbindings.get

DeleteMembershipRBACRoleBindingRequest

Membership の RBACRoleBinding を削除するリクエスト。

フィールド
name

string

必須。RBACRoleBinding リソース名（形式: projects/*/locations/*/memberships/*/rbacrolebindings/*）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.rbacrolebindings.delete

DeleteMembershipRequest

GkeHub.DeleteMembership メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。Membership リソース名（形式: projects/*/locations/*/memberships/*）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.memberships.delete
request_id

string

省略可。リクエストを識別するリクエスト ID。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。
force

bool

省略可。true に設定すると、この Membership のサブリソースも削除されます。それ以外の場合、リクエストは Membership にサブリソースがない場合のみ機能します。

DeleteScopeNamespaceRequest

フリートの Namespace を削除するリクエスト。

フィールド
name

string

必須。projects/*/locations/*/scopes/*/namespaces/* 形式の Namespace リソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.namespaces.delete

DeleteScopeRBACRoleBindingRequest

Scope の RBACRoleBinding の削除リクエスト。

フィールド
name

string

必須。RBACRoleBinding リソース名（形式: projects/*/locations/*/scopes/*/rbacrolebindings/*）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.rbacrolebindings.delete

DeleteScopeRequest

Scope の削除リクエスト。

フィールド
name

string

必須。Scope のリソース名（projects/*/locations/*/scopes/* の形式）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.scopes.delete

EdgeCluster

EdgeCluster には、Google エッジクラスタに固有の情報が含まれています。

フィールド

Feature

Feature は、Hub Feature の設定とステータスを表します。

フィールド
name

string

出力専用。この Feature リソースの完全で一意の名前（形式: projects/*/locations/*/features/*）。
labels

map<string, string>

この Feature のラベル。
resource_state

FeatureResourceState

出力専用。Feature リソース自体の状態。
spec

CommonFeatureSpec

省略可。Hub 全体の Feature の構成。この Feature が Hub 全体の構成をサポートしていない場合、このフィールドは使用されません。
membership_specs

map<string, MembershipFeatureSpec>

省略可。この Feature の Membership 固有の構成。この Feature が Membership ごとの構成をサポートしていない場合、このフィールドは使用されません。

キーは、どの Membership の構成かを示します。形式は次のとおりです。

projects/{p}/locations/{l}/memberships/{m}

ここで、{p} はプロジェクト、{l} は有効なロケーション、{m} はそのロケーションのこのプロジェクトで有効な Membership です。{p} は Feature のプロジェクトと一致します。

{p} は常にプロジェクト番号として返されますが、入力時にプロジェクト ID も使用できます。マップ内で同じ Membership が 2 回（プロジェクト ID 形式とプロジェクト番号形式で）指定されている場合、エントリのうち 1 つだけが保存されます。どちらが保存されるかは保証されません。そのため、Feature を変更する際には、すべてのエントリに同じ形式を使用することをおすすめします。
state

CommonFeatureState

出力専用。Hub 全体の Feature のステータス。
membership_states

map<string, MembershipFeatureState>

出力専用。Membership 固有の Feature ステータス。この Feature が Membership ごとのステータスを報告する場合、このフィールドは使用されない可能性があります。

キーは、どの Membership の状態であるかを示します。形式は次のとおりです。

projects/{p}/locations/{l}/memberships/{m}

ここで、{p} はプロジェクト番号、{l} は有効なロケーション、{m} はそのロケーションのこのプロジェクトで有効な Membership です。{p} は、Feature のプロジェクト番号と一致しなければなりません。
create_time

Timestamp

出力専用。Feature リソースが作成された日時。
update_time

Timestamp

出力専用。Feature リソースが最後に更新された日時。
delete_time

Timestamp

出力専用。Feature リソースが削除された日時。
fleet_default_member_config

CommonFleetDefaultMemberConfigSpec

省略可。フリートのすべてのメンバーシップに適用される Feature 構成。
scope_specs

map<string, ScopeFeatureSpec>

省略可。この Feature の Scope 固有の構成。この Feature が Scope ごとの構成をサポートしていない場合、このフィールドは使用されません。

キーは、どの Scope の構成かを示します。形式は次のとおりです。

projects/{p}/locations/global/scopes/{s}

{p} はプロジェクト、{s} はこのプロジェクトの有効な Scope です。{p} は Feature のプロジェクトと一致します。

{p} は常にプロジェクト番号として返されますが、入力時にプロジェクト ID も使用できます。マップ内で同じ Scope が 2 回（プロジェクト ID 形式とプロジェクト番号形式で）指定されている場合、エントリのうち 1 つだけが保存されます。どちらが保存されるかは保証されません。そのため、Feature を変更する際には、すべてのエントリに同じ形式を使用することをおすすめします。
scope_states

map<string, ScopeFeatureState>

出力専用。Scope 固有の Feature ステータス。この Feature が Scope ごとのステータスを報告する場合、このフィールドは使用されない可能性があります。

キーは、どの Scope の状態かを示します。形式は次のとおりです。

projects/{p}/locations/global/scopes/{s}

{p} はプロジェクト、{s} はこのプロジェクトの有効な Scope です。{p} は Feature のプロジェクトと一致します。

FeatureResourceState

FeatureResourceState は、GkeHub API の Feature リソースの状態を表します。Hub と Memberships 全体で Feature の「実行状態」を確認するには、FeatureState をご覧ください。

フィールド
state

FeatureResourceState.State

Hub API の Feature リソースの現在の状態。

State

State は、Feature のライフサイクル ステータスを表します。

列挙型
STATE_UNSPECIFIED State が不明か、未設定です。
ENABLING Feature を有効にして Feature リソースを作成しています。完了すると、この Hub で対応する Feature が有効になります。
ACTIVE この Hub で Feature が有効になり、Feature リソースが完全に利用可能になります。
DISABLING この Hub で Feature を無効にして Feature リソースを削除しています。
UPDATING Feature リソースの更新中です。
SERVICE_UPDATING Hub Service が Feature リソースを更新しています。

FeatureState

FeatureState は、Feature の状態を概要レベルで表します。コンテキストに応じて、環境レベルまたはメンバーショップごとに Feature の状態を記述するために使用できます。

フィールド
code

FeatureState.Code

この Feature のステータス。機械可読性のある概要レベルで表します。
description

string

現在のステータスの説明（人が読める形式）。
update_time

Timestamp

このステータスとそれに関連する Feature 固有の詳細が更新された時刻。

Code

Code は、Feature のステータスを機械可読性のある概要レベルで表します。

列挙型
CODE_UNSPECIFIED 不明または未設定。
OK Feature は正常に動作しています。
WARNING Feature で問題が発生し、性能が低下した状態で動作しています。Feature を通常の動作に戻すための介入が必要になる場合があります。詳しくは、説明と関連する Feature 固有の詳細をご覧ください。
ERROR Feature が動作していないか、著しく性能が低下した状態になっています。Feature を通常の動作に戻すための介入が必要になる場合があります。詳しくは、説明と関連する Feature 固有の詳細をご覧ください。

Fleet

Fleet には、Fleet 全体のメタデータと構成が含まれています。

フィールド
name

string

出力専用。このフリートの完全な一意のリソース名（形式: projects/{project}/locations/{location}/fleets/{fleet}）。

各 Google Cloud プロジェクトには、「default」という名前の Fleet リソースを 1 つだけ設定できます。
display_name

string

省略可。ユーザーが割り当てた Fleet の表示名。指定する場合は、4～30 文字にする必要があります。使用できる文字は、大文字と小文字、数字、ハイフン、単一引用符、二重引用符、スペース、および感嘆符です。

例: Production Fleet
create_time

Timestamp

出力専用。Fleet の作成日時。
update_time

Timestamp

出力専用。Fleet が最後に更新された日時。
delete_time

Timestamp

出力専用。Fleet が削除された日時。
uid

string

出力専用。このリソースの Google 生成 UUID。これは、すべての Fleet リソースで固有のものです。Fleet リソースが削除され、同じ名前のリソースが作成されると、uid は異なる値になります。
state

FleetLifecycleState

出力専用。Namespace リソースの状態。
default_cluster_config

DefaultClusterConfig

省略可。フリート全体に適用するデフォルトのクラスタ構成。
labels

map<string, string>

省略可。この Fleet のラベル。

FleetLifecycleState

FleetLifecycleState は、Fleet リソースの状態を表します。

フィールド
code

FleetLifecycleState.Code

出力専用。Fleet リソースの現在の状態。

Code

Code は、Fleet リソースの状態を表します。

列挙型
CODE_UNSPECIFIED コードが設定されていません。
CREATING フリートの作成中です。
READY フリートは有効です。
DELETING フリートの削除中です。
UPDATING フリートの更新中です。

GenerateConnectManifestRequest

GkeHub.GenerateConnectManifest メソッドに対するリクエスト メッセージ。 .

フィールド
name

string

必須。エージェントに関連付ける Membership リソースの名前（projects/*/locations/*/memberships/* 形式）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.memberships.generateConnectManifest
namespace

string

省略可。GKE Connect エージェント リソースの Namespace。デフォルトは gke-connect です。

Connect Agent は、デフォルトの Namespace で実行されると自動的に承認されます。それ以外の場合は、追加の IAM バインディングで明示的に認可する必要があります。
proxy

bytes

省略可。エージェントから gkeconnect.googleapis.com への接続にプロキシの使用が必要な場合のプロキシの URI。プロキシでサポートされている HTTP / HTTPS プロトコルに応じて、http(s)://{proxy_address} 形式にする必要があります。これにより、Connect エージェントのアウトバウンド トラフィックが HTTP(S) プロキシを経由するようになります。
version

string

省略可。使用する Connect エージェントのバージョン。デフォルトでは、最新バージョンになります。
is_upgrade

bool

省略可。true の場合、アップグレード専用のリソースを生成します。インストール専用に生成された一部のリソース（シークレットなど）は除外されます。
registry

string

省略可。Connect エージェント イメージを取得するレジストリ。デフォルトは gcr.io/gkeconnect です。
image_pull_secret_content

bytes

省略可。レジストリのイメージ pull シークレット コンテンツ（公開されていない場合）。

GenerateConnectManifestResponse

GenerateConnectManifestResponse には、Connect エージェントのインストール / アップグレードに関するマニフェスト情報が含まれています。

フィールド
manifest[]

ConnectAgentResource

GKE Connect エージェントのインストールまたはアップグレードのためにクラスタに適用する必要がある Kubernetes リソースの順序付きリスト。

GenerateMembershipRBACRoleBindingYAMLRequest

指定された RoleBinding とそれに関連付けられた権限借用リソースの RBAC ポリシーの YAML を生成するリクエスト。

フィールド
parent

string

必須。RBACRoleBinding が作成される親（プロジェクトとロケーション）。projects/*/locations/*/memberships/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.rbacrolebindings.get
rbacrolebinding_id

string

必須。クライアントが選択した RBACRoleBinding の ID。rbacrolebinding_id は、RFC 1123 に準拠した有効な DNS ラベルにする必要があります。

  1. 最大 63 文字
  2. 小文字の英数字または - で構成する必要があります
  3. 先頭と末尾は英数字にする必要があります

これは正規表現 [a-z0-9]([-a-z0-9]*[a-z0-9])? で表され、最大 63 文字です。
rbacrolebinding

RBACRoleBinding

必須。YAML を生成する rbacrolebindings。

GenerateMembershipRBACRoleBindingYAMLResponse

GenerateRBACRoleBindingYAML のレスポンス。

フィールド
role_bindings_yaml

string

RBAC ポリシーを含む YAML テキスト blob。

GetFeatureRequest

GkeHub.GetFeature メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。projects/*/locations/*/features/* 形式の Feature リソース名

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.features.get

GetFleetRequest

GkeHub.GetFleet メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。Fleet リソース名（projects/*/locations/*/fleets/* の形式）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.fleet.get

GetMembershipBindingRequest

GkeHub.GetMembershipBinding メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。MembershipBinding リソース名（projects/*/locations/*/memberships/*/bindings/* の形式）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.membershipbindings.get

GetMembershipRBACRoleBindingRequest

GkeHub.GetMembershipRBACRoleBinding メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。RBACRoleBinding リソース名（形式: projects/*/locations/*/memberships/*/rbacrolebindings/*）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.rbacrolebindings.get

GetMembershipRequest

GkeHub.GetMembership メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。Membership リソース名（形式: projects/*/locations/*/memberships/*）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.memberships.get

GetScopeNamespaceRequest

GkeHub.GetNamespace メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。projects/*/locations/*/scopes/*/namespaces/* 形式の Namespace リソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.namespaces.get

GetScopeRBACRoleBindingRequest

GkeHub.GetScopeRBACRoleBinding メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。RBACRoleBinding リソース名（形式: projects/*/locations/*/scopes/*/rbacrolebindings/*）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.rbacrolebindings.get

GetScopeRequest

GkeHub.GetScope メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。Scope のリソース名（projects/*/locations/*/scopes/* の形式）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.scopes.get

GkeCluster

GkeCluster には、GKE クラスタに固有の情報が含まれています。

フィールド
cluster_missing

bool

出力専用。cluster_missing が設定されている場合は、GKE クラスタが GKE コントロール プレーンに存在しないことを示します。

KubernetesMetadata

KubernetesMetadata は、Kubernetes クラスタを表すメンバーシップに関する情報のメタデータを提供します。

フィールド
kubernetes_api_server_version

string

出力専用。/version によって報告された Kubernetes API サーバーのバージョン文字列。
node_provider_id

string

出力専用。Kubernetes エンドポイントのノードリストの最初のノードから報告されたノード providerID。ノードなしクラスタをサポートする Kubernetes プラットフォーム（GKE-on-GCP など）では、node_count は 0 になり、node_provider_id は空になります。
node_count

int32

出力専用。Kubernetes ノードリソースによって報告されるノード数。
vcpu_count

int32

出力専用。Kubernetes ノードリソースによって報告される vCPU 数。
memory_mb

int32

出力専用。すべての Kubernetes ノードリソースの合計によって報告される合計メモリ容量（単位: MB）。
update_time

Timestamp

出力専用。これらの詳細が最後に更新された時刻。EndpointDetails は API コンシューマに対して内部的に更新されるため、この update_time はメンバーシップ レベルの update_time とは異なります。

KubernetesResource

KubernetesResource には、クラスタ内の Membership Kubernetes リソースの YAML マニフェストと構成が含まれています。CreateMembership または UpdateMembership の後、これらのリソースをクラスタに再適用する必要があります。

フィールド
membership_cr_manifest

string

入力専用。Membership CR の YAML 表現。Hub が CR を直接読み取ることができる GKE クラスタでは、このフィールドは無視されます。

呼び出し元は、CreateMembership または UpdateMembership の際に、クラスタに現在存在する CR を指定する必要があります。存在しない場合は、このフィールドを空のままにします。CR マニフェストは、クラスタが別のメンバーシップに登録されていないことを検証するために使用されます。
membership_resources[]

ResourceManifest

出力専用。Membership の作成後と更新のたびにクラスタに適用する必要がある追加の Kubernetes リソース。

このフィールドは、CreateMembership または UpdateMembership の長時間実行オペレーションが成功して返された Membership にのみ入力されます。通常の GetMembership リクエストまたは ListMemberships リクエストでは入力されません。最初の登録後にリソース マニフェストを取得するには、呼び出し元が空のフィールド マスクを使用して UpdateMembership を呼び出す必要があります。
connect_resources[]

ResourceManifest

出力専用。GKE Connect エージェントをインストールするための Kubernetes リソース

このフィールドは、CreateMembership または UpdateMembership の長時間実行オペレーションが成功して返されたメンバーシップにのみ入力されます。通常の GetMembership リクエストまたは ListMemberships リクエストでは入力されません。最初の登録後にリソース マニフェストを取得するには、呼び出し元が空のフィールド マスクを使用して UpdateMembership を呼び出す必要があります。
resource_options

ResourceOptions

省略可。Kubernetes リソース生成のオプション。

ListAdminClusterMembershipsRequest

GkeHub.ListAdminClusterMemberships メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。管理クラスタの Membership が一覧表示される親（プロジェクトとロケーション）。projects/*/locations/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.memberships.list
page_size

int32

省略可。リソースの「ページ」をリクエストする場合、page_size は返されるリソースの数を指定します。指定しない場合や 0 に設定した場合は、すべてのリソースが返されます。
page_token

string

省略可。前回の ListAdminClusterMemberships 呼び出しによって返されたトークン。リソースの一覧表示を続行するリスト内の位置を指定します。
filter

string

省略可。フィルタ式に一致する管理クラスタの Membership を一覧表示します。
order_by

string

省略可。比較して出力の並べ替えに使用する 1 つ以上のフィールド。https://google.aip.dev/132#ordering をご覧ください。

ListAdminClusterMembershipsResponse

GkeHub.ListAdminClusterMemberships メソッドに対するレスポンス メッセージ。

フィールド
admin_cluster_memberships[]

Membership

一致する管理クラスタの Membership のリスト。
next_page_token

string

ListAdminClusterMemberships メソッドからリソースの次のページをリクエストするトークン。空の文字列の値は、返すリソースが他にないことを示します。
unreachable[]

string

このリストの取得中に到達できなかったロケーションのリスト。

ListFeaturesRequest

GkeHub.ListFeatures メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。Feature が一覧表示される親（プロジェクトとロケーション）。projects/*/locations/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.features.list
page_size

int32

リソースの「ページ」をリクエストする場合、page_size は返されるリソースの数を指定します。指定しない場合や 0 に設定した場合は、すべてのリソースが返されます。
page_token

string

前回の ListFeatures 呼び出しによって返されたトークン。リソースの一覧表示を続行するリスト内の位置を指定します。
filter

string

https://google.aip.dev/160 で説明されている構文に従って、フィルタ式に一致する Feature を一覧表示します。

例:

  • プロジェクト foo-proj の servicemesh という名前の Feature:
  name = "projects/foo-proj/locations/global/features/servicemesh"
  • foo というラベルを持つ Feature:
  labels.foo:*
  • 値が bar の foo というラベルを持つ Feature:
  labels.foo = bar
order_by

string

比較して出力の並べ替えに使用する 1 つ以上のフィールド。https://google.aip.dev/132#ordering をご覧ください。

ListFeaturesResponse

GkeHub.ListFeatures メソッドに対するレスポンス メッセージ。

フィールド
resources[]

Feature

一致する Feature のリスト
next_page_token

string

ListFeatures メソッドからリソースの次のページをリクエストするトークン。空の文字列の値は、返すリソースが他にないことを示します。

ListFleetsRequest

GkeHub.ListFleets メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。リストを作成する Fleet の組織またはプロジェクト（形式: organizations/*/locations/* または projects/*/locations/*）。
page_token

string

省略可。前回の ListFleets 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListFleets に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
page_size

int32

省略可。返されるフリートの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 200 のフリートが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

ListFleetsResponse

GkeHub.ListFleetsResponse メソッドに対するレスポンス メッセージ。

フィールド
fleets[]

Fleet

一致するフリートのリスト。
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。トークンは 1 時間のみ有効です。

ListMembershipBindingsRequest

MembershipBinding のリストを取得するリクエスト。

フィールド
parent

string

必須。MembershipBindings を一覧表示する親 Membership。projects/*/locations/*/memberships/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.membershipbindings.list
page_size

int32

省略可。リソースの「ページ」をリクエストする場合、page_size は返されるリソースの数を指定します。指定しない場合や 0 に設定した場合は、すべてのリソースが返されます。
page_token

string

省略可。前回の ListMembershipBindings 呼び出しによって返されたトークン。リソースの一覧表示を続行するリスト内の位置を指定します。
filter

string

省略可。https://google.aip.dev/160 で説明されている構文に従って、フィルタ式に一致する MembershipBindings を一覧表示します。

ListMembershipBindingsResponse

MembershipBindings のリスト。

フィールド
membership_bindings[]

MembershipBinding

membership_bindings のリスト
next_page_token

string

ListMembershipBindings メソッドからリソースの次のページをリクエストするトークン。空の文字列の値は、返すリソースが他にないことを示します。

ListMembershipRBACRoleBindingsRequest

Membership の RBACRoleBindings のリストを取得するリクエスト。

フィールド
parent

string

必須。Feature が一覧表示される親（プロジェクトとロケーション）。projects/*/locations/*/memberships/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.rbacrolebindings.list
page_size

int32

省略可。リソースの「ページ」をリクエストする場合、page_size は返されるリソースの数を指定します。指定しない場合や 0 に設定した場合は、すべてのリソースが返されます。
page_token

string

省略可。前回の ListMembershipRBACRoleBindings 呼び出しによって返されたトークン。リソースの一覧表示を続行するリスト内の位置を指定します。

ListMembershipRBACRoleBindingsResponse

Membership の RBACRoleBindings のリスト。

フィールド
rbacrolebindings[]

RBACRoleBinding

Membership の RBACRoleBindings のリスト。
next_page_token

string

ListMembershipRBACRoleBindings メソッドからリソースの次のページをリクエストするトークン。空の文字列の値は、返すリソースが他にないことを示します。

ListMembershipsRequest

GkeHub.ListMemberships メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。Membership がリストされる親（プロジェクトとロケーション）。projects/*/locations/* の形式で指定します。projects/*/locations/- は、すべてのリージョンのメンバーシップを一覧表示します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.memberships.list
page_size

int32

省略可。リソースの「ページ」をリクエストする場合、page_size は返されるリソースの数を指定します。指定しない場合や 0 に設定した場合は、すべてのリソースが返されます。
page_token

string

省略可。前回の ListMemberships 呼び出しによって返されたトークン。リソースの一覧表示を続行するリスト内の位置を指定します。
filter

string

省略可。https://google.aip.dev/160 で説明されている構文に従って、フィルタ式に一致するメンバーシップを一覧表示します。

例:

  • プロジェクト foo-proj とロケーション global での名前は bar です。
  name = "projects/foo-proj/locations/global/membership/bar"
  • foo というラベルを持つメンバーシップ:
  labels.foo:*
  • 値が bar の foo というラベルを持つメンバーシップ:
  labels.foo = bar
  • 状態が CREATING のメンバーシップ:
  state = CREATING
order_by

string

省略可。比較して出力の並べ替えに使用する 1 つ以上のフィールド。https://google.aip.dev/132#ordering をご覧ください。

ListMembershipsResponse

GkeHub.ListMemberships メソッドに対するレスポンス メッセージ。

フィールド
resources[]

Membership

一致する Membership のリスト。
next_page_token

string

ListMemberships メソッドからリソースの次のページをリクエストするトークン。空の文字列の値は、返すリソースが他にないことを示します。
unreachable[]

string

このリストの取得中に到達できなかったロケーションのリスト。

ListScopeNamespacesRequest

フリートの Namespace を一覧表示するためのリクエスト。

フィールド
parent

string

必須。Feature が一覧表示される親（プロジェクトとロケーション）。projects/*/locations/*/scopes/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.namespaces.list
page_size

int32

省略可。リソースの「ページ」をリクエストする場合、page_size は返されるリソースの数を指定します。指定しない場合や 0 に設定した場合は、すべてのリソースが返されます。
page_token

string

省略可。前回の ListFeatures 呼び出しによって返されたトークン。リソースの一覧表示を続行するリスト内の位置を指定します。

ListScopeNamespacesResponse

フリートの Namespace のリスト。

フィールド
scope_namespaces[]

Namespace

フリートの Namespace のリスト
next_page_token

string

ListNamespaces メソッドからリソースの次のページをリクエストするトークン。空の文字列の値は、返すリソースが他にないことを示します。

ListScopeRBACRoleBindingsRequest

Scope の RBACRoleBinding のリストを取得するリクエスト。

フィールド
parent

string

必須。Feature が一覧表示される親（プロジェクトとロケーション）。projects/*/locations/*/scopes/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.rbacrolebindings.list
page_size

int32

省略可。リソースの「ページ」をリクエストする場合、page_size は返されるリソースの数を指定します。指定しない場合や 0 に設定した場合は、すべてのリソースが返されます。
page_token

string

省略可。前回の ListScopeRBACRoleBindings 呼び出しによって返されたトークン。リソースの一覧表示を続行するリスト内の位置を指定します。

ListScopeRBACRoleBindingsResponse

Scope の RBACRoleBinding のリスト。

フィールド
rbacrolebindings[]

RBACRoleBinding

Scope の RBACRoleBinding のリスト。
next_page_token

string

ListScopeRBACRoleBindings メソッドからリソースの次のページをリクエストするトークン。空の文字列の値は、返すリソースが他にないことを示します。

ListScopesRequest

Scope のリストを取得するリクエスト。

フィールド
parent

string

必須。Scope がリストされる親（プロジェクトとロケーション）。projects/*/locations/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.scopes.list
page_size

int32

省略可。リソースの「ページ」をリクエストする場合、page_size は返されるリソースの数を指定します。指定しない場合や 0 に設定した場合は、すべてのリソースが返されます。
page_token

string

省略可。前回の ListScopes 呼び出しによって返されたトークン。リソースの一覧表示を続行するリスト内の位置を指定します。

ListScopesResponse

Scope のリスト。

フィールド
scopes[]

Scope

Scope のリスト
next_page_token

string

ListScopes メソッドからリソースの次のページをリクエストするトークン。空の文字列の値は、返すリソースが他にないことを示します。

Membership

Membership には、メンバー クラスタに関する情報が含まれます。

フィールド
name

string

出力専用。この Membership リソースの完全な一意の名前（形式: projects/*/locations/*/memberships/{membership_id}）。作成時に設定します。

membership_id は、RFC 1123 に準拠した有効な DNS ラベルにする必要があります。

  1. 最大 63 文字
  2. 小文字の英数字または - で構成する必要があります
  3. 先頭と末尾は英数字にする必要があります

これは正規表現 [a-z0-9]([-a-z0-9]*[a-z0-9])? で表され、最大 63 文字です。
labels

map<string, string>

省略可。このメンバーシップのラベル。
description

string

出力専用。このメンバーシップの説明。63 文字以内で指定してください。正規表現 [a-zA-Z0-9][a-zA-Z0-9_\-\.\ ]* と一致する必要があります

このフィールドは、以前の目的のために存在します。
state

MembershipState

出力専用。Membership リソースの状態。
create_time

Timestamp

出力専用。Membership が作成された日時。
update_time

Timestamp

出力専用。Membership が最後に更新された日時。
delete_time

Timestamp

出力専用。Membership が削除された日時。
external_id

string

省略可。この Membership について外部で生成および管理される ID。この ID は作成後に変更できますが、変更はおすすめしません。

ID は正規表現 [a-zA-Z0-9][a-zA-Z0-9_\-\.]* と一致する必要があります。

この Membership が Kubernetes クラスタを表す場合は、この値を kube-system Namespace オブジェクトの UID に設定する必要があります。
last_connection_time

Timestamp

出力専用。Connect を使用しているクラスタの場合、Google Cloud との間で確立された最新の接続のタイムスタンプ。この時間は継続的に更新されるのではなく、数分ごとに更新されます。GKE Connect を使用していないクラスタ、または接続に成功したことがないクラスタでは、このフィールドは設定されません。
unique_id

string

出力専用。このリソースの Google 生成 UUID。これは、すべての Membership リソースで固有のものです。Membership リソースを削除し、同じ名前のリソースを作成すると、異なる unique_id が取得されます。
authority

Authority

省略可。この Membership からワークロードを識別する方法。詳細については、Workload Identity のドキュメント（https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity）をご覧ください。
monitoring_config

MonitoringConfig

省略可。このメンバーシップのモニタリング構成情報。
共用体フィールド type。この Membership type で表されるリソースのタイプは、次のいずれか一つだけにできます。
endpoint

MembershipEndpoint

省略可。このメンバーにアクセスするためのエンドポイント情報。

MembershipBinding

MembershipBinding は Membership のサブリソースであり、Membership がバインドされている Fleet スコープ（または将来のその他の Fleet リソース）を表します。

フィールド
name

string

MembershipBinding 自体のリソース名 projects/{project}/locations/{location}/memberships/{membership}/bindings/{membershipbinding}
uid

string

出力専用。このリソースの Google 生成 UUID。これは、すべての MembershipBinding リソースで固有の値です。MembershipBinding リソースが削除され、同じ名前の別のリソースが作成されると、uid が異なります。
create_time

Timestamp

出力専用。MembershipBinding が作成された日時。
update_time

Timestamp

出力専用。MembershipBinding が最後に更新された日時。
delete_time

Timestamp

出力専用。MembershipBinding が削除された日時。
state

MembershipBindingLifecycleState

出力専用。MembershipBinding リソースの状態。
labels

map<string, string>

省略可。この MembershipBinding のラベル。
共用体フィールド target。MembershipBinding のタイプ。target には次のいずれか一つだけを指定できます。
scope

string

projects/*/locations/*/scopes/* 形式のスコープ リソース名。

MembershipBindingLifecycleState

MembershipBindingLifecycleState は、Binding リソースの状態を表します。

フィールド
code

MembershipBindingLifecycleState.Code

出力専用。MembershipBinding リソースの現在の状態。

Code

Code は、MembershipBinding リソースの状態を表します。

列挙型
CODE_UNSPECIFIED コードが設定されていません。
CREATING MembershipBinding の作成中です。
READY MembershipBinding が有効です。
DELETING MembershipBinding の削除中です。
UPDATING MembershipBinding の更新中です。

MembershipEndpoint

MembershipEndpoint には、Kubernetes API、エンドポイント、その他の Kubernetes メタデータにアクセスするために必要な情報が含まれます。

フィールド
kubernetes_metadata

KubernetesMetadata

出力専用。有用な Kubernetes 固有のメタデータ。
kubernetes_resource

KubernetesResource

省略可。安定状態にある正しく登録されたクラスタに適用するクラスタ内 Kubernetes リソース。これらのリソースは:

  • クラスタが 1 つの Hub メンバーシップにのみ登録されるようにします。
  • Membership Authority フィールドで利用可能なワークロード プール情報を伝播します。
  • デフォルトの Hub Feature を適切に初期構成します。
google_managed

bool

出力専用。このメンバーシップのライフサイクルが Google クラスタ プラットフォーム サービスによって管理されるかどうか。
共用体フィールド type。登録済みクラスタのクラスタ情報。type は次のいずれかになります。
gke_cluster

GkeCluster

省略可。GKE-on-GCP クラスタの詳細情報。
on_prem_cluster

OnPremCluster

省略可。GKE On-Prem クラスタ固有の情報。resourceLink がないオンプレミスのユーザー クラスタは、このフィールドを使用できません。代わりに、nil の「type」を使用する必要があります。
multi_cloud_cluster

MultiCloudCluster

省略可。GKE Multi-cloud クラスタ固有の情報。
edge_cluster

EdgeCluster

省略可。Google Edge クラスタ固有の情報。
appliance_cluster

ApplianceCluster

省略可。GDC Edge Appliance クラスタ固有の情報。

MembershipFeatureSpec

MembershipFeatureSpec には、単一の Membership の構成情報が含まれています。注: 機能名にはスネークケースを使用してください。

フィールド
origin

MembershipFeatureSpec.Origin

この Membership ごとの仕様が、フリート単位のデフォルトから継承されたかどうか。このフィールドは、ユーザーが Membership 構成をオーバーライドするか（暗黙的に USER に更新）、明示的に FLEET に設定することで更新できます。

共用体フィールド feature_spec。

feature_spec は次のいずれかになります。
configmanagement

MembershipSpec

Config Management 固有の仕様。
cloudbuild

MembershipSpec

Cloud Build 固有の仕様
identityservice

MembershipSpec

Identity Service 固有の仕様。
workloadcertificate

MembershipSpec

ワークロード証明書の仕様。
mesh

MembershipSpec

Anthos Service Mesh 固有の仕様
anthosobservability

AnthosObservabilityMembershipSpec

Anthos Observability 固有の仕様
policycontroller

MembershipSpec

Policy Controller の仕様。
fleetobservability

MembershipSpec

フリート オブザーバビリティ メンバーシップの仕様
namespaceactuation

MembershipSpec

FNS Actuation メンバーシップの仕様

オリジン

Origin は、この MembershipFeatureSpec のオリジンを定義します。

フィールド
type

MembershipFeatureSpec.Origin.Type

Type は、どのタイプのオリジンが設定されているかを指定します。

Type

Type は、構成を永続化したペルソナを指定します。

列挙型
TYPE_UNSPECIFIED Type が不明または未設定です。
FLEET Membership ごとの仕様がフリートレベルのデフォルトから継承されました。
FLEET_OUT_OF_SYNC Membership ごとの仕様は、フリートレベルのデフォルトから継承されていましたが、現在のデフォルトと同期されなくなりました。
USER Membership ごとの仕様がユーザー仕様から継承されました。

MembershipFeatureState

MembershipFeatureState には、単一の Membership に関する Feature のステータス情報が含まれます。

フィールド
state

FeatureState

単一メンバーシップに対するこの Feature の概要ステータス。

共用体フィールド feature_state。

feature_state は次のいずれかになります。
servicemesh

MembershipState

サービス メッシュ固有の状態。
metering

MembershipState

測定固有の状態。
configmanagement

MembershipState

Config Management 固有の状態。
identityservice

MembershipState

Identity Service 固有の状態。
appdevexperience

AppDevExperienceFeatureState

Appdevexperience 固有の状態。
policycontroller

MembershipState

Policycontroller 固有の状態。
clusterupgrade

MembershipState

ClusterUpgrade の状態。
fleetobservability

MembershipState

フリート オブザーバビリティのメンバーシップ ステータス。
namespaceactuation

MembershipState

FNS Actuation のメンバーシップ ステータス

MembershipState

MembershipState は、Membership リソースの状態を表します。

フィールド
code

MembershipState.Code

出力専用。Membership リソースの現在の状態。

Code

Code は、Membership リソースの状態を表します。

列挙型
CODE_UNSPECIFIED コードが設定されていません。
CREATING クラスタの登録中です。
READY クラスタが登録されています。
DELETING クラスタの登録解除中です。
UPDATING Membership の更新中です。
SERVICE_UPDATING Hub Service が Membership を更新しています。

MonitoringConfig

MonitoringConfig は、基盤となるクラスタの指標を Cloud Monitoring サービスに報告する方法について、Fleet ベースのアプリケーション、サービス、UI に通知します。空から非空に設定できますが、指標の一貫性を誤って破壊しないように、直接変更することはできません。

フィールド
project_id

string

省略可。Metrics のレポートに使用されるプロジェクト
location

string

省略可。Metrics のレポートに使用されるロケーション
cluster

string

省略可。指標のレポートに使用されるクラスタ名。Anthos on VMWare/Baremetal/MultiCloud クラスタの場合は、{cluster_type}/{cluster_name} の形式になります。たとえば、awsClusters/cluster_1 です。
kubernetes_metrics_prefix

string

省略可。Kubernetes システムの指標（利用可能な場合）は、この接頭辞に書き込まれます。デフォルトでは、GKE の場合は kubernetes.io、Anthos の場合は kubernetes.io/anthos になります。注: Anthos MultiCloud には現在 kubernetes.io という接頭辞が付加されています。これは kubernetes.io/anthos に移行されます。
cluster_hash

string

省略可。GKE クラスタとマルチクラウド クラスタの場合、これはクラスタ リソースの UUID です。VMWare クラスタと Baremetal クラスタの場合、これは kube-system UID です。

MultiCloudCluster

MultiCloudCluster には、GKE Multi-cloud クラスタに固有の情報が含まれています。

フィールド
cluster_missing

bool

出力専用。cluster_missing が設定されている場合、この GKE Multi-Cloud クラスタの API（gkemulticloud.googleapis.com）リソースが存在しないことを示します。

Namespace

Namespace はフリート全体の Namespace を表します

フィールド
name

string

Namespace projects/{project}/locations/{location}/namespaces/{namespace} のリソース名
uid

string

出力専用。このリソースの Google 生成 UUID。これは、すべての Namespace リソースで一意です。Namespace リソースが削除され、同じ名前で別のリソースが作成されると、UID は異なる値になります。
create_time

Timestamp

出力専用。Namespace が作成された日時。
update_time

Timestamp

出力専用。Namespace が最後に更新された日時。
delete_time

Timestamp

出力専用。Namespace が削除された日時。
state

NamespaceLifecycleState

出力専用。Namespace リソースの状態。
scope

string

必須。Namespace に関連付けられたスコープ
namespace_labels

map<string, string>

省略可。Namespace レベルのクラスタの名前空間のラベル。これらのラベルは、親スコープにバインドされたメンバー クラスタの関連する Namespace に適用されます。Scope レベルのラベル（Fleet Scope リソースの namespace_labels）は、Namespace レベルのラベルとキーを共有する場合、それよりも優先されます。キーと値は Kubernetes に準拠している必要があります。
labels

map<string, string>

省略可。この Namespace のラベル。

NamespaceLifecycleState

NamespaceLifecycleState は、Namespace リソースの状態を表します。

フィールド
code

NamespaceLifecycleState.Code

出力専用。Namespace リソースの現在の状態。

Code

Code は、Namespace リソースの状態を表します。

列挙型
CODE_UNSPECIFIED コードが設定されていません。
CREATING Namespace が作成中です。
READY Namespace がアクティブです。
DELETING Namespace を削除中です。
UPDATING Namespace が更新中です。

OnPremCluster

OnPremCluster には、GKE On-Prem クラスタに固有の情報が含まれています。

フィールド
cluster_missing

bool

出力専用。cluster_missing が設定されている場合、この GKE On-Prem クラスタの API（gkeonprem.googleapis.com）リソースが存在しないことを示します。
admin_cluster

bool

変更不可。クラスタが管理クラスタであるかどうか。
cluster_type

OnPremCluster.ClusterType

変更不可。オンプレミス クラスタのタイプ。

ClusterType

ClusterType は、オンプレミス クラスタのタイプを記述します。

列挙型
CLUSTERTYPE_UNSPECIFIED ClusterType が設定されていません。
BOOTSTRAP ClusterType はブートストラップ クラスタです。
HYBRID ClusterType はベアメタル ハイブリッド クラスタです。
STANDALONE ClusterType はベアメタル スタンドアロン クラスタです。
USER ClusterType はユーザー クラスタです。

OperationMetadata

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

フィールド
create_time

Timestamp

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

Timestamp

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

string

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

string

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

string

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

bool

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

string

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

RBACRoleBinding

RBACRoleBinding は、Fleet 全体の rbacrolebinding を表します。

フィールド
name

string

rbacrolebinding projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding} または projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding} のリソース名
uid

string

出力専用。このリソースの Google 生成 UUID。これは、すべての rbacrolebinding リソースで固有のものです。rbacrolebinding リソースが削除され、同じ名前で別のリソースが作成されると、uid が異なる値になります。
create_time

Timestamp

出力専用。rbacrolebinding が作成された日時。
update_time

Timestamp

出力専用。rbacrolebinding が最後に更新された日時。
delete_time

Timestamp

出力専用。rbacrolebinding が削除された日時。
state

RBACRoleBindingLifecycleState

出力専用。rbacrolebinding リソースの状態。
role

RBACRoleBinding.Role

必須。プリンシパルにバインドするロール
labels

map<string, string>

省略可。この RBACRolebinding のラベル。
共用体フィールド principal。クラスタで認可されるプリンシパル（少なくとも 1 つの oneof が必要です）。一方を更新すると、もう一方は自動的に設定解除されます。principal は次のいずれかになります。
user

string

user は、Kubernetes クラスタが認識するユーザーの名前です（例: alice、alice@domain.tld）。
group

string

group は、Kubernetes クラスタが認識するグループです。

Role

Role は Kubernetes ロールのタイプです。

フィールド
predefined_role

RBACRoleBinding.Role.PredefinedRoles

predefined_role は、使用する Kubernetes のデフォルト ロールです。

PredefinedRoles

PredefinedRoles は、デフォルトの Kubernetes ロールの ENUM 表現です。

列挙型
UNKNOWN UNKNOWN
ADMIN ADMIN には EDIT 権限と RBAC 権限が付与されています
EDIT EDIT では RBAC を除くすべてのリソースを編集できます
VIEW VIEW ではリソースの読み取りのみが可能です
ANTHOS_SUPPORT ANTHOS_SUPPORT により、Google サポートには複数のクラスタ リソースに対する読み取り専用アクセス権が付与されます。

RBACRoleBindingLifecycleState

RBACRoleBindingLifecycleState は、RbacRoleBinding リソースの状態を表します。

フィールド
code

RBACRoleBindingLifecycleState.Code

出力専用。rbacrolebinding リソースの現在の状態。

Code

Code は、rbacrolebinding リソースの状態を表します。

列挙型
CODE_UNSPECIFIED コードが設定されていません。
CREATING rbacrolebinding の作成中です。
READY rbacrolebinding が有効です。
DELETING rbacrolebinding の削除中です。
UPDATING rbacrolebinding の更新中です。

ResourceManifest

ResourceManifest は、クラスタに適用される単一の Kubernetes リソースを表します。

フィールド
manifest

string

リソースの YAML マニフェスト。
cluster_scoped

bool

マニフェストで指定されたリソースが cluster_scoped であるかどうか。設定されていない場合、マニフェストは Namespace スコープであると見なされます。

このフィールドは、クラスタでリソースを適用するときに REST マッピングに使用されます。

ResourceOptions

ResourceOptions は、Kubernetes リソースの生成オプションを表します。

フィールド
connect_version

string

省略可。connect_resources に使用する Connect エージェントのバージョン。最新の GKE Connect バージョンがデフォルトになります。バージョンは現在サポートされているバージョンであることが必要です。古いバージョンは拒否されます。
v1beta1_crd

bool

省略可。CustomResourceDefinition リソースには、apiextensions/v1 ではなく apiextensions/v1beta1 を使用します。このオプションは、Kubernetes apiserver バージョンが 1.16 より前のクラスタに設定する必要があります。
k8s_version

string

省略可。Kubernetes クラスタのメジャー バージョン。これは、CustomResourceDefinition リソースに使用するバージョン（apiextensions/v1beta1 または apiextensions/v1）を決定するためにのみ使用されます。

Scope

Scope は、フリート内のスコープを表します。

フィールド
name

string

スコープ projects/{project}/locations/{location}/scopes/{scope} のリソース名
uid

string

出力専用。このリソースの Google 生成 UUID。これは、すべての Scope リソースで固有のものです。Scope リソースが削除され、同じ名前の別のリソースが作成されると、uid は異なる値になります。
create_time

Timestamp

出力専用。スコープが作成された日付。
update_time

Timestamp

出力専用。スコープが最後に更新された日時。
delete_time

Timestamp

出力専用。スコープが削除された日時。
state

ScopeLifecycleState

出力専用。Scope リソースの状態。
namespace_labels

map<string, string>

省略可。Scope レベルのクラスタの Namespace のラベル。Scope にバインドされたメンバー クラスタの場合、これらのラベルは Scope の下にある各 Namespace に適用されます。Scope レベルのラベルと Namespace レベルのラベル（フリートの Namespace リソースの namespace_labels）が同じキーを共有する場合は、Scope レベルのラベルが優先されます。キーと値は Kubernetes に準拠している必要があります。
labels

map<string, string>

省略可。この Scope のラベル。

ScopeFeatureSpec

ScopeFeatureSpec には、フリート スコープの機能仕様が含まれています。

フィールド

共用体フィールド feature_spec。

feature_spec は次のいずれかになります。
clusterupgrade

ScopeSpec

スコープレベルの ClusterUpgrade 機能の仕様

ScopeFeatureState

ScopeFeatureState には、Scope 全体の Feature のステータス情報が含まれます。

フィールド
state

FeatureState

出力専用。この Scope の Feature の「実行状態」。

共用体フィールド feature_state。

feature_state は次のいずれかになります。
clusterupgrade

ScopeState

スコープレベルでの ClusterUpgrade 機能の状態

ScopeLifecycleState

ScopeLifecycleState は、Scope リソースの状態を表します。

フィールド
code

ScopeLifecycleState.Code

出力専用。Scope リソースの現在の状態。

Code

Code は、Scope リソースの状態を表します。

列挙型
CODE_UNSPECIFIED コードが設定されていません。
CREATING Scope の作成中です。
READY Scope は有効です。
DELETING Scope の削除中です。
UPDATING Scope の更新中です。

SecurityPostureConfig

SecurityPostureConfig は、Security Posture API の機能を有効または無効にするために必要なフラグを定義します。

フィールド
mode

SecurityPostureConfig.Mode

セキュリティ ポスチャー機能に使用するモードを設定します。
vulnerability_mode

SecurityPostureConfig.VulnerabilityMode

脆弱性スキャンに使用するモードを設定します。

Mode

Mode は、GKE セキュリティ ポスチャー機能の有効化モードを定義します。

列挙型
MODE_UNSPECIFIED デフォルト値が指定されていません。
DISABLED クラスタでセキュリティ ポスチャー機能を無効にします。
BASIC クラスタにセキュリティ ポスチャー機能を適用します。

VulnerabilityMode

VulnerabilityMode は、脆弱性スキャンの有効化モードを定義します。

列挙型
VULNERABILITY_MODE_UNSPECIFIED デフォルト値が指定されていません。
VULNERABILITY_DISABLED クラスタでの脆弱性スキャンを無効にします。
VULNERABILITY_BASIC クラスタに基本的な脆弱性スキャンを適用します。
VULNERABILITY_ENTERPRISE エンタープライズ レベルのクラスタ機能にセキュリティ ポスチャーの脆弱性を適用します。

TypeMeta

TypeMeta は、マニフェスト内の Kubernetes リソースのコンテンツのマーシャリング解除に必要な型情報です。

フィールド
kind

string

リソースの種類（Deployment など）。
api_version

string

リソースの APIVersion（v1 など）。

UpdateFeatureRequest

GkeHub.UpdateFeature メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。projects/*/locations/*/features/* 形式の Feature リソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.features.update
update_mask

FieldMask

更新するフィールドのマスク。
resource

Feature

update_mask で指定されたフィールドのみが更新されます。update_mask でフィールドを指定しても、ここで値を指定しないと、そのフィールドは削除されます。マップ フィールドを更新する場合は、キーの値を null または空の文字列に設定して、マップからキーを削除します。キーの値を空の文字列に更新することはできません。update_mask を特殊なパス「*」に指定すると、ユーザーが変更できるすべてのフィールドが resource と一致するように完全に置き換えられます。
request_id

string

リクエストを識別するリクエスト ID。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

UpdateFleetRequest

GkeHub.UpdateFleet メソッドに対するリクエスト メッセージ。

フィールド
fleet

Fleet

必須。更新する Fleet。

Fleet オブジェクトの name フィールドは、更新するフリートを示します。

認可には、指定されたリソース fleet に対する次の IAM の権限が必要です。

  • gkehub.fleet.update
update_mask

FieldMask

必須。更新するフィールド。

UpdateMembershipBindingRequest

MembershipBinding の更新リクエスト。

フィールド
membership_binding

MembershipBinding

必須。フィールドが更新された MembershipBinding オブジェクト。

認可には、指定されたリソース membershipBinding に対する次の IAM の権限が必要です。

  • gkehub.membershipbindings.update
update_mask

FieldMask

必須。更新するフィールド。

UpdateMembershipRBACRoleBindingRequest

メンバーシップの rbacrolebinding の更新リクエスト。

フィールド
rbacrolebinding

RBACRoleBinding

必須。フィールドが更新された rbacrolebinding。この rbacrolebinding の name フィールドは、更新するリソースの識別に使用されます。

認可には、指定されたリソース rbacrolebinding に対する次の IAM の権限が必要です。

  • gkehub.rbacrolebindings.update
update_mask

FieldMask

必須。更新するフィールド。

UpdateMembershipRequest

GkeHub.UpdateMembership メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。Membership リソース名（形式: projects/*/locations/*/memberships/*）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.memberships.update
update_mask

FieldMask

必須。更新するフィールドのマスク。
resource

Membership

必須。update_mask で指定されたフィールドのみが更新されます。update_mask でフィールドを指定しても、ここで値を指定しないと、そのフィールドは削除されます。マップ フィールドを更新する場合は、キーの値を null または空の文字列に設定して、マップからキーを削除します。キーの値を空の文字列に更新することはできません。update_mask を特殊なパス「*」に指定すると、ユーザーが変更できるすべてのフィールドが resource と一致するように完全に置き換えられます。
request_id

string

省略可。リクエストを識別するリクエスト ID。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID（00000000-0000-0000-0000-000000000000）はサポートされていません。

UpdateScopeNamespaceRequest

フリートの Namespace の更新をリクエストします。

フィールド
scope_namespace

Namespace

必須。フィールドが更新された Namespace。この Namespace の name フィールドは、更新するリソースの識別に使用されます。go/proto-best-practices-checkers#keyword_conflict に従って、接頭辞 updated を指定します

認可には、指定されたリソース scopeNamespace に対する次の IAM の権限が必要です。

  • gkehub.namespace.update
update_mask

FieldMask

必須。更新するフィールド。

UpdateScopeRBACRoleBindingRequest

スコープの rbacrolebinding を更新するリクエスト。

フィールド
rbacrolebinding

RBACRoleBinding

必須。フィールドが更新された rbacrolebinding。この rbacrolebinding の name フィールドは、更新するリソースの識別に使用されます。

認可には、指定されたリソース rbacrolebinding に対する次の IAM の権限が必要です。

  • gkehub.rbacrolebindings.update
update_mask

FieldMask

必須。更新するフィールド。

UpdateScopeRequest

Scope の更新をリクエストします。

フィールド
scope

Scope

必須。フィールドが更新された Scope。この Namespace の name フィールドは、更新するリソースの識別に使用されます。

認可には、指定されたリソース scope に対する次の IAM の権限が必要です。

  • gkehub.scopes.update
update_mask

FieldMask

必須。更新するフィールド。

ValidateCreateMembershipRequest

GkeHub.ValidateCreateMembership メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。Membership が作成される親（プロジェクトとロケーション）。projects/*/locations/* の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.memberships.create
membership_id

string

必須。クライアントが選択したメンバーシップ ID。
membership

Membership

必須。作成するメンバーシップ リソース。

ValidateCreateMembershipResponse

GkeHub.ValidateCreateMembership メソッドに対するレスポンス メッセージ。

フィールド
validation_results[]

ValidationResult

すべてのバリデータの結果をラップします。

ValidationResult

ValidationResults は、ValidateCreateMembership の実行中にバリデータによって設定される結果です。

フィールド
validator

ValidationResult.ValidatorType

メンバーシップを検証するバリデータのタイプ。
success

bool

検証が合格したかどうか。
result

string

検証に関する追加情報。

ValidatorType

さまざまなタイプの検証を指定します。

列挙型
VALIDATOR_TYPE_UNSPECIFIED UNSPECIFIED バリデータ。
MEMBERSHIP_ID MEMBERSHIP_ID バリデータは、membership_id がまだ使用可能であることを検証します。
CROSS_PROJECT_PERMISSION CROSS_PROJECT_PERMISSION バリデータは、サービス エージェントのプロジェクト間ロール バインディングが存在することを検証します。