package google.events.cloud.gkehub.v1

Get desktop application:
View/edit binary Protocol Buffers messages

ApplianceCluster contains information specific to GDC Edge Appliance Clusters.

Used in: MembershipEndpoint

• string resource_link = 1

  Immutable. Self-link of the GCP resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance

Authority encodes how Google will recognize identities from this Membership. See the workload identity documentation for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity

Used in: Membership

• string issuer = 1

  Optional. A JSON Web Token (JWT) issuer URI. `issuer` must start with `https://` and be a valid URL with length <2000 characters. If set, then Google will allow valid OIDC tokens from this issuer to authenticate within the workload_identity_pool. OIDC discovery will be performed on this URI to validate tokens from the issuer. Clearing `issuer` disables Workload Identity. `issuer` cannot be directly modified; it must be cleared (and Workload Identity disabled) before using a new issuer (and re-enabling Workload Identity).

• string workload_identity_pool = 2

  Output only. The name of the workload identity pool in which `issuer` will be recognized. There is a single Workload Identity Pool per Hub that is shared between all Memberships that belong to that Hub. For a Hub hosted in {PROJECT_ID}, the workload pool format is `{PROJECT_ID}.hub.id.goog`, although this is subject to change in newer versions of this API.

• string identity_provider = 3

  Output only. An identity provider that reflects the `issuer` in the workload identity pool.

• bytes oidc_jwks = 4

  Optional. OIDC verification keys for this Membership in JWKS format (RFC 7517). When this field is set, OIDC discovery will NOT be performed on `issuer`, and instead OIDC tokens will be validated using this field.

CommonFeatureState contains Hub-wide Feature status information.

Used in: Feature

• optional FeatureState state = 1

  Output only. The "running state" of the Feature in this Hub.

EdgeCluster contains information specific to Google Edge Clusters.

Used in: MembershipEndpoint

• string resource_link = 1

  Immutable. Self-link of the GCP resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster

Feature represents the settings and status of any Hub Feature.

Used in: FeatureEventData

• string name = 1

  Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.

• map<string, string> labels = 2

  GCP labels for this Feature.

• optional FeatureResourceState resource_state = 3

  Output only. State of the Feature resource itself.

• optional CommonFeatureState state = 6

  Output only. The Hub-wide Feature state.

• map<string, MembershipFeatureState> membership_states = 7

  Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.

• optional protobuf.Timestamp create_time = 8

  Output only. When the Feature resource was created.

• optional protobuf.Timestamp update_time = 9

  Output only. When the Feature resource was last updated.

• optional protobuf.Timestamp delete_time = 10

  Output only. When the Feature resource was deleted.

• map<string, ScopeFeatureState> scope_states = 13

  Output only. Scope-specific Feature status. If this Feature does report any per-Scope status, this field may be unused. The keys indicate which Scope the state is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project.

The CloudEvent raised when a Feature is created.

• optional FeatureEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Feature is deleted.

• optional FeatureEventData data = 1

  The data associated with the event.

The data within all Feature events.

Used in: FeatureCreatedEvent, FeatureDeletedEvent, FeatureUpdatedEvent

• optional Feature payload = 1

  Optional. The Feature event payload. Unset for deletion events.

FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships.

Used in: Feature

• FeatureResourceState.State state = 1

  The current state of the Feature resource in the Hub API.

State describes the lifecycle status of a Feature.

Used in: FeatureResourceState

• STATE_UNSPECIFIED = 0

  State is unknown or not set.

• ENABLING = 1

  The Feature is being enabled, and the Feature resource is being created. Once complete, the corresponding Feature will be enabled in this Hub.

• ACTIVE = 2

  The Feature is enabled in this Hub, and the Feature resource is fully available.

• DISABLING = 3

  The Feature is being disabled in this Hub, and the Feature resource is being deleted.

• UPDATING = 4

  The Feature resource is being updated.

• SERVICE_UPDATING = 5

  The Feature resource is being updated by the Hub Service.

FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context.

Used in: CommonFeatureState, MembershipFeatureState, ScopeFeatureState

• FeatureState.Code code = 1

  The high-level, machine-readable status of this Feature.

• string description = 2

  A human-readable description of the current status.

• optional protobuf.Timestamp update_time = 3

  The time this status and any related Feature-specific details were updated.

Code represents a machine-readable, high-level status of the Feature.

Used in: FeatureState

• CODE_UNSPECIFIED = 0

  Unknown or not set.

• OK = 1

  The Feature is operating normally.

• WARNING = 2

  The Feature has encountered an issue, and is operating in a degraded state. The Feature may need intervention to return to normal operation. See the description and any associated Feature-specific details for more information.

• ERROR = 3

  The Feature is not operating or is in a severely degraded state. The Feature may need intervention to return to normal operation. See the description and any associated Feature-specific details for more information.

The CloudEvent raised when a Feature is updated.

• optional FeatureEventData data = 1

  The data associated with the event.

GkeCluster contains information specific to GKE clusters.

Used in: MembershipEndpoint

• string resource_link = 1

  Immutable. Self-link of the GCP resource for the GKE cluster. For example: //container.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster Zonal clusters are also supported.

• bool cluster_missing = 2

  Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane.

KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.

Used in: MembershipEndpoint

• string kubernetes_api_server_version = 1

  Output only. Kubernetes API server version string as reported by `/version`.

• string node_provider_id = 2

  Output only. Node providerID as reported by the first node in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the node_count will be zero and the node_provider_id will be empty.

• int32 node_count = 3

  Output only. Node count as reported by Kubernetes nodes resources.

• int32 vcpu_count = 4

  Output only. vCPU count as reported by Kubernetes nodes resources.

• int32 memory_mb = 5

  Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB.

• optional protobuf.Timestamp update_time = 100

  Output only. The time at which these details were last updated. This update_time is different from the Membership-level update_time since EndpointDetails are updated internally for API consumers.

KubernetesResource contains the YAML manifests and configuration for Membership Kubernetes resources in the cluster. After CreateMembership or UpdateMembership, these resources should be re-applied in the cluster.

Used in: MembershipEndpoint

• repeated ResourceManifest membership_resources = 2

  Output only. Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update. This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

• repeated ResourceManifest connect_resources = 3

  Output only. The Kubernetes resources for installing the GKE Connect agent This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

• optional ResourceOptions resource_options = 4

  Optional. Options for Kubernetes resource generation.

Membership contains information about a member cluster.

Used in: MembershipEventData

• oneof type

  Type of resource represented by this Membership

  • MembershipEndpoint endpoint = 4

    Optional. Endpoint information to reach this member.

