Package-level declarations

Types

Link copied to clipboard

Anthos Observability: Spec

data class AnthosObservabilityMembershipSpecResponse(val doNotOptimizeMetrics: Boolean, val enableStackdriverOnApplications: Boolean, val version: String)

Anthosobservability: Per-Membership Feature spec.

Link copied to clipboard

Spec for App Dev Experience Feature.

Link copied to clipboard
data class AppDevExperienceFeatureStateResponse(val networkingInstallSucceeded: StatusResponse)

State for App Dev Exp Feature.

Link copied to clipboard
data class ApplianceClusterResponse(val resourceLink: String)

ApplianceCluster contains information specific to GDC Edge Appliance Clusters.

Link copied to clipboard
data class AuditConfigResponse(val auditLogConfigs: List<AuditLogConfigResponse>, val service: String)

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Link copied to clipboard
data class AuditLogConfigResponse(val exemptedMembers: List<String>, val logType: String)

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Link copied to clipboard
data class AuthorityResponse(val identityProvider: String, val issuer: String, val oidcJwks: String, val workloadIdentityPool: String)

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

Link copied to clipboard
data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

Link copied to clipboard
data class CloudAuditLoggingFeatureSpecResponse(val allowlistedServiceAccounts: List<String>)

Cloud Audit Logging: Spec for Audit Logging Allowlisting.

Link copied to clipboard
data class CommonFeatureSpecResponse(val anthosobservability: AnthosObservabilityFeatureSpecResponse, val appdevexperience: AppDevExperienceFeatureSpecResponse, val cloudauditlogging: CloudAuditLoggingFeatureSpecResponse, val fleetobservability: FleetObservabilityFeatureSpecResponse, val multiclusteringress: MultiClusterIngressFeatureSpecResponse, val workloadcertificate: FeatureSpecResponse)

CommonFeatureSpec contains Hub-wide configuration information

Link copied to clipboard

CommonFeatureState contains Hub-wide Feature status information.

CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet

Link copied to clipboard
data class EdgeClusterResponse(val resourceLink: String)

EdgeCluster contains information specific to Google Edge Clusters.

Link copied to clipboard
data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Link copied to clipboard
data class FeatureResourceStateResponse(val state: String)

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.

Link copied to clipboard
data class FeatureSpecResponse(val defaultConfig: MembershipSpecResponse, val provisionGoogleCa: String)

Workload Certificate: The Hub-wide input for the WorkloadCertificate feature.

Link copied to clipboard
data class FeatureStateResponse(val code: String, val description: String, val updateTime: String)

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.

Link copied to clipboard
data class FleetLifecycleStateResponse(val code: String)

FleetLifecycleState describes the state of a Fleet resource.

Link copied to clipboard

Fleet Observability: The Hub-wide input for the FleetObservability feature.

Link copied to clipboard

FleetObservability: An empty state left as an example Hub-wide Feature state.

Link copied to clipboard

LoggingConfig defines the configuration for different types of logs.

Link copied to clipboard

RoutingConfig configures the behaviour of fleet logging feature.

Link copied to clipboard
data class GetBindingResult(val createTime: String, val deleteTime: String, val fleet: Boolean, val name: String, val scope: String, val state: MembershipBindingLifecycleStateResponse, val uid: String, val updateTime: String)
Link copied to clipboard
data class GetFeatureIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetFeatureResult(val createTime: String, val deleteTime: String, val fleetDefaultMemberConfig: CommonFleetDefaultMemberConfigSpecResponse, val labels: Map<String, String>, val membershipSpecs: Map<String, String>, val membershipStates: Map<String, String>, val name: String, val resourceState: FeatureResourceStateResponse, val scopeSpecs: Map<String, String>, val scopeStates: Map<String, String>, val spec: CommonFeatureSpecResponse, val state: CommonFeatureStateResponse, val updateTime: String)
Link copied to clipboard
data class GetFleetResult(val createTime: String, val deleteTime: String, val displayName: String, val name: String, val state: FleetLifecycleStateResponse, val uid: String, val updateTime: String)
Link copied to clipboard
data class GetMembershipIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetMembershipResult(val authority: AuthorityResponse, val createTime: String, val deleteTime: String, val description: String, val endpoint: MembershipEndpointResponse, val externalId: String, val labels: Map<String, String>, val lastConnectionTime: String, val monitoringConfig: MonitoringConfigResponse, val name: String, val state: MembershipStateResponse, val uniqueId: String, val updateTime: String)
Link copied to clipboard
data class GetNamespaceResult(val createTime: String, val deleteTime: String, val name: String, val scope: String, val state: NamespaceLifecycleStateResponse, val uid: String, val updateTime: String)
Link copied to clipboard
data class GetRbacrolebindingResult(val createTime: String, val deleteTime: String, val group: String, val name: String, val role: RoleResponse, val state: RBACRoleBindingLifecycleStateResponse, val uid: String, val updateTime: String, val user: String)
Link copied to clipboard
data class GetScopeResult(val allMemberships: Boolean, val createTime: String, val deleteTime: String, val name: String, val state: ScopeLifecycleStateResponse, val uid: String, val updateTime: String)
Link copied to clipboard
data class GkeClusterResponse(val clusterMissing: Boolean, val resourceLink: String)

