1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Adds a new Feature.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Removes a Feature.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets details of a single Feature.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists Features in a given project and location.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates an existing Feature.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</code> 106 <pre>Adds a new Feature. 107 108Args: 109 parent: string, The parent (project and location) where the Feature will be created. Specified in the format `projects/*/locations/global`. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # Feature represents the settings and status of any Hub Feature. 114 "createTime": "A String", # Output only. When the Feature resource was created. 115 "deleteTime": "A String", # Output only. When the Feature resource was deleted. 116 "labels": { # GCP labels for this Feature. 117 "a_key": "A String", 118 }, 119 "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. 120 "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. 121 "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. 122 "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. 123 "enabled": True or False, # Whether binauthz is enabled in this cluster. 124 }, 125 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 126 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 127 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 128 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 129 "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. 130 "secretType": "A String", # Type of secret configured for access to the Git repo. 131 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 132 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 133 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 134 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 135 }, 136 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 137 }, 138 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 139 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 140 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 141 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 142 }, 143 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 144 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 145 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 146 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 147 "A String", 148 ], 149 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 150 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 151 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 152 }, 153 "version": "A String", # Version of ACM installed. 154 }, 155 }, 156 }, 157 "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. 158 "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. 159 "configmanagement": { # State for Anthos Config Management # Config Management-specific state. 160 "binauthzState": { # State for Binauthz # Binauthz status 161 "version": { # The version of binauthz. # The version of binauthz that is installed. 162 "webhookVersion": "A String", # The version of the binauthz webhook. 163 }, 164 "webhook": "A String", # The state of the binauthz webhook. 165 }, 166 "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. 167 "configSyncState": { # State information for ConfigSync # Current sync status 168 "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed 169 "gitSync": "A String", # Deployment state of the git-sync pod 170 "importer": "A String", # Deployment state of the importer pod 171 "monitor": "A String", # Deployment state of the monitor pod 172 "reconcilerManager": "A String", # Deployment state of reconciler-manager pod 173 "rootReconciler": "A String", # Deployment state of root-reconciler 174 "syncer": "A String", # Deployment state of the syncer pod 175 }, 176 "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster 177 "code": "A String", # Sync status code 178 "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. 179 { # An ACM created error representing a problem syncing configurations 180 "code": "A String", # An ACM defined error code 181 "errorMessage": "A String", # A description of the error 182 "errorResources": [ # A list of config(s) associated with the error, if any 183 { # Model for a config file in the git repo with an associated Sync error 184 "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error 185 "group": "A String", # Kubernetes Group 186 "kind": "A String", # Kubernetes Kind 187 "version": "A String", # Kubernetes Version 188 }, 189 "resourceName": "A String", # Metadata name of the resource that is causing an error 190 "resourceNamespace": "A String", # Namespace of the resource that is causing an error 191 "sourcePath": "A String", # Path in the git repo of the erroneous config 192 }, 193 ], 194 }, 195 ], 196 "importToken": "A String", # Token indicating the state of the importer. 197 "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) 198 "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo 199 "sourceToken": "A String", # Token indicating the state of the repo. 200 "syncToken": "A String", # Token indicating the state of the syncer. 201 }, 202 "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed 203 "gitSync": "A String", # Version of the deployed git-sync pod 204 "importer": "A String", # Version of the deployed importer pod 205 "monitor": "A String", # Version of the deployed monitor pod 206 "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod 207 "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod 208 "syncer": "A String", # Version of the deployed syncer pod 209 }, 210 }, 211 "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status 212 "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller 213 "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) 214 "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) 215 }, 216 "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller 217 "extension": "A String", # Version for Hierarchy Controller extension 218 "hnc": "A String", # Version for open source HNC 219 }, 220 }, 221 "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 222 "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. 223 "enabled": True or False, # Whether binauthz is enabled in this cluster. 224 }, 225 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 226 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 227 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 228 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 229 "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. 230 "secretType": "A String", # Type of secret configured for access to the Git repo. 231 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 232 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 233 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 234 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 235 }, 236 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 237 }, 238 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 239 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 240 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 241 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 242 }, 243 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 244 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 245 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 246 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 247 "A String", 248 ], 249 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 250 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 251 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 252 }, 253 "version": "A String", # Version of ACM installed. 254 }, 255 "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator 256 "deploymentState": "A String", # The state of the Operator's deployment 257 "errors": [ # Install errors. 258 { # Errors pertaining to the installation of ACM 259 "errorMessage": "A String", # A string representing the user facing error message 260 }, 261 ], 262 "version": "A String", # The semenatic version number of the operator 263 }, 264 "policyControllerState": { # State for PolicyControllerState. # PolicyController status 265 "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. 266 "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. 267 "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. 268 }, 269 "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. 270 "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. 271 }, 272 }, 273 }, 274 "metering": { # Metering per-Membership Feature State. # Metering-specific spec. 275 "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. 276 "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). 277 }, 278 "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. 279 "code": "A String", # The high-level, machine-readable status of this Feature. 280 "description": "A String", # A human-readable description of the current status. 281 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 282 }, 283 }, 284 }, 285 "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`. 286 "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. 287 "state": "A String", # The current state of the Feature resource in the Hub API. 288 }, 289 "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. 290 "multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. 291 "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` 292 }, 293 }, 294 "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. 295 "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. 296 "code": "A String", # The high-level, machine-readable status of this Feature. 297 "description": "A String", # A human-readable description of the current status. 298 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 299 }, 300 }, 301 "updateTime": "A String", # Output only. When the Feature resource was last updated. 302} 303 304 featureId: string, The ID of the feature to create. 305 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). 306 x__xgafv: string, V1 error format. 307 Allowed values 308 1 - v1 error format 309 2 - v2 error format 310 311Returns: 312 An object of the form: 313 314 { # This resource represents a long-running operation that is the result of a network API call. 315 "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. 316 "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. 317 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 318 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 319 { 320 "a_key": "", # Properties of the object. Contains field @type with type URL. 321 }, 322 ], 323 "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. 324 }, 325 "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. 326 "a_key": "", # Properties of the object. Contains field @type with type URL. 327 }, 328 "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}`. 329 "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`. 330 "a_key": "", # Properties of the object. Contains field @type with type URL. 331 }, 332}</pre> 333</div> 334 335<div class="method"> 336 <code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code> 337 <pre>Removes a Feature. 338 339Args: 340 name: string, The Feature resource name in the format `projects/*/locations/global/features/*`. (required) 341 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. 342 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). 343 x__xgafv: string, V1 error format. 344 Allowed values 345 1 - v1 error format 346 2 - v2 error format 347 348Returns: 349 An object of the form: 350 351 { # This resource represents a long-running operation that is the result of a network API call. 352 "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. 353 "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. 354 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 355 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 356 { 357 "a_key": "", # Properties of the object. Contains field @type with type URL. 358 }, 359 ], 360 "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. 361 }, 362 "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. 363 "a_key": "", # Properties of the object. Contains field @type with type URL. 364 }, 365 "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}`. 366 "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`. 367 "a_key": "", # Properties of the object. Contains field @type with type URL. 368 }, 369}</pre> 370</div> 371 372<div class="method"> 373 <code class="details" id="get">get(name, x__xgafv=None)</code> 374 <pre>Gets details of a single Feature. 375 376Args: 377 name: string, The Feature resource name in the format `projects/*/locations/global/features/*` (required) 378 x__xgafv: string, V1 error format. 379 Allowed values 380 1 - v1 error format 381 2 - v2 error format 382 383Returns: 384 An object of the form: 385 386 { # Feature represents the settings and status of any Hub Feature. 387 "createTime": "A String", # Output only. When the Feature resource was created. 388 "deleteTime": "A String", # Output only. When the Feature resource was deleted. 389 "labels": { # GCP labels for this Feature. 390 "a_key": "A String", 391 }, 392 "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. 393 "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. 394 "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. 395 "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. 396 "enabled": True or False, # Whether binauthz is enabled in this cluster. 397 }, 398 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 399 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 400 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 401 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 402 "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. 403 "secretType": "A String", # Type of secret configured for access to the Git repo. 404 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 405 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 406 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 407 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 408 }, 409 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 410 }, 411 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 412 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 413 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 414 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 415 }, 416 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 417 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 418 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 419 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 420 "A String", 421 ], 422 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 423 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 424 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 425 }, 426 "version": "A String", # Version of ACM installed. 427 }, 428 }, 429 }, 430 "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. 431 "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. 432 "configmanagement": { # State for Anthos Config Management # Config Management-specific state. 433 "binauthzState": { # State for Binauthz # Binauthz status 434 "version": { # The version of binauthz. # The version of binauthz that is installed. 435 "webhookVersion": "A String", # The version of the binauthz webhook. 436 }, 437 "webhook": "A String", # The state of the binauthz webhook. 438 }, 439 "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. 440 "configSyncState": { # State information for ConfigSync # Current sync status 441 "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed 442 "gitSync": "A String", # Deployment state of the git-sync pod 443 "importer": "A String", # Deployment state of the importer pod 444 "monitor": "A String", # Deployment state of the monitor pod 445 "reconcilerManager": "A String", # Deployment state of reconciler-manager pod 446 "rootReconciler": "A String", # Deployment state of root-reconciler 447 "syncer": "A String", # Deployment state of the syncer pod 448 }, 449 "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster 450 "code": "A String", # Sync status code 451 "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. 452 { # An ACM created error representing a problem syncing configurations 453 "code": "A String", # An ACM defined error code 454 "errorMessage": "A String", # A description of the error 455 "errorResources": [ # A list of config(s) associated with the error, if any 456 { # Model for a config file in the git repo with an associated Sync error 457 "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error 458 "group": "A String", # Kubernetes Group 459 "kind": "A String", # Kubernetes Kind 460 "version": "A String", # Kubernetes Version 461 }, 462 "resourceName": "A String", # Metadata name of the resource that is causing an error 463 "resourceNamespace": "A String", # Namespace of the resource that is causing an error 464 "sourcePath": "A String", # Path in the git repo of the erroneous config 465 }, 466 ], 467 }, 468 ], 469 "importToken": "A String", # Token indicating the state of the importer. 470 "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) 471 "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo 472 "sourceToken": "A String", # Token indicating the state of the repo. 473 "syncToken": "A String", # Token indicating the state of the syncer. 474 }, 475 "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed 476 "gitSync": "A String", # Version of the deployed git-sync pod 477 "importer": "A String", # Version of the deployed importer pod 478 "monitor": "A String", # Version of the deployed monitor pod 479 "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod 480 "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod 481 "syncer": "A String", # Version of the deployed syncer pod 482 }, 483 }, 484 "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status 485 "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller 486 "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) 487 "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) 488 }, 489 "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller 490 "extension": "A String", # Version for Hierarchy Controller extension 491 "hnc": "A String", # Version for open source HNC 492 }, 493 }, 494 "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 495 "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. 496 "enabled": True or False, # Whether binauthz is enabled in this cluster. 497 }, 498 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 499 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 500 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 501 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 502 "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. 503 "secretType": "A String", # Type of secret configured for access to the Git repo. 504 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 505 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 506 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 507 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 508 }, 509 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 510 }, 511 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 512 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 513 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 514 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 515 }, 516 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 517 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 518 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 519 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 520 "A String", 521 ], 522 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 523 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 524 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 525 }, 526 "version": "A String", # Version of ACM installed. 527 }, 528 "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator 529 "deploymentState": "A String", # The state of the Operator's deployment 530 "errors": [ # Install errors. 531 { # Errors pertaining to the installation of ACM 532 "errorMessage": "A String", # A string representing the user facing error message 533 }, 534 ], 535 "version": "A String", # The semenatic version number of the operator 536 }, 537 "policyControllerState": { # State for PolicyControllerState. # PolicyController status 538 "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. 539 "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. 540 "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. 541 }, 542 "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. 543 "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. 544 }, 545 }, 546 }, 547 "metering": { # Metering per-Membership Feature State. # Metering-specific spec. 548 "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. 549 "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). 550 }, 551 "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. 552 "code": "A String", # The high-level, machine-readable status of this Feature. 553 "description": "A String", # A human-readable description of the current status. 554 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 555 }, 556 }, 557 }, 558 "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`. 559 "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. 560 "state": "A String", # The current state of the Feature resource in the Hub API. 561 }, 562 "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. 563 "multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. 564 "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` 565 }, 566 }, 567 "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. 568 "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. 569 "code": "A String", # The high-level, machine-readable status of this Feature. 570 "description": "A String", # A human-readable description of the current status. 571 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 572 }, 573 }, 574 "updateTime": "A String", # Output only. When the Feature resource was last updated. 575}</pre> 576</div> 577 578<div class="method"> 579 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 580 <pre>Lists Features in a given project and location. 581 582Args: 583 parent: string, The parent (project and location) where the Features will be listed. Specified in the format `projects/*/locations/global`. (required) 584 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 585 orderBy: string, One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering. 586 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. 587 pageToken: string, Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources. 588 x__xgafv: string, V1 error format. 589 Allowed values 590 1 - v1 error format 591 2 - v2 error format 592 593Returns: 594 An object of the form: 595 596 { # Response message for the `GkeHub.ListFeatures` method. 597 "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. 598 "resources": [ # The list of matching Features 599 { # Feature represents the settings and status of any Hub Feature. 600 "createTime": "A String", # Output only. When the Feature resource was created. 601 "deleteTime": "A String", # Output only. When the Feature resource was deleted. 602 "labels": { # GCP labels for this Feature. 603 "a_key": "A String", 604 }, 605 "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. 606 "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. 607 "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. 608 "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. 609 "enabled": True or False, # Whether binauthz is enabled in this cluster. 610 }, 611 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 612 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 613 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 614 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 615 "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. 616 "secretType": "A String", # Type of secret configured for access to the Git repo. 617 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 618 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 619 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 620 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 621 }, 622 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 623 }, 624 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 625 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 626 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 627 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 628 }, 629 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 630 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 631 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 632 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 633 "A String", 634 ], 635 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 636 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 637 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 638 }, 639 "version": "A String", # Version of ACM installed. 640 }, 641 }, 642 }, 643 "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. 644 "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. 645 "configmanagement": { # State for Anthos Config Management # Config Management-specific state. 646 "binauthzState": { # State for Binauthz # Binauthz status 647 "version": { # The version of binauthz. # The version of binauthz that is installed. 648 "webhookVersion": "A String", # The version of the binauthz webhook. 649 }, 650 "webhook": "A String", # The state of the binauthz webhook. 651 }, 652 "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. 653 "configSyncState": { # State information for ConfigSync # Current sync status 654 "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed 655 "gitSync": "A String", # Deployment state of the git-sync pod 656 "importer": "A String", # Deployment state of the importer pod 657 "monitor": "A String", # Deployment state of the monitor pod 658 "reconcilerManager": "A String", # Deployment state of reconciler-manager pod 659 "rootReconciler": "A String", # Deployment state of root-reconciler 660 "syncer": "A String", # Deployment state of the syncer pod 661 }, 662 "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster 663 "code": "A String", # Sync status code 664 "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. 665 { # An ACM created error representing a problem syncing configurations 666 "code": "A String", # An ACM defined error code 667 "errorMessage": "A String", # A description of the error 668 "errorResources": [ # A list of config(s) associated with the error, if any 669 { # Model for a config file in the git repo with an associated Sync error 670 "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error 671 "group": "A String", # Kubernetes Group 672 "kind": "A String", # Kubernetes Kind 673 "version": "A String", # Kubernetes Version 674 }, 675 "resourceName": "A String", # Metadata name of the resource that is causing an error 676 "resourceNamespace": "A String", # Namespace of the resource that is causing an error 677 "sourcePath": "A String", # Path in the git repo of the erroneous config 678 }, 679 ], 680 }, 681 ], 682 "importToken": "A String", # Token indicating the state of the importer. 683 "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) 684 "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo 685 "sourceToken": "A String", # Token indicating the state of the repo. 686 "syncToken": "A String", # Token indicating the state of the syncer. 687 }, 688 "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed 689 "gitSync": "A String", # Version of the deployed git-sync pod 690 "importer": "A String", # Version of the deployed importer pod 691 "monitor": "A String", # Version of the deployed monitor pod 692 "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod 693 "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod 694 "syncer": "A String", # Version of the deployed syncer pod 695 }, 696 }, 697 "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status 698 "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller 699 "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) 700 "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) 701 }, 702 "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller 703 "extension": "A String", # Version for Hierarchy Controller extension 704 "hnc": "A String", # Version for open source HNC 705 }, 706 }, 707 "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 708 "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. 709 "enabled": True or False, # Whether binauthz is enabled in this cluster. 710 }, 711 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 712 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 713 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 714 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 715 "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. 716 "secretType": "A String", # Type of secret configured for access to the Git repo. 717 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 718 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 719 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 720 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 721 }, 722 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 723 }, 724 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 725 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 726 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 727 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 728 }, 729 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 730 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 731 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 732 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 733 "A String", 734 ], 735 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 736 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 737 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 738 }, 739 "version": "A String", # Version of ACM installed. 740 }, 741 "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator 742 "deploymentState": "A String", # The state of the Operator's deployment 743 "errors": [ # Install errors. 744 { # Errors pertaining to the installation of ACM 745 "errorMessage": "A String", # A string representing the user facing error message 746 }, 747 ], 748 "version": "A String", # The semenatic version number of the operator 749 }, 750 "policyControllerState": { # State for PolicyControllerState. # PolicyController status 751 "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. 752 "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. 753 "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. 754 }, 755 "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. 756 "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. 757 }, 758 }, 759 }, 760 "metering": { # Metering per-Membership Feature State. # Metering-specific spec. 761 "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. 762 "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). 763 }, 764 "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. 765 "code": "A String", # The high-level, machine-readable status of this Feature. 766 "description": "A String", # A human-readable description of the current status. 767 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 768 }, 769 }, 770 }, 771 "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`. 772 "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. 773 "state": "A String", # The current state of the Feature resource in the Hub API. 774 }, 775 "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. 776 "multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. 777 "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` 778 }, 779 }, 780 "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. 781 "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. 782 "code": "A String", # The high-level, machine-readable status of this Feature. 783 "description": "A String", # A human-readable description of the current status. 784 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 785 }, 786 }, 787 "updateTime": "A String", # Output only. When the Feature resource was last updated. 788 }, 789 ], 790}</pre> 791</div> 792 793<div class="method"> 794 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 795 <pre>Retrieves the next page of results. 796 797Args: 798 previous_request: The request for the previous page. (required) 799 previous_response: The response from the request for the previous page. (required) 800 801Returns: 802 A request object that you can call 'execute()' on to request the next 803 page. Returns None if there are no more items in the collection. 804 </pre> 805</div> 806 807<div class="method"> 808 <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code> 809 <pre>Updates an existing Feature. 810 811Args: 812 name: string, The Feature resource name in the format `projects/*/locations/global/features/*`. (required) 813 body: object, The request body. 814 The object takes the form of: 815 816{ # Feature represents the settings and status of any Hub Feature. 817 "createTime": "A String", # Output only. When the Feature resource was created. 818 "deleteTime": "A String", # Output only. When the Feature resource was deleted. 819 "labels": { # GCP labels for this Feature. 820 "a_key": "A String", 821 }, 822 "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. 823 "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. 824 "configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. 825 "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. 826 "enabled": True or False, # Whether binauthz is enabled in this cluster. 827 }, 828 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 829 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 830 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 831 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 832 "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. 833 "secretType": "A String", # Type of secret configured for access to the Git repo. 834 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 835 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 836 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 837 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 838 }, 839 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 840 }, 841 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 842 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 843 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 844 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 845 }, 846 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 847 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 848 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 849 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 850 "A String", 851 ], 852 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 853 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 854 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 855 }, 856 "version": "A String", # Version of ACM installed. 857 }, 858 }, 859 }, 860 "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. 861 "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. 862 "configmanagement": { # State for Anthos Config Management # Config Management-specific state. 863 "binauthzState": { # State for Binauthz # Binauthz status 864 "version": { # The version of binauthz. # The version of binauthz that is installed. 865 "webhookVersion": "A String", # The version of the binauthz webhook. 866 }, 867 "webhook": "A String", # The state of the binauthz webhook. 868 }, 869 "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. 870 "configSyncState": { # State information for ConfigSync # Current sync status 871 "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed 872 "gitSync": "A String", # Deployment state of the git-sync pod 873 "importer": "A String", # Deployment state of the importer pod 874 "monitor": "A String", # Deployment state of the monitor pod 875 "reconcilerManager": "A String", # Deployment state of reconciler-manager pod 876 "rootReconciler": "A String", # Deployment state of root-reconciler 877 "syncer": "A String", # Deployment state of the syncer pod 878 }, 879 "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster 880 "code": "A String", # Sync status code 881 "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. 882 { # An ACM created error representing a problem syncing configurations 883 "code": "A String", # An ACM defined error code 884 "errorMessage": "A String", # A description of the error 885 "errorResources": [ # A list of config(s) associated with the error, if any 886 { # Model for a config file in the git repo with an associated Sync error 887 "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error 888 "group": "A String", # Kubernetes Group 889 "kind": "A String", # Kubernetes Kind 890 "version": "A String", # Kubernetes Version 891 }, 892 "resourceName": "A String", # Metadata name of the resource that is causing an error 893 "resourceNamespace": "A String", # Namespace of the resource that is causing an error 894 "sourcePath": "A String", # Path in the git repo of the erroneous config 895 }, 896 ], 897 }, 898 ], 899 "importToken": "A String", # Token indicating the state of the importer. 900 "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) 901 "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo 902 "sourceToken": "A String", # Token indicating the state of the repo. 903 "syncToken": "A String", # Token indicating the state of the syncer. 904 }, 905 "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed 906 "gitSync": "A String", # Version of the deployed git-sync pod 907 "importer": "A String", # Version of the deployed importer pod 908 "monitor": "A String", # Version of the deployed monitor pod 909 "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod 910 "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod 911 "syncer": "A String", # Version of the deployed syncer pod 912 }, 913 }, 914 "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status 915 "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller 916 "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) 917 "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) 918 }, 919 "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller 920 "extension": "A String", # Version for Hierarchy Controller extension 921 "hnc": "A String", # Version for open source HNC 922 }, 923 }, 924 "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 925 "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. 926 "enabled": True or False, # Whether binauthz is enabled in this cluster. 927 }, 928 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 929 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 930 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 931 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 932 "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. 933 "secretType": "A String", # Type of secret configured for access to the Git repo. 934 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 935 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 936 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 937 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 938 }, 939 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 940 }, 941 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 942 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 943 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 944 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 945 }, 946 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 947 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 948 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 949 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 950 "A String", 951 ], 952 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 953 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 954 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 955 }, 956 "version": "A String", # Version of ACM installed. 957 }, 958 "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator 959 "deploymentState": "A String", # The state of the Operator's deployment 960 "errors": [ # Install errors. 961 { # Errors pertaining to the installation of ACM 962 "errorMessage": "A String", # A string representing the user facing error message 963 }, 964 ], 965 "version": "A String", # The semenatic version number of the operator 966 }, 967 "policyControllerState": { # State for PolicyControllerState. # PolicyController status 968 "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. 969 "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. 970 "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. 971 }, 972 "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. 973 "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. 974 }, 975 }, 976 }, 977 "metering": { # Metering per-Membership Feature State. # Metering-specific spec. 978 "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. 979 "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). 980 }, 981 "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. 982 "code": "A String", # The high-level, machine-readable status of this Feature. 983 "description": "A String", # A human-readable description of the current status. 984 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 985 }, 986 }, 987 }, 988 "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`. 989 "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. 990 "state": "A String", # The current state of the Feature resource in the Hub API. 991 }, 992 "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. 993 "multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. 994 "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` 995 }, 996 }, 997 "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. 998 "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. 999 "code": "A String", # The high-level, machine-readable status of this Feature. 1000 "description": "A String", # A human-readable description of the current status. 1001 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 1002 }, 1003 }, 1004 "updateTime": "A String", # Output only. When the Feature resource was last updated. 1005} 1006 1007 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). 1008 updateMask: string, Mask of fields to update. 1009 x__xgafv: string, V1 error format. 1010 Allowed values 1011 1 - v1 error format 1012 2 - v2 error format 1013 1014Returns: 1015 An object of the form: 1016 1017 { # This resource represents a long-running operation that is the result of a network API call. 1018 "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. 1019 "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. 1020 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1021 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 1022 { 1023 "a_key": "", # Properties of the object. Contains field @type with type URL. 1024 }, 1025 ], 1026 "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. 1027 }, 1028 "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. 1029 "a_key": "", # Properties of the object. Contains field @type with type URL. 1030 }, 1031 "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}`. 1032 "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`. 1033 "a_key": "", # Properties of the object. Contains field @type with type URL. 1034 }, 1035}</pre> 1036</div> 1037 1038</body></html>