• string name = 1

  Output only. The full, unique name of this Membership resource in the format `projects/*/locations/*/memberships/{membership_id}`, set during creation. `membership_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.

• map<string, string> labels = 2

  Optional. GCP labels for this membership.

• string description = 3

  Output only. Description of this membership, limited to 63 characters. Must match the regex: `[a-zA-Z0-9][a-zA-Z0-9_\-\.\ ]*` This field is present for legacy purposes.

• optional MembershipState state = 5

  Output only. State of the Membership resource.

• optional protobuf.Timestamp create_time = 6

  Output only. When the Membership was created.

• optional protobuf.Timestamp update_time = 7

  Output only. When the Membership was last updated.

• optional protobuf.Timestamp delete_time = 8

  Output only. When the Membership was deleted.

• string external_id = 9

  Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. The ID must match the regex: `[a-zA-Z0-9][a-zA-Z0-9_\-\.]*` If this Membership represents a Kubernetes cluster, this value should be set to the UID of the `kube-system` namespace object.

• optional protobuf.Timestamp last_connection_time = 10

  Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset.

• string unique_id = 11

  Output only. Google-generated UUID for this resource. This is unique across all Membership resources. If a Membership resource is deleted and another resource with the same name is created, it gets a different unique_id.

• optional Authority authority = 12

  Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity

MembershipBinding is a subresource of a Membership, representing what Fleet Scopes (or other, future Fleet resources) a Membership is bound to.

Used in: MembershipBindingEventData

• oneof target

  What type of membershipbinding this is.

  • string scope = 3

    A Workspace resource name in the format `projects/*/locations/*/scopes/*`.

  • bool fleet = 4

    Whether the membershipbinding is Fleet-wide; true means that this Membership should be bound to all Namespaces in this entire Fleet.

• string name = 1

  The resource name for the membershipbinding itself `projects/{project}/locations/{location}/memberships/{membership}/bindings/{membershipbinding}`

• string uid = 2

  Output only. Google-generated UUID for this resource. This is unique across all membershipbinding resources. If a membershipbinding resource is deleted and another resource with the same name is created, it gets a different uid.

• optional protobuf.Timestamp create_time = 5

  Output only. When the membership binding was created.

• optional protobuf.Timestamp update_time = 6

  Output only. When the membership binding was last updated.

• optional protobuf.Timestamp delete_time = 7

  Output only. When the membership binding was deleted.

• optional MembershipBindingLifecycleState state = 8

  Output only. State of the membership binding resource.

The CloudEvent raised when a MembershipBinding is created.

• optional MembershipBindingEventData data = 1

  The data associated with the event.

The CloudEvent raised when a MembershipBinding is deleted.

• optional MembershipBindingEventData data = 1

  The data associated with the event.

The data within all MembershipBinding events.

Used in: MembershipBindingCreatedEvent, MembershipBindingDeletedEvent, MembershipBindingUpdatedEvent

• optional MembershipBinding payload = 1

  Optional. The MembershipBinding event payload. Unset for deletion events.

MembershipBindingLifecycleState describes the state of a Binding resource.

Used in: MembershipBinding

• MembershipBindingLifecycleState.Code code = 1

  Output only. The current state of the MembershipBinding resource.

Code describes the state of a MembershipBinding resource.

Used in: MembershipBindingLifecycleState

• CODE_UNSPECIFIED = 0

  The code is not set.

• CREATING = 1

  The membershipbinding is being created.

• READY = 2

  The membershipbinding active.

• DELETING = 3

  The membershipbinding is being deleted.

• UPDATING = 4

  The membershipbinding is being updated.

The CloudEvent raised when a MembershipBinding is updated.

• optional MembershipBindingEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Membership is created.

• optional MembershipEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Membership is deleted.

• optional MembershipEventData data = 1

  The data associated with the event.

MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.

Used in: Membership

• oneof type

  Cluster information of the registered cluster.

  • GkeCluster gke_cluster = 1

    Optional. Specific information for a GKE-on-GCP cluster.

  • OnPremCluster on_prem_cluster = 4

    Optional. Specific information for a GKE On-Prem cluster. An onprem user-cluster who has no resourceLink is not allowed to use this field, it should have a nil "type" instead.

  • MultiCloudCluster multi_cloud_cluster = 5

    Optional. Specific information for a GKE Multi-Cloud cluster.

  • EdgeCluster edge_cluster = 6

    Optional. Specific information for a Google Edge cluster.

  • ApplianceCluster appliance_cluster = 7

    Optional. Specific information for a GDC Edge Appliance cluster.

• optional KubernetesMetadata kubernetes_metadata = 2

  Output only. Useful Kubernetes-specific metadata.

• optional KubernetesResource kubernetes_resource = 3

  Optional. The in-cluster Kubernetes Resources that should be applied for a correctly registered cluster, in the steady state. These resources: * Ensure that the cluster is exclusively registered to one and only one Hub Membership. * Propagate Workload Pool Information available in the Membership Authority field. * Ensure proper initial configuration of default Hub Features.

• bool google_managed = 8

  Output only. Whether the lifecycle of this membership is managed by a google cluster platform service.

The data within all Membership events.

Used in: MembershipCreatedEvent, MembershipDeletedEvent, MembershipUpdatedEvent

• optional Membership payload = 1

  Optional. The Membership event payload. Unset for deletion events.

MembershipFeatureState contains Feature status information for a single Membership.

Used in: Feature

• optional FeatureState state = 1

  The high-level state of this Feature for a single membership.

MembershipState describes the state of a Membership resource.

Used in: Membership

• MembershipState.Code code = 1

  Output only. The current state of the Membership resource.

Code describes the state of a Membership resource.

Used in: MembershipState

• CODE_UNSPECIFIED = 0

  The code is not set.

• CREATING = 1

  The cluster is being registered.

• READY = 2

  The cluster is registered.

• DELETING = 3

  The cluster is being unregistered.

• UPDATING = 4

  The Membership is being updated.

• SERVICE_UPDATING = 5

  The Membership is being updated by the Hub Service.

The CloudEvent raised when a Membership is updated.

• optional MembershipEventData data = 1

  The data associated with the event.

MultiCloudCluster contains information specific to GKE Multi-Cloud clusters.

Used in: MembershipEndpoint

• string resource_link = 1

  Immutable. Self-link of the GCP resource for the GKE Multi-Cloud cluster. For example: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster

• bool cluster_missing = 2

  Output only. If cluster_missing is set then it denotes that API(gkemulticloud.googleapis.com) resource for this GKE Multi-Cloud cluster no longer exists.

OnPremCluster contains information specific to GKE On-Prem clusters.

Used in: MembershipEndpoint

• string resource_link = 1

  Immutable. Self-link of the GCP resource for the GKE On-Prem cluster. For example: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster

• bool cluster_missing = 2

  Output only. If cluster_missing is set then it denotes that API(gkeonprem.googleapis.com) resource for this GKE On-Prem cluster no longer exists.

• bool admin_cluster = 3

  Immutable. Whether the cluster is an admin cluster.

• OnPremCluster.ClusterType cluster_type = 4

  Immutable. The on prem cluster's type.

ClusterType describes on prem cluster's type.

Used in: OnPremCluster

• CLUSTERTYPE_UNSPECIFIED = 0

  The ClusterType is not set.

• BOOTSTRAP = 1

  The ClusterType is bootstrap cluster.

• HYBRID = 2

  The ClusterType is baremetal hybrid cluster.

• STANDALONE = 3

  The ClusterType is baremetal standalone cluster.

• USER = 4

  The ClusterType is user cluster.

ResourceManifest represents a single Kubernetes resource to be applied to the cluster.

Used in: KubernetesResource

• string manifest = 1

  YAML manifest of the resource.

• bool cluster_scoped = 2

  Whether the resource provided in the manifest is `cluster_scoped`. If unset, the manifest is assumed to be namespace scoped. This field is used for REST mapping when applying the resource in a cluster.

ResourceOptions represent options for Kubernetes resource generation.

Used in: KubernetesResource

• string connect_version = 1

  Optional. The Connect agent version to use for connect_resources. Defaults to the latest GKE Connect version. The version must be a currently supported version, obsolete versions will be rejected.

• bool v1beta1_crd = 2

  Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.

• string k8s_version = 3

  Optional. Major version of the Kubernetes cluster. This is only used to determine which version to use for the CustomResourceDefinition resources, `apiextensions/v1beta1` or`apiextensions/v1`.

Scope represents a Scope in a Fleet.

Used in: ScopeEventData

• string name = 1

  The resource name for the scope `projects/{project}/locations/{location}/scopes/{scope}`

• string uid = 2

  Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.

• optional protobuf.Timestamp create_time = 3

  Output only. When the scope was created.

• optional protobuf.Timestamp update_time = 4

  Output only. When the scope was last updated.

• optional protobuf.Timestamp delete_time = 5

  Output only. When the scope was deleted.

• optional ScopeLifecycleState state = 6

  Output only. State of the scope resource.

The CloudEvent raised when a Scope is created.

• optional ScopeEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Scope is deleted.

• optional ScopeEventData data = 1

  The data associated with the event.

The data within all Scope events.

Used in: ScopeCreatedEvent, ScopeDeletedEvent

• optional Scope payload = 1

  Optional. The Scope event payload. Unset for deletion events.

ScopeFeatureState contains Scope-wide Feature status information.

Used in: Feature

• optional FeatureState state = 1

  Output only. The "running state" of the Feature in this Scope.

ScopeLifecycleState describes the state of a Scope resource.

Used in: Scope

• ScopeLifecycleState.Code code = 1

  Output only. The current state of the scope resource.

Code describes the state of a Scope resource.

Used in: ScopeLifecycleState

• CODE_UNSPECIFIED = 0

  The code is not set.

• CREATING = 1

  The scope is being created.

• READY = 2

  The scope active.

• DELETING = 3

  The scope is being deleted.

• UPDATING = 4

  The scope is being updated.