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_v1.html">GKE Hub API</a> . <a href="gkehub_v1.projects.html">projects</a> . <a href="gkehub_v1.projects.locations.html">locations</a> . <a href="gkehub_v1.projects.locations.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="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Lists Features in a given project and location.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates an existing Feature.</p> 101<p class="toc_element"> 102 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p> 104<p class="toc_element"> 105 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="close">close()</code> 110 <pre>Close httplib2 connections.</pre> 111</div> 112 113<div class="method"> 114 <code class="details" id="create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</code> 115 <pre>Adds a new Feature. 116 117Args: 118 parent: string, The parent (project and location) where the Feature will be created. Specified in the format `projects/*/locations/*`. (required) 119 body: object, The request body. 120 The object takes the form of: 121 122{ # Feature represents the settings and status of any Hub Feature. 123 "createTime": "A String", # Output only. When the Feature resource was created. 124 "deleteTime": "A String", # Output only. When the Feature resource was deleted. 125 "labels": { # GCP labels for this Feature. 126 "a_key": "A String", 127 }, 128 "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. 129 "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. 130 "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. 131 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 132 "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. 133 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 134 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 135 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 136 "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. 137 "secretType": "A String", # Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. 138 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 139 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 140 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 141 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 142 }, 143 "preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. 144 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 145 }, 146 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 147 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 148 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 149 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 150 }, 151 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 152 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 153 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 154 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 155 "A String", 156 ], 157 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 158 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 159 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 160 }, 161 "version": "A String", # Version of ACM installed. 162 }, 163 }, 164 }, 165 "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. 166 "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. 167 "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. 168 "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. 169 "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. 170 "description": "A String", # Description is populated if Code is Failed, explaining why it has failed. 171 }, 172 }, 173 "configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. 174 "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. 175 "configSyncState": { # State information for ConfigSync # Current sync status 176 "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed 177 "admissionWebhook": "A String", # Deployment state of admission-webhook 178 "gitSync": "A String", # Deployment state of the git-sync pod 179 "importer": "A String", # Deployment state of the importer pod 180 "monitor": "A String", # Deployment state of the monitor pod 181 "reconcilerManager": "A String", # Deployment state of reconciler-manager pod 182 "rootReconciler": "A String", # Deployment state of root-reconciler 183 "syncer": "A String", # Deployment state of the syncer pod 184 }, 185 "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster 186 "code": "A String", # Sync status code 187 "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. 188 { # An ACM created error representing a problem syncing configurations 189 "code": "A String", # An ACM defined error code 190 "errorMessage": "A String", # A description of the error 191 "errorResources": [ # A list of config(s) associated with the error, if any 192 { # Model for a config file in the git repo with an associated Sync error 193 "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error 194 "group": "A String", # Kubernetes Group 195 "kind": "A String", # Kubernetes Kind 196 "version": "A String", # Kubernetes Version 197 }, 198 "resourceName": "A String", # Metadata name of the resource that is causing an error 199 "resourceNamespace": "A String", # Namespace of the resource that is causing an error 200 "sourcePath": "A String", # Path in the git repo of the erroneous config 201 }, 202 ], 203 }, 204 ], 205 "importToken": "A String", # Token indicating the state of the importer. 206 "lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String 207 "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo 208 "sourceToken": "A String", # Token indicating the state of the repo. 209 "syncToken": "A String", # Token indicating the state of the syncer. 210 }, 211 "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed 212 "admissionWebhook": "A String", # Version of the deployed admission_webhook pod 213 "gitSync": "A String", # Version of the deployed git-sync pod 214 "importer": "A String", # Version of the deployed importer pod 215 "monitor": "A String", # Version of the deployed monitor pod 216 "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod 217 "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod 218 "syncer": "A String", # Version of the deployed syncer pod 219 }, 220 }, 221 "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status 222 "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller 223 "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) 224 "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) 225 }, 226 "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller 227 "extension": "A String", # Version for Hierarchy Controller extension 228 "hnc": "A String", # Version for open source HNC 229 }, 230 }, 231 "membershipSpec": { # **Anthos Config Management**: 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 232 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 233 "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. 234 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 235 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 236 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 237 "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. 238 "secretType": "A String", # Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. 239 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 240 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 241 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 242 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 243 }, 244 "preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. 245 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 246 }, 247 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 248 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 249 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 250 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 251 }, 252 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 253 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 254 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 255 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 256 "A String", 257 ], 258 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 259 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 260 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 261 }, 262 "version": "A String", # Version of ACM installed. 263 }, 264 "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator 265 "deploymentState": "A String", # The state of the Operator's deployment 266 "errors": [ # Install errors. 267 { # Errors pertaining to the installation of ACM 268 "errorMessage": "A String", # A string representing the user facing error message 269 }, 270 ], 271 "version": "A String", # The semenatic version number of the operator 272 }, 273 "policyControllerState": { # State for PolicyControllerState. # PolicyController status 274 "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. 275 "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. 276 "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. 277 }, 278 "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. 279 "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. 280 }, 281 }, 282 }, 283 "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. 284 "code": "A String", # The high-level, machine-readable status of this Feature. 285 "description": "A String", # A human-readable description of the current status. 286 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 287 }, 288 }, 289 }, 290 "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. 291 "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. 292 "state": "A String", # The current state of the Feature resource in the Hub API. 293 }, 294 "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. 295 "appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec. 296 }, 297 "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. 298 "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` 299 }, 300 }, 301 "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. 302 "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. 303 "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. 304 "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. 305 "description": "A String", # Description is populated if Code is Failed, explaining why it has failed. 306 }, 307 }, 308 "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. 309 "code": "A String", # The high-level, machine-readable status of this Feature. 310 "description": "A String", # A human-readable description of the current status. 311 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 312 }, 313 }, 314 "updateTime": "A String", # Output only. When the Feature resource was last updated. 315} 316 317 featureId: string, The ID of the feature to create. 318 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). 319 x__xgafv: string, V1 error format. 320 Allowed values 321 1 - v1 error format 322 2 - v2 error format 323 324Returns: 325 An object of the form: 326 327 { # This resource represents a long-running operation that is the result of a network API call. 328 "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. 329 "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. 330 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 331 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 332 { 333 "a_key": "", # Properties of the object. Contains field @type with type URL. 334 }, 335 ], 336 "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. 337 }, 338 "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. 339 "a_key": "", # Properties of the object. Contains field @type with type URL. 340 }, 341 "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}`. 342 "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`. 343 "a_key": "", # Properties of the object. Contains field @type with type URL. 344 }, 345}</pre> 346</div> 347 348<div class="method"> 349 <code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code> 350 <pre>Removes a Feature. 351 352Args: 353 name: string, The Feature resource name in the format `projects/*/locations/*/features/*`. (required) 354 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. 355 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). 356 x__xgafv: string, V1 error format. 357 Allowed values 358 1 - v1 error format 359 2 - v2 error format 360 361Returns: 362 An object of the form: 363 364 { # This resource represents a long-running operation that is the result of a network API call. 365 "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. 366 "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. 367 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 368 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 369 { 370 "a_key": "", # Properties of the object. Contains field @type with type URL. 371 }, 372 ], 373 "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. 374 }, 375 "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. 376 "a_key": "", # Properties of the object. Contains field @type with type URL. 377 }, 378 "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}`. 379 "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`. 380 "a_key": "", # Properties of the object. Contains field @type with type URL. 381 }, 382}</pre> 383</div> 384 385<div class="method"> 386 <code class="details" id="get">get(name, x__xgafv=None)</code> 387 <pre>Gets details of a single Feature. 388 389Args: 390 name: string, The Feature resource name in the format `projects/*/locations/*/features/*` (required) 391 x__xgafv: string, V1 error format. 392 Allowed values 393 1 - v1 error format 394 2 - v2 error format 395 396Returns: 397 An object of the form: 398 399 { # Feature represents the settings and status of any Hub Feature. 400 "createTime": "A String", # Output only. When the Feature resource was created. 401 "deleteTime": "A String", # Output only. When the Feature resource was deleted. 402 "labels": { # GCP labels for this Feature. 403 "a_key": "A String", 404 }, 405 "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. 406 "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. 407 "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. 408 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 409 "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. 410 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 411 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 412 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 413 "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. 414 "secretType": "A String", # Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. 415 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 416 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 417 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 418 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 419 }, 420 "preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. 421 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 422 }, 423 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 424 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 425 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 426 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 427 }, 428 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 429 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 430 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 431 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 432 "A String", 433 ], 434 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 435 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 436 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 437 }, 438 "version": "A String", # Version of ACM installed. 439 }, 440 }, 441 }, 442 "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. 443 "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. 444 "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. 445 "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. 446 "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. 447 "description": "A String", # Description is populated if Code is Failed, explaining why it has failed. 448 }, 449 }, 450 "configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. 451 "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. 452 "configSyncState": { # State information for ConfigSync # Current sync status 453 "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed 454 "admissionWebhook": "A String", # Deployment state of admission-webhook 455 "gitSync": "A String", # Deployment state of the git-sync pod 456 "importer": "A String", # Deployment state of the importer pod 457 "monitor": "A String", # Deployment state of the monitor pod 458 "reconcilerManager": "A String", # Deployment state of reconciler-manager pod 459 "rootReconciler": "A String", # Deployment state of root-reconciler 460 "syncer": "A String", # Deployment state of the syncer pod 461 }, 462 "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster 463 "code": "A String", # Sync status code 464 "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. 465 { # An ACM created error representing a problem syncing configurations 466 "code": "A String", # An ACM defined error code 467 "errorMessage": "A String", # A description of the error 468 "errorResources": [ # A list of config(s) associated with the error, if any 469 { # Model for a config file in the git repo with an associated Sync error 470 "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error 471 "group": "A String", # Kubernetes Group 472 "kind": "A String", # Kubernetes Kind 473 "version": "A String", # Kubernetes Version 474 }, 475 "resourceName": "A String", # Metadata name of the resource that is causing an error 476 "resourceNamespace": "A String", # Namespace of the resource that is causing an error 477 "sourcePath": "A String", # Path in the git repo of the erroneous config 478 }, 479 ], 480 }, 481 ], 482 "importToken": "A String", # Token indicating the state of the importer. 483 "lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String 484 "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo 485 "sourceToken": "A String", # Token indicating the state of the repo. 486 "syncToken": "A String", # Token indicating the state of the syncer. 487 }, 488 "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed 489 "admissionWebhook": "A String", # Version of the deployed admission_webhook pod 490 "gitSync": "A String", # Version of the deployed git-sync pod 491 "importer": "A String", # Version of the deployed importer pod 492 "monitor": "A String", # Version of the deployed monitor pod 493 "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod 494 "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod 495 "syncer": "A String", # Version of the deployed syncer pod 496 }, 497 }, 498 "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status 499 "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller 500 "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) 501 "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) 502 }, 503 "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller 504 "extension": "A String", # Version for Hierarchy Controller extension 505 "hnc": "A String", # Version for open source HNC 506 }, 507 }, 508 "membershipSpec": { # **Anthos Config Management**: 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 509 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 510 "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. 511 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 512 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 513 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 514 "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. 515 "secretType": "A String", # Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. 516 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 517 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 518 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 519 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 520 }, 521 "preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. 522 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 523 }, 524 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 525 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 526 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 527 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 528 }, 529 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 530 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 531 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 532 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 533 "A String", 534 ], 535 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 536 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 537 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 538 }, 539 "version": "A String", # Version of ACM installed. 540 }, 541 "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator 542 "deploymentState": "A String", # The state of the Operator's deployment 543 "errors": [ # Install errors. 544 { # Errors pertaining to the installation of ACM 545 "errorMessage": "A String", # A string representing the user facing error message 546 }, 547 ], 548 "version": "A String", # The semenatic version number of the operator 549 }, 550 "policyControllerState": { # State for PolicyControllerState. # PolicyController status 551 "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. 552 "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. 553 "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. 554 }, 555 "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. 556 "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. 557 }, 558 }, 559 }, 560 "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. 561 "code": "A String", # The high-level, machine-readable status of this Feature. 562 "description": "A String", # A human-readable description of the current status. 563 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 564 }, 565 }, 566 }, 567 "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. 568 "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. 569 "state": "A String", # The current state of the Feature resource in the Hub API. 570 }, 571 "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. 572 "appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec. 573 }, 574 "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. 575 "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` 576 }, 577 }, 578 "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. 579 "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. 580 "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. 581 "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. 582 "description": "A String", # Description is populated if Code is Failed, explaining why it has failed. 583 }, 584 }, 585 "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. 586 "code": "A String", # The high-level, machine-readable status of this Feature. 587 "description": "A String", # A human-readable description of the current status. 588 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 589 }, 590 }, 591 "updateTime": "A String", # Output only. When the Feature resource was last updated. 592}</pre> 593</div> 594 595<div class="method"> 596 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> 597 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. 598 599Args: 600 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) 601 options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 602 x__xgafv: string, V1 error format. 603 Allowed values 604 1 - v1 error format 605 2 - v2 error format 606 607Returns: 608 An object of the form: 609 610 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 611 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 612 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 613 "auditLogConfigs": [ # The configuration for logging of each type of permission. 614 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 615 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 616 "A String", 617 ], 618 "logType": "A String", # The log type that this config enables. 619 }, 620 ], 621 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 622 }, 623 ], 624 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 625 { # Associates `members`, or principals, with a `role`. 626 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 627 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 628 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 629 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 630 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 631 }, 632 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 633 "A String", 634 ], 635 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 636 }, 637 ], 638 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 639 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 640}</pre> 641</div> 642 643<div class="method"> 644 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 645 <pre>Lists Features in a given project and location. 646 647Args: 648 parent: string, The parent (project and location) where the Features will be listed. Specified in the format `projects/*/locations/*`. (required) 649 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 650 orderBy: string, One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering. 651 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. 652 pageToken: string, Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources. 653 x__xgafv: string, V1 error format. 654 Allowed values 655 1 - v1 error format 656 2 - v2 error format 657 658Returns: 659 An object of the form: 660 661 { # Response message for the `GkeHub.ListFeatures` method. 662 "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. 663 "resources": [ # The list of matching Features 664 { # Feature represents the settings and status of any Hub Feature. 665 "createTime": "A String", # Output only. When the Feature resource was created. 666 "deleteTime": "A String", # Output only. When the Feature resource was deleted. 667 "labels": { # GCP labels for this Feature. 668 "a_key": "A String", 669 }, 670 "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. 671 "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. 672 "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. 673 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 674 "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. 675 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 676 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 677 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 678 "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. 679 "secretType": "A String", # Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. 680 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 681 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 682 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 683 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 684 }, 685 "preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. 686 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 687 }, 688 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 689 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 690 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 691 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 692 }, 693 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 694 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 695 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 696 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 697 "A String", 698 ], 699 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 700 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 701 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 702 }, 703 "version": "A String", # Version of ACM installed. 704 }, 705 }, 706 }, 707 "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. 708 "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. 709 "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. 710 "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. 711 "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. 712 "description": "A String", # Description is populated if Code is Failed, explaining why it has failed. 713 }, 714 }, 715 "configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. 716 "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. 717 "configSyncState": { # State information for ConfigSync # Current sync status 718 "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed 719 "admissionWebhook": "A String", # Deployment state of admission-webhook 720 "gitSync": "A String", # Deployment state of the git-sync pod 721 "importer": "A String", # Deployment state of the importer pod 722 "monitor": "A String", # Deployment state of the monitor pod 723 "reconcilerManager": "A String", # Deployment state of reconciler-manager pod 724 "rootReconciler": "A String", # Deployment state of root-reconciler 725 "syncer": "A String", # Deployment state of the syncer pod 726 }, 727 "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster 728 "code": "A String", # Sync status code 729 "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. 730 { # An ACM created error representing a problem syncing configurations 731 "code": "A String", # An ACM defined error code 732 "errorMessage": "A String", # A description of the error 733 "errorResources": [ # A list of config(s) associated with the error, if any 734 { # Model for a config file in the git repo with an associated Sync error 735 "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error 736 "group": "A String", # Kubernetes Group 737 "kind": "A String", # Kubernetes Kind 738 "version": "A String", # Kubernetes Version 739 }, 740 "resourceName": "A String", # Metadata name of the resource that is causing an error 741 "resourceNamespace": "A String", # Namespace of the resource that is causing an error 742 "sourcePath": "A String", # Path in the git repo of the erroneous config 743 }, 744 ], 745 }, 746 ], 747 "importToken": "A String", # Token indicating the state of the importer. 748 "lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String 749 "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo 750 "sourceToken": "A String", # Token indicating the state of the repo. 751 "syncToken": "A String", # Token indicating the state of the syncer. 752 }, 753 "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed 754 "admissionWebhook": "A String", # Version of the deployed admission_webhook pod 755 "gitSync": "A String", # Version of the deployed git-sync pod 756 "importer": "A String", # Version of the deployed importer pod 757 "monitor": "A String", # Version of the deployed monitor pod 758 "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod 759 "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod 760 "syncer": "A String", # Version of the deployed syncer pod 761 }, 762 }, 763 "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status 764 "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller 765 "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) 766 "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) 767 }, 768 "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller 769 "extension": "A String", # Version for Hierarchy Controller extension 770 "hnc": "A String", # Version for open source HNC 771 }, 772 }, 773 "membershipSpec": { # **Anthos Config Management**: 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 774 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 775 "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. 776 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 777 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 778 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 779 "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. 780 "secretType": "A String", # Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. 781 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 782 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 783 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 784 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 785 }, 786 "preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. 787 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 788 }, 789 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 790 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 791 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 792 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 793 }, 794 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 795 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 796 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 797 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 798 "A String", 799 ], 800 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 801 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 802 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 803 }, 804 "version": "A String", # Version of ACM installed. 805 }, 806 "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator 807 "deploymentState": "A String", # The state of the Operator's deployment 808 "errors": [ # Install errors. 809 { # Errors pertaining to the installation of ACM 810 "errorMessage": "A String", # A string representing the user facing error message 811 }, 812 ], 813 "version": "A String", # The semenatic version number of the operator 814 }, 815 "policyControllerState": { # State for PolicyControllerState. # PolicyController status 816 "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. 817 "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. 818 "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. 819 }, 820 "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. 821 "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. 822 }, 823 }, 824 }, 825 "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. 826 "code": "A String", # The high-level, machine-readable status of this Feature. 827 "description": "A String", # A human-readable description of the current status. 828 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 829 }, 830 }, 831 }, 832 "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. 833 "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. 834 "state": "A String", # The current state of the Feature resource in the Hub API. 835 }, 836 "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. 837 "appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec. 838 }, 839 "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. 840 "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` 841 }, 842 }, 843 "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. 844 "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. 845 "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. 846 "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. 847 "description": "A String", # Description is populated if Code is Failed, explaining why it has failed. 848 }, 849 }, 850 "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. 851 "code": "A String", # The high-level, machine-readable status of this Feature. 852 "description": "A String", # A human-readable description of the current status. 853 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 854 }, 855 }, 856 "updateTime": "A String", # Output only. When the Feature resource was last updated. 857 }, 858 ], 859}</pre> 860</div> 861 862<div class="method"> 863 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 864 <pre>Retrieves the next page of results. 865 866Args: 867 previous_request: The request for the previous page. (required) 868 previous_response: The response from the request for the previous page. (required) 869 870Returns: 871 A request object that you can call 'execute()' on to request the next 872 page. Returns None if there are no more items in the collection. 873 </pre> 874</div> 875 876<div class="method"> 877 <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code> 878 <pre>Updates an existing Feature. 879 880Args: 881 name: string, The Feature resource name in the format `projects/*/locations/*/features/*`. (required) 882 body: object, The request body. 883 The object takes the form of: 884 885{ # Feature represents the settings and status of any Hub Feature. 886 "createTime": "A String", # Output only. When the Feature resource was created. 887 "deleteTime": "A String", # Output only. When the Feature resource was deleted. 888 "labels": { # GCP labels for this Feature. 889 "a_key": "A String", 890 }, 891 "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. 892 "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. 893 "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. 894 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 895 "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. 896 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 897 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 898 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 899 "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. 900 "secretType": "A String", # Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. 901 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 902 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 903 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 904 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 905 }, 906 "preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. 907 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 908 }, 909 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 910 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 911 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 912 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 913 }, 914 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 915 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 916 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 917 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 918 "A String", 919 ], 920 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 921 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 922 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 923 }, 924 "version": "A String", # Version of ACM installed. 925 }, 926 }, 927 }, 928 "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. 929 "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. 930 "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. 931 "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. 932 "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. 933 "description": "A String", # Description is populated if Code is Failed, explaining why it has failed. 934 }, 935 }, 936 "configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. 937 "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. 938 "configSyncState": { # State information for ConfigSync # Current sync status 939 "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed 940 "admissionWebhook": "A String", # Deployment state of admission-webhook 941 "gitSync": "A String", # Deployment state of the git-sync pod 942 "importer": "A String", # Deployment state of the importer pod 943 "monitor": "A String", # Deployment state of the monitor pod 944 "reconcilerManager": "A String", # Deployment state of reconciler-manager pod 945 "rootReconciler": "A String", # Deployment state of root-reconciler 946 "syncer": "A String", # Deployment state of the syncer pod 947 }, 948 "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster 949 "code": "A String", # Sync status code 950 "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. 951 { # An ACM created error representing a problem syncing configurations 952 "code": "A String", # An ACM defined error code 953 "errorMessage": "A String", # A description of the error 954 "errorResources": [ # A list of config(s) associated with the error, if any 955 { # Model for a config file in the git repo with an associated Sync error 956 "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error 957 "group": "A String", # Kubernetes Group 958 "kind": "A String", # Kubernetes Kind 959 "version": "A String", # Kubernetes Version 960 }, 961 "resourceName": "A String", # Metadata name of the resource that is causing an error 962 "resourceNamespace": "A String", # Namespace of the resource that is causing an error 963 "sourcePath": "A String", # Path in the git repo of the erroneous config 964 }, 965 ], 966 }, 967 ], 968 "importToken": "A String", # Token indicating the state of the importer. 969 "lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String 970 "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo 971 "sourceToken": "A String", # Token indicating the state of the repo. 972 "syncToken": "A String", # Token indicating the state of the syncer. 973 }, 974 "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed 975 "admissionWebhook": "A String", # Version of the deployed admission_webhook pod 976 "gitSync": "A String", # Version of the deployed git-sync pod 977 "importer": "A String", # Version of the deployed importer pod 978 "monitor": "A String", # Version of the deployed monitor pod 979 "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod 980 "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod 981 "syncer": "A String", # Version of the deployed syncer pod 982 }, 983 }, 984 "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status 985 "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller 986 "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) 987 "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) 988 }, 989 "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller 990 "extension": "A String", # Version for Hierarchy Controller extension 991 "hnc": "A String", # Version for open source HNC 992 }, 993 }, 994 "membershipSpec": { # **Anthos Config Management**: 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 995 "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. 996 "enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of git field. 997 "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. 998 "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. 999 "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. 1000 "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. 1001 "secretType": "A String", # Type of secret configured for access to the Git repo. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required. 1002 "syncBranch": "A String", # The branch of the repository to sync from. Default: master. 1003 "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. 1004 "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. 1005 "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. 1006 }, 1007 "preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts. 1008 "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. 1009 }, 1010 "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. 1011 "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. 1012 "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. 1013 "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. 1014 }, 1015 "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. 1016 "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. 1017 "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. 1018 "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. 1019 "A String", 1020 ], 1021 "logDeniesEnabled": True or False, # Logs all denies and dry run failures. 1022 "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. 1023 "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. 1024 }, 1025 "version": "A String", # Version of ACM installed. 1026 }, 1027 "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator 1028 "deploymentState": "A String", # The state of the Operator's deployment 1029 "errors": [ # Install errors. 1030 { # Errors pertaining to the installation of ACM 1031 "errorMessage": "A String", # A string representing the user facing error message 1032 }, 1033 ], 1034 "version": "A String", # The semenatic version number of the operator 1035 }, 1036 "policyControllerState": { # State for PolicyControllerState. # PolicyController status 1037 "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. 1038 "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. 1039 "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. 1040 }, 1041 "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. 1042 "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. 1043 }, 1044 }, 1045 }, 1046 "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. 1047 "code": "A String", # The high-level, machine-readable status of this Feature. 1048 "description": "A String", # A human-readable description of the current status. 1049 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 1050 }, 1051 }, 1052 }, 1053 "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. 1054 "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. 1055 "state": "A String", # The current state of the Feature resource in the Hub API. 1056 }, 1057 "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. 1058 "appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec. 1059 }, 1060 "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. 1061 "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` 1062 }, 1063 }, 1064 "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. 1065 "appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state. 1066 "networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources. 1067 "code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state. 1068 "description": "A String", # Description is populated if Code is Failed, explaining why it has failed. 1069 }, 1070 }, 1071 "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. 1072 "code": "A String", # The high-level, machine-readable status of this Feature. 1073 "description": "A String", # A human-readable description of the current status. 1074 "updateTime": "A String", # The time this status and any related Feature-specific details were updated. 1075 }, 1076 }, 1077 "updateTime": "A String", # Output only. When the Feature resource was last updated. 1078} 1079 1080 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). 1081 updateMask: string, Mask of fields to update. 1082 x__xgafv: string, V1 error format. 1083 Allowed values 1084 1 - v1 error format 1085 2 - v2 error format 1086 1087Returns: 1088 An object of the form: 1089 1090 { # This resource represents a long-running operation that is the result of a network API call. 1091 "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. 1092 "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. 1093 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1094 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 1095 { 1096 "a_key": "", # Properties of the object. Contains field @type with type URL. 1097 }, 1098 ], 1099 "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. 1100 }, 1101 "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. 1102 "a_key": "", # Properties of the object. Contains field @type with type URL. 1103 }, 1104 "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}`. 1105 "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`. 1106 "a_key": "", # Properties of the object. Contains field @type with type URL. 1107 }, 1108}</pre> 1109</div> 1110 1111<div class="method"> 1112 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> 1113 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. 1114 1115Args: 1116 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) 1117 body: object, The request body. 1118 The object takes the form of: 1119 1120{ # Request message for `SetIamPolicy` method. 1121 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. 1122 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1123 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 1124 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1125 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 1126 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 1127 "A String", 1128 ], 1129 "logType": "A String", # The log type that this config enables. 1130 }, 1131 ], 1132 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 1133 }, 1134 ], 1135 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 1136 { # Associates `members`, or principals, with a `role`. 1137 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1138 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1139 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1140 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1141 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1142 }, 1143 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1144 "A String", 1145 ], 1146 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1147 }, 1148 ], 1149 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 1150 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1151 }, 1152 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` 1153} 1154 1155 x__xgafv: string, V1 error format. 1156 Allowed values 1157 1 - v1 error format 1158 2 - v2 error format 1159 1160Returns: 1161 An object of the form: 1162 1163 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 1164 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1165 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 1166 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1167 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 1168 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 1169 "A String", 1170 ], 1171 "logType": "A String", # The log type that this config enables. 1172 }, 1173 ], 1174 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. 1175 }, 1176 ], 1177 "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 1178 { # Associates `members`, or principals, with a `role`. 1179 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1180 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1181 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1182 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1183 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 1184 }, 1185 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1186 "A String", 1187 ], 1188 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1189 }, 1190 ], 1191 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. 1192 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1193}</pre> 1194</div> 1195 1196<div class="method"> 1197 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> 1198 <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. 1199 1200Args: 1201 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required) 1202 body: object, The request body. 1203 The object takes the form of: 1204 1205{ # Request message for `TestIamPermissions` method. 1206 "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). 1207 "A String", 1208 ], 1209} 1210 1211 x__xgafv: string, V1 error format. 1212 Allowed values 1213 1 - v1 error format 1214 2 - v2 error format 1215 1216Returns: 1217 An object of the form: 1218 1219 { # Response message for `TestIamPermissions` method. 1220 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1221 "A String", 1222 ], 1223}</pre> 1224</div> 1225 1226</body></html>