GkeCluster contains information specific to GKE clusters.

Link copied to clipboard

Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.

Link copied to clipboard
data class IdentityServiceAzureADConfigResponse(val clientId: String, val clientSecret: String, val encryptedClientSecret: String, val kubectlRedirectUri: String, val tenant: String)

Configuration for the AzureAD Auth flow.

Link copied to clipboard

Configuration for the Google Plugin Auth flow.

Link copied to clipboard

Anthos Identity Service: Configuration for a single Membership.

Link copied to clipboard
data class IdentityServiceOidcConfigResponse(val certificateAuthorityData: String, val clientId: String, val clientSecret: String, val deployCloudConsoleProxy: Boolean, val enableAccessToken: Boolean, val encryptedClientSecret: String, val extraParams: String, val groupPrefix: String, val groupsClaim: String, val issuerUri: String, val kubectlRedirectUri: String, val scopes: String, val userClaim: String, val userPrefix: String)

Configuration for OIDC Auth flow.

Link copied to clipboard
data class KubernetesMetadataResponse(val kubernetesApiServerVersion: String, val memoryMb: Int, val nodeCount: Int, val nodeProviderId: String, val updateTime: String, val vcpuCount: Int)

KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.

Link copied to clipboard
data class KubernetesResourceResponse(val connectResources: List<ResourceManifestResponse>, val membershipCrManifest: String, val membershipResources: List<ResourceManifestResponse>, val resourceOptions: ResourceOptionsResponse)

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.

Link copied to clipboard

MembershipBindingLifecycleState describes the state of a Binding resource.

Link copied to clipboard
data class MembershipEndpointResponse(val applianceCluster: ApplianceClusterResponse, val edgeCluster: EdgeClusterResponse, val gkeCluster: GkeClusterResponse, val googleManaged: Boolean, val kubernetesMetadata: KubernetesMetadataResponse, val kubernetesResource: KubernetesResourceResponse, val multiCloudCluster: MultiCloudClusterResponse, val onPremCluster: OnPremClusterResponse)

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

Link copied to clipboard
data class MembershipSpecResponse(val certificateManagement: String)

Workload Certificate: The membership-specific input for WorkloadCertificate feature.

Link copied to clipboard
data class MembershipStateResponse(val code: String)

MembershipState describes the state of a Membership resource.

Link copied to clipboard
data class MonitoringConfigResponse(val cluster: String, val clusterHash: String, val kubernetesMetricsPrefix: String, val location: String, val project: String)

This field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics.

Link copied to clipboard
data class MultiCloudClusterResponse(val clusterMissing: Boolean, val resourceLink: String)

MultiCloudCluster contains information specific to GKE Multi-Cloud clusters.

Link copied to clipboard
data class MultiClusterIngressFeatureSpecResponse(val billing: String, val configMembership: String)

Multi-cluster Ingress: The configuration for the MultiClusterIngress feature.

Link copied to clipboard

NamespaceLifecycleState describes the state of a Namespace resource.

Link copied to clipboard
data class OnPremClusterResponse(val adminCluster: Boolean, val clusterMissing: Boolean, val clusterType: String, val resourceLink: String)

OnPremCluster contains information specific to GKE On-Prem clusters.

Link copied to clipboard

RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource.

Link copied to clipboard
data class ResourceManifestResponse(val clusterScoped: Boolean, val manifest: String)

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

Link copied to clipboard
data class ResourceOptionsResponse(val connectVersion: String, val k8sVersion: String, val v1beta1Crd: Boolean)

ResourceOptions represent options for Kubernetes resource generation.

Link copied to clipboard
data class RoleResponse(val predefinedRole: String)

Role is the type for Kubernetes roles

Link copied to clipboard
data class ScopeLifecycleStateResponse(val code: String)

ScopeLifecycleState describes the state of a Scope resource.

Link copied to clipboard
data class ServiceMeshAnalysisMessageBaseResponse(val documentationUrl: String, val level: String, val type: ServiceMeshTypeResponse)

AnalysisMessageBase describes some common information that is needed for all messages.

Link copied to clipboard
data class ServiceMeshAnalysisMessageResponse(val args: Map<String, String>, val description: String, val messageBase: ServiceMeshAnalysisMessageBaseResponse, val resourcePaths: List<String>)

AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.

Link copied to clipboard

Service Mesh: State for the whole Hub, as analyzed by the Service Mesh Hub Controller.

Link copied to clipboard
data class ServiceMeshTypeResponse(val code: String, val displayName: String)

A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type

Link copied to clipboard
data class StatusResponse(val code: String, val description: String)

Status specifies state for the subcomponent.