| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="gkehub_v1beta.html">GKE Hub</a> . <a href="gkehub_v1beta.projects.html">projects</a> . <a href="gkehub_v1beta.projects.locations.html">locations</a> . <a href="gkehub_v1beta.projects.locations.global_.html">global_</a> . <a href="gkehub_v1beta.projects.locations.global_.features.html">features</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Adds a new Feature.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Removes a Feature.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of a single Feature.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists Features in a given project and location.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing Feature.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</code> |
| <pre>Adds a new Feature. |
| |
| Args: |
| parent: string, The parent (project and location) where the Feature will be created. Specified in the format `projects/*/locations/global`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Feature represents the settings and status of any Hub Feature. |
| "createTime": "A String", # Output only. When the Feature resource was created. |
| "deleteTime": "A String", # Output only. When the Feature resource was deleted. |
| "labels": { # GCP labels for this Feature. |
| "a_key": "A String", |
| }, |
| "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. |
| "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. |
| "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. |
| "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| }, |
| "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| "policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. |
| "secretType": "A String", # Type of secret configured for access to the Git repo. |
| "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| }, |
| "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| }, |
| "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| }, |
| "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| "A String", |
| ], |
| "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| }, |
| "version": "A String", # Version of ACM installed. |
| }, |
| }, |
| }, |
| "membershipStates": { # 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. |
| "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. |
| "configmanagement": { # State for Anthos Config Management # Config Management-specific state. |
| "binauthzState": { # State for Binauthz # Binauthz status |
| "version": { # The version of binauthz. # The version of binauthz that is installed. |
| "webhookVersion": "A String", # The version of the binauthz webhook. |
| }, |
| "webhook": "A String", # The state of the binauthz webhook. |
| }, |
| "clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation. |
| "configSyncState": { # State information for ConfigSync # Current sync status |
| "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed |
| "gitSync": "A String", # Deployment state of the git-sync pod |
| "importer": "A String", # Deployment state of the importer pod |
| "monitor": "A String", # Deployment state of the monitor pod |
| "reconcilerManager": "A String", # Deployment state of reconciler-manager pod |
| "rootReconciler": "A String", # Deployment state of root-reconciler |
| "syncer": "A String", # Deployment state of the syncer pod |
| }, |
| "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster |
| "code": "A String", # Sync status code |
| "errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist. |
| { # An ACM created error representing a problem syncing configurations |
| "code": "A String", # An ACM defined error code |
| "errorMessage": "A String", # A description of the error |
| "errorResources": [ # A list of config(s) associated with the error, if any |
| { # Model for a config file in the git repo with an associated Sync error |
| "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error |
| "group": "A String", # Kubernetes Group |
| "kind": "A String", # Kubernetes Kind |
| "version": "A String", # Kubernetes Version |
| }, |
| "resourceName": "A String", # Metadata name of the resource that is causing an error |
| "resourceNamespace": "A String", # Namespace of the resource that is causing an error |
| "sourcePath": "A String", # Path in the git repo of the erroneous config |
| }, |
| ], |
| }, |
| ], |
| "importToken": "A String", # Token indicating the state of the importer. |
| "lastSync": "A String", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616) |
| "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo |
| "sourceToken": "A String", # Token indicating the state of the repo. |
| "syncToken": "A String", # Token indicating the state of the syncer. |
| }, |
| "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed |
| "gitSync": "A String", # Version of the deployed git-sync pod |
| "importer": "A String", # Version of the deployed importer pod |
| "monitor": "A String", # Version of the deployed monitor pod |
| "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod |
| "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod |
| "syncer": "A String", # Version of the deployed syncer pod |
| }, |
| }, |
| "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status |
| "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller |
| "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) |
| "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) |
| }, |
| "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller |
| "extension": "A String", # Version for Hierarchy Controller extension |
| "hnc": "A String", # Version for open source HNC |
| }, |
| }, |
| "membershipSpec": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state |
| "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| }, |
| "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| "policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. |
| "secretType": "A String", # Type of secret configured for access to the Git repo. |
| "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| }, |
| "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| }, |
| "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| }, |
| "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| "A String", |
| ], |
| "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| }, |
| "version": "A String", # Version of ACM installed. |
| }, |
| "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator |
| "deploymentState": "A String", # The state of the Operator's deployment |
| "errors": [ # Install errors. |
| { # Errors pertaining to the installation of ACM |
| "errorMessage": "A String", # A string representing the user facing error message |
| }, |
| ], |
| "version": "A String", # The semenatic version number of the operator |
| }, |
| "policyControllerState": { # State for PolicyControllerState. # PolicyController status |
| "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. |
| "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. |
| "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. |
| }, |
| "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. |
| "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. |
| }, |
| }, |
| }, |
| "metering": { # Metering per-Membership Feature State. # Metering-specific spec. |
| "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. |
| "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). |
| }, |
| "state": { # 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. # The high-level state of this Feature for a single membership. |
| "code": "A String", # The high-level, machine-readable status of this Feature. |
| "description": "A String", # A human-readable description of the current status. |
| "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| }, |
| }, |
| }, |
| "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`. |
| "resourceState": { # 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. # Output only. State of the Feature resource itself. |
| "state": "A String", # The current state of the Feature resource in the Hub API. |
| }, |
| "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. |
| "multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. |
| "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` |
| }, |
| }, |
| "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. |
| "state": { # 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. # Output only. The "running state" of the Feature in this Hub. |
| "code": "A String", # The high-level, machine-readable status of this Feature. |
| "description": "A String", # A human-readable description of the current status. |
| "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| }, |
| }, |
| "updateTime": "A String", # Output only. When the Feature resource was last updated. |
| } |
| |
| featureId: string, The ID of the feature to create. |
| requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code> |
| <pre>Removes a Feature. |
| |
| Args: |
| name: string, The Feature resource name in the format `projects/*/locations/global/features/*`. (required) |
| force: boolean, If set to true, the delete will ignore any outstanding resources for this Feature (that is, `FeatureState.has_resources` is set to true). These resources will NOT be cleaned up or modified in any way. |
| requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets details of a single Feature. |
| |
| Args: |
| name: string, The Feature resource name in the format `projects/*/locations/global/features/*` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Feature represents the settings and status of any Hub Feature. |
| "createTime": "A String", # Output only. When the Feature resource was created. |
| "deleteTime": "A String", # Output only. When the Feature resource was deleted. |
| "labels": { # GCP labels for this Feature. |
| "a_key": "A String", |
| }, |
| "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. |
| "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. |
| "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. |
| "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| }, |
| "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| "policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. |
| "secretType": "A String", # Type of secret configured for access to the Git repo. |
| "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| }, |
| "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| }, |
| "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| }, |
| "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| "A String", |
| ], |
| "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| }, |
| "version": "A String", # Version of ACM installed. |
| }, |
| }, |
| }, |
| "membershipStates": { # 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. |
| "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. |
| "configmanagement": { # State for Anthos Config Management # Config Management-specific state. |
| "binauthzState": { # State for Binauthz # Binauthz status |
| "version": { # The version of binauthz. # The version of binauthz that is installed. |
| "webhookVersion": "A String", # The version of the binauthz webhook. |
| }, |
| "webhook": "A String", # The state of the binauthz webhook. |
| }, |
| "clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation. |
| "configSyncState": { # State information for ConfigSync # Current sync status |
| "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed |
| "gitSync": "A String", # Deployment state of the git-sync pod |
| "importer": "A String", # Deployment state of the importer pod |
| "monitor": "A String", # Deployment state of the monitor pod |
| "reconcilerManager": "A String", # Deployment state of reconciler-manager pod |
| "rootReconciler": "A String", # Deployment state of root-reconciler |
| "syncer": "A String", # Deployment state of the syncer pod |
| }, |
| "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster |
| "code": "A String", # Sync status code |
| "errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist. |
| { # An ACM created error representing a problem syncing configurations |
| "code": "A String", # An ACM defined error code |
| "errorMessage": "A String", # A description of the error |
| "errorResources": [ # A list of config(s) associated with the error, if any |
| { # Model for a config file in the git repo with an associated Sync error |
| "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error |
| "group": "A String", # Kubernetes Group |
| "kind": "A String", # Kubernetes Kind |
| "version": "A String", # Kubernetes Version |
| }, |
| "resourceName": "A String", # Metadata name of the resource that is causing an error |
| "resourceNamespace": "A String", # Namespace of the resource that is causing an error |
| "sourcePath": "A String", # Path in the git repo of the erroneous config |
| }, |
| ], |
| }, |
| ], |
| "importToken": "A String", # Token indicating the state of the importer. |
| "lastSync": "A String", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616) |
| "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo |
| "sourceToken": "A String", # Token indicating the state of the repo. |
| "syncToken": "A String", # Token indicating the state of the syncer. |
| }, |
| "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed |
| "gitSync": "A String", # Version of the deployed git-sync pod |
| "importer": "A String", # Version of the deployed importer pod |
| "monitor": "A String", # Version of the deployed monitor pod |
| "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod |
| "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod |
| "syncer": "A String", # Version of the deployed syncer pod |
| }, |
| }, |
| "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status |
| "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller |
| "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) |
| "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) |
| }, |
| "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller |
| "extension": "A String", # Version for Hierarchy Controller extension |
| "hnc": "A String", # Version for open source HNC |
| }, |
| }, |
| "membershipSpec": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state |
| "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| }, |
| "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| "policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. |
| "secretType": "A String", # Type of secret configured for access to the Git repo. |
| "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| }, |
| "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| }, |
| "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| }, |
| "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| "A String", |
| ], |
| "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| }, |
| "version": "A String", # Version of ACM installed. |
| }, |
| "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator |
| "deploymentState": "A String", # The state of the Operator's deployment |
| "errors": [ # Install errors. |
| { # Errors pertaining to the installation of ACM |
| "errorMessage": "A String", # A string representing the user facing error message |
| }, |
| ], |
| "version": "A String", # The semenatic version number of the operator |
| }, |
| "policyControllerState": { # State for PolicyControllerState. # PolicyController status |
| "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. |
| "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. |
| "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. |
| }, |
| "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. |
| "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. |
| }, |
| }, |
| }, |
| "metering": { # Metering per-Membership Feature State. # Metering-specific spec. |
| "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. |
| "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). |
| }, |
| "state": { # 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. # The high-level state of this Feature for a single membership. |
| "code": "A String", # The high-level, machine-readable status of this Feature. |
| "description": "A String", # A human-readable description of the current status. |
| "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| }, |
| }, |
| }, |
| "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`. |
| "resourceState": { # 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. # Output only. State of the Feature resource itself. |
| "state": "A String", # The current state of the Feature resource in the Hub API. |
| }, |
| "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. |
| "multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. |
| "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` |
| }, |
| }, |
| "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. |
| "state": { # 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. # Output only. The "running state" of the Feature in this Hub. |
| "code": "A String", # The high-level, machine-readable status of this Feature. |
| "description": "A String", # A human-readable description of the current status. |
| "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| }, |
| }, |
| "updateTime": "A String", # Output only. When the Feature resource was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists Features in a given project and location. |
| |
| Args: |
| parent: string, The parent (project and location) where the Features will be listed. Specified in the format `projects/*/locations/global`. (required) |
| filter: string, Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name "servicemesh" in project "foo-proj": name = "projects/foo-proj/locations/global/features/servicemesh" - Features that have a label called `foo`: labels.foo:* - Features that have a label called `foo` whose value is `bar`: labels.foo = bar |
| orderBy: string, One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering. |
| pageSize: integer, When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned. |
| pageToken: string, Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for the `GkeHub.ListFeatures` method. |
| "nextPageToken": "A String", # A token to request the next page of resources from the `ListFeatures` method. The value of an empty string means that there are no more resources to return. |
| "resources": [ # The list of matching Features |
| { # Feature represents the settings and status of any Hub Feature. |
| "createTime": "A String", # Output only. When the Feature resource was created. |
| "deleteTime": "A String", # Output only. When the Feature resource was deleted. |
| "labels": { # GCP labels for this Feature. |
| "a_key": "A String", |
| }, |
| "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. |
| "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. |
| "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. |
| "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| }, |
| "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| "policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. |
| "secretType": "A String", # Type of secret configured for access to the Git repo. |
| "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| }, |
| "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| }, |
| "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| }, |
| "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| "A String", |
| ], |
| "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| }, |
| "version": "A String", # Version of ACM installed. |
| }, |
| }, |
| }, |
| "membershipStates": { # 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. |
| "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. |
| "configmanagement": { # State for Anthos Config Management # Config Management-specific state. |
| "binauthzState": { # State for Binauthz # Binauthz status |
| "version": { # The version of binauthz. # The version of binauthz that is installed. |
| "webhookVersion": "A String", # The version of the binauthz webhook. |
| }, |
| "webhook": "A String", # The state of the binauthz webhook. |
| }, |
| "clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation. |
| "configSyncState": { # State information for ConfigSync # Current sync status |
| "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed |
| "gitSync": "A String", # Deployment state of the git-sync pod |
| "importer": "A String", # Deployment state of the importer pod |
| "monitor": "A String", # Deployment state of the monitor pod |
| "reconcilerManager": "A String", # Deployment state of reconciler-manager pod |
| "rootReconciler": "A String", # Deployment state of root-reconciler |
| "syncer": "A String", # Deployment state of the syncer pod |
| }, |
| "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster |
| "code": "A String", # Sync status code |
| "errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist. |
| { # An ACM created error representing a problem syncing configurations |
| "code": "A String", # An ACM defined error code |
| "errorMessage": "A String", # A description of the error |
| "errorResources": [ # A list of config(s) associated with the error, if any |
| { # Model for a config file in the git repo with an associated Sync error |
| "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error |
| "group": "A String", # Kubernetes Group |
| "kind": "A String", # Kubernetes Kind |
| "version": "A String", # Kubernetes Version |
| }, |
| "resourceName": "A String", # Metadata name of the resource that is causing an error |
| "resourceNamespace": "A String", # Namespace of the resource that is causing an error |
| "sourcePath": "A String", # Path in the git repo of the erroneous config |
| }, |
| ], |
| }, |
| ], |
| "importToken": "A String", # Token indicating the state of the importer. |
| "lastSync": "A String", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616) |
| "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo |
| "sourceToken": "A String", # Token indicating the state of the repo. |
| "syncToken": "A String", # Token indicating the state of the syncer. |
| }, |
| "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed |
| "gitSync": "A String", # Version of the deployed git-sync pod |
| "importer": "A String", # Version of the deployed importer pod |
| "monitor": "A String", # Version of the deployed monitor pod |
| "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod |
| "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod |
| "syncer": "A String", # Version of the deployed syncer pod |
| }, |
| }, |
| "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status |
| "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller |
| "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) |
| "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) |
| }, |
| "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller |
| "extension": "A String", # Version for Hierarchy Controller extension |
| "hnc": "A String", # Version for open source HNC |
| }, |
| }, |
| "membershipSpec": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state |
| "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| }, |
| "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| "policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. |
| "secretType": "A String", # Type of secret configured for access to the Git repo. |
| "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| }, |
| "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| }, |
| "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| }, |
| "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| "A String", |
| ], |
| "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| }, |
| "version": "A String", # Version of ACM installed. |
| }, |
| "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator |
| "deploymentState": "A String", # The state of the Operator's deployment |
| "errors": [ # Install errors. |
| { # Errors pertaining to the installation of ACM |
| "errorMessage": "A String", # A string representing the user facing error message |
| }, |
| ], |
| "version": "A String", # The semenatic version number of the operator |
| }, |
| "policyControllerState": { # State for PolicyControllerState. # PolicyController status |
| "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. |
| "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. |
| "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. |
| }, |
| "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. |
| "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. |
| }, |
| }, |
| }, |
| "metering": { # Metering per-Membership Feature State. # Metering-specific spec. |
| "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. |
| "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). |
| }, |
| "state": { # 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. # The high-level state of this Feature for a single membership. |
| "code": "A String", # The high-level, machine-readable status of this Feature. |
| "description": "A String", # A human-readable description of the current status. |
| "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| }, |
| }, |
| }, |
| "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`. |
| "resourceState": { # 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. # Output only. State of the Feature resource itself. |
| "state": "A String", # The current state of the Feature resource in the Hub API. |
| }, |
| "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. |
| "multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. |
| "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` |
| }, |
| }, |
| "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. |
| "state": { # 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. # Output only. The "running state" of the Feature in this Hub. |
| "code": "A String", # The high-level, machine-readable status of this Feature. |
| "description": "A String", # A human-readable description of the current status. |
| "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| }, |
| }, |
| "updateTime": "A String", # Output only. When the Feature resource was last updated. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates an existing Feature. |
| |
| Args: |
| name: string, The Feature resource name in the format `projects/*/locations/global/features/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Feature represents the settings and status of any Hub Feature. |
| "createTime": "A String", # Output only. When the Feature resource was created. |
| "deleteTime": "A String", # Output only. When the Feature resource was deleted. |
| "labels": { # GCP labels for this Feature. |
| "a_key": "A String", |
| }, |
| "membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. |
| "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. |
| "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. |
| "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| }, |
| "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| "policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. |
| "secretType": "A String", # Type of secret configured for access to the Git repo. |
| "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| }, |
| "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| }, |
| "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| }, |
| "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| "A String", |
| ], |
| "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| }, |
| "version": "A String", # Version of ACM installed. |
| }, |
| }, |
| }, |
| "membershipStates": { # 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. |
| "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. |
| "configmanagement": { # State for Anthos Config Management # Config Management-specific state. |
| "binauthzState": { # State for Binauthz # Binauthz status |
| "version": { # The version of binauthz. # The version of binauthz that is installed. |
| "webhookVersion": "A String", # The version of the binauthz webhook. |
| }, |
| "webhook": "A String", # The state of the binauthz webhook. |
| }, |
| "clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation. |
| "configSyncState": { # State information for ConfigSync # Current sync status |
| "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed |
| "gitSync": "A String", # Deployment state of the git-sync pod |
| "importer": "A String", # Deployment state of the importer pod |
| "monitor": "A String", # Deployment state of the monitor pod |
| "reconcilerManager": "A String", # Deployment state of reconciler-manager pod |
| "rootReconciler": "A String", # Deployment state of root-reconciler |
| "syncer": "A String", # Deployment state of the syncer pod |
| }, |
| "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster |
| "code": "A String", # Sync status code |
| "errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist. |
| { # An ACM created error representing a problem syncing configurations |
| "code": "A String", # An ACM defined error code |
| "errorMessage": "A String", # A description of the error |
| "errorResources": [ # A list of config(s) associated with the error, if any |
| { # Model for a config file in the git repo with an associated Sync error |
| "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error |
| "group": "A String", # Kubernetes Group |
| "kind": "A String", # Kubernetes Kind |
| "version": "A String", # Kubernetes Version |
| }, |
| "resourceName": "A String", # Metadata name of the resource that is causing an error |
| "resourceNamespace": "A String", # Namespace of the resource that is causing an error |
| "sourcePath": "A String", # Path in the git repo of the erroneous config |
| }, |
| ], |
| }, |
| ], |
| "importToken": "A String", # Token indicating the state of the importer. |
| "lastSync": "A String", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616) |
| "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo |
| "sourceToken": "A String", # Token indicating the state of the repo. |
| "syncToken": "A String", # Token indicating the state of the syncer. |
| }, |
| "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed |
| "gitSync": "A String", # Version of the deployed git-sync pod |
| "importer": "A String", # Version of the deployed importer pod |
| "monitor": "A String", # Version of the deployed monitor pod |
| "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod |
| "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod |
| "syncer": "A String", # Version of the deployed syncer pod |
| }, |
| }, |
| "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status |
| "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller |
| "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) |
| "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) |
| }, |
| "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller |
| "extension": "A String", # Version for Hierarchy Controller extension |
| "hnc": "A String", # Version for open source HNC |
| }, |
| }, |
| "membershipSpec": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state |
| "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| }, |
| "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| "policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository. |
| "secretType": "A String", # Type of secret configured for access to the Git repo. |
| "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| }, |
| "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| }, |
| "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| }, |
| "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| "A String", |
| ], |
| "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| }, |
| "version": "A String", # Version of ACM installed. |
| }, |
| "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator |
| "deploymentState": "A String", # The state of the Operator's deployment |
| "errors": [ # Install errors. |
| { # Errors pertaining to the installation of ACM |
| "errorMessage": "A String", # A string representing the user facing error message |
| }, |
| ], |
| "version": "A String", # The semenatic version number of the operator |
| }, |
| "policyControllerState": { # State for PolicyControllerState. # PolicyController status |
| "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. |
| "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. |
| "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. |
| }, |
| "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. |
| "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. |
| }, |
| }, |
| }, |
| "metering": { # Metering per-Membership Feature State. # Metering-specific spec. |
| "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. |
| "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). |
| }, |
| "state": { # 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. # The high-level state of this Feature for a single membership. |
| "code": "A String", # The high-level, machine-readable status of this Feature. |
| "description": "A String", # A human-readable description of the current status. |
| "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| }, |
| }, |
| }, |
| "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`. |
| "resourceState": { # 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. # Output only. State of the Feature resource itself. |
| "state": "A String", # The current state of the Feature resource in the Hub API. |
| }, |
| "spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. |
| "multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. |
| "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` |
| }, |
| }, |
| "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. |
| "state": { # 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. # Output only. The "running state" of the Feature in this Hub. |
| "code": "A String", # The high-level, machine-readable status of this Feature. |
| "description": "A String", # A human-readable description of the current status. |
| "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| }, |
| }, |
| "updateTime": "A String", # Output only. When the Feature resource was last updated. |
| } |
| |
| requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| updateMask: string, Mask of fields to update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |