Module google_gkehub1::api

source ·

Structs

  • Spec for App Dev Experience Feature.
  • State for App Dev Exp Feature.
  • ApplianceCluster contains information specific to GDC Edge Appliance Clusters.
  • 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.
  • 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.
  • 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
  • Associates members, or principals, with a role.
  • The request message for Operations.CancelOperation.
  • CommonFeatureSpec contains Hub-wide configuration information
  • CommonFeatureState contains Hub-wide Feature status information.
  • Configuration for Config Sync
  • The state of ConfigSync’s deployment on a cluster
  • State information for ConfigSync
  • Specific versioning information pertaining to ConfigSync’s Pods
  • Model for a config file in the git repo with an associated Sync error
  • State of Policy Controller installation.
  • Git repo configuration for a single cluster.
  • A Kubernetes object’s GVK
  • Configuration for Hierarchy Controller
  • Deployment state for Hierarchy Controller
  • State for Hierarchy Controller
  • Version for Hierarchy Controller
  • Errors pertaining to the installation of ACM
  • Anthos Config Management: Configuration for a single cluster. Intended to parallel the ConfigManagement CR.
  • Anthos Config Management: State for a single cluster.
  • OCI repo configuration for a single cluster
  • State information for an ACM’s Operator
  • Configuration for Policy Controller
  • PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: [“cloudmonitoring”, “prometheus”]
  • State for PolicyControllerState.
  • The build version of Gatekeeper Policy Controller is using.
  • An ACM created error representing a problem syncing configurations
  • State indicating an ACM’s progress syncing configurations to a cluster
  • ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.
  • EdgeCluster contains information specific to Google Edge Clusters.
  • A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
  • 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.
  • Feature represents the settings and status of any Hub Feature.
  • 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.
  • 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.
  • Fleet Observability: The Hub-wide input for the FleetObservability feature.
  • FleetObservability: An empty state left as an example Hub-wide Feature state.
  • FleetObservability: The membership-specific input for FleetObservability feature.
  • FleetObservability: An empty state left as an example membership-specific Feature state.
  • Central instance to access all GKEHub related resource activities
  • GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.
  • GkeCluster contains information specific to GKE clusters.
  • The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
  • Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
  • Configuration for the AzureAD Auth flow.
  • Configuration for the Google Plugin Auth flow.
  • Anthos Identity Service: Configuration for a single Membership.
  • Anthos Identity Service: State for a single Membership.
  • Configuration for OIDC Auth flow.
  • KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.
  • 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.
  • Response message for the GkeHub.ListFeatures method.
  • The response message for Locations.ListLocations.
  • Response message for the GkeHub.ListMemberships method.
  • The response message for Operations.ListOperations.
  • A resource that represents Google Cloud Platform location.
  • Membership contains information about a member cluster.
  • MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.
  • MembershipFeatureSpec contains configuration information for a single Membership.
  • MembershipFeatureState contains Feature status information for a single Membership.
  • MembershipState describes the state of a Membership resource.
  • MultiCloudCluster contains information specific to GKE Multi-Cloud clusters.
  • Multi-cluster Ingress: The configuration for the MultiClusterIngress feature.
  • OnPremCluster contains information specific to GKE On-Prem clusters.
  • This resource represents a long-running operation that is the result of a network API call.
  • An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { “bindings”: [ { “role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ] }, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [ “user:eve@example.com” ], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } } ], “etag”: “BwWWja0YfJA=”, “version”: 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’) etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.
  • Adds a new Feature.
  • Removes a Feature.
  • Gets details of a single Feature.
  • Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • Lists Features in a given project and location.
  • Updates an existing Feature.
  • Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
  • Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
  • Gets information about a location.
  • Lists information about the supported locations for this service.
  • Creates a new Membership. This is currently only supported for GKE clusters on Google Cloud. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.
  • Removes a Membership. This is currently only supported for GKE clusters on Google Cloud. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.
  • Generates the manifest for deployment of the GKE connect agent. This method is used internally by Google-provided libraries. Most clients should not need to call this method directly.
  • Gets the details of a Membership.
  • Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
  • Lists Memberships in a given project and location.
  • Updates an existing Membership.
  • Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
  • Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
  • Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
  • Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
  • Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
  • Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
  • A builder providing access to all methods supported on project resources. It is not used directly, but through the GKEHub hub.
  • ResourceManifest represents a single Kubernetes resource to be applied to the cluster.
  • ResourceOptions represent options for Kubernetes resource generation.
  • ScopeFeatureSpec contains feature specs for a fleet scope.
  • ScopeFeatureState contains Scope-wide Feature status information.
  • Status of control plane management.
  • Status of data plane management. Only reported per-member.
  • Service Mesh: Spec for a single Membership for the servicemesh feature
  • Service Mesh: State for a single Membership, as analyzed by the Service Mesh Hub Controller.
  • Structured and human-readable details for a status.
  • Request message for SetIamPolicy method.
  • Status specifies state for the subcomponent.
  • Request message for TestIamPermissions method.
  • Response message for TestIamPermissions method.
  • TypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest.

Enums