| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="gkehub_v1beta.html">GKE Hub</a> . <a href="gkehub_v1beta.projects.html">projects</a> . <a href="gkehub_v1beta.projects.locations.html">locations</a> . <a href="gkehub_v1beta.projects.locations.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"> |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 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"> |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 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"> |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 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"> |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 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"> |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 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 | |
| 117 | Args: |
| 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. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 130 | "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 131 | "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| 132 | "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| 133 | }, |
| 134 | "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| 135 | "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| 136 | "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| 137 | "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| 138 | "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. |
| 139 | "secretType": "A String", # Type of secret configured for access to the Git repo. |
| 140 | "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| 141 | "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| 142 | "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| 143 | "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| 144 | }, |
| 145 | "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| 146 | }, |
| 147 | "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| 148 | "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| 149 | "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| 150 | "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| 151 | }, |
| 152 | "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| 153 | "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| 154 | "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| 155 | "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| 156 | "A String", |
| 157 | ], |
| 158 | "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| 159 | "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| 160 | "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| 161 | }, |
| 162 | "version": "A String", # Version of ACM installed. |
| 163 | }, |
| 164 | }, |
| 165 | }, |
| 166 | "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. |
| 167 | "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 168 | "configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 169 | "binauthzState": { # State for Binauthz # Binauthz status |
| 170 | "version": { # The version of binauthz. # The version of binauthz that is installed. |
| 171 | "webhookVersion": "A String", # The version of the binauthz webhook. |
| 172 | }, |
| 173 | "webhook": "A String", # The state of the binauthz webhook. |
| 174 | }, |
| 175 | "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. |
| 176 | "configSyncState": { # State information for ConfigSync # Current sync status |
| 177 | "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed |
| 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", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616) |
| 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 | "gitSync": "A String", # Version of the deployed git-sync pod |
| 213 | "importer": "A String", # Version of the deployed importer pod |
| 214 | "monitor": "A String", # Version of the deployed monitor pod |
| 215 | "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod |
| 216 | "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod |
| 217 | "syncer": "A String", # Version of the deployed syncer pod |
| 218 | }, |
| 219 | }, |
| 220 | "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status |
| 221 | "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller |
| 222 | "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) |
| 223 | "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) |
| 224 | }, |
| 225 | "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller |
| 226 | "extension": "A String", # Version for Hierarchy Controller extension |
| 227 | "hnc": "A String", # Version for open source HNC |
| 228 | }, |
| 229 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 230 | "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 |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 231 | "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| 232 | "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| 233 | }, |
| 234 | "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| 235 | "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| 236 | "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| 237 | "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| 238 | "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. |
| 239 | "secretType": "A String", # Type of secret configured for access to the Git repo. |
| 240 | "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| 241 | "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| 242 | "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| 243 | "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| 244 | }, |
| 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 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 283 | "metering": { # **Metering**: Per-Membership Feature State. # Metering-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 284 | "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. |
| 285 | "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). |
| 286 | }, |
| 287 | "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. |
| 288 | "code": "A String", # The high-level, machine-readable status of this Feature. |
| 289 | "description": "A String", # A human-readable description of the current status. |
| 290 | "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| 291 | }, |
| 292 | }, |
| 293 | }, |
| 294 | "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. |
| 295 | "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. |
| 296 | "state": "A String", # The current state of the Feature resource in the Hub API. |
| 297 | }, |
| 298 | "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. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 299 | "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 300 | "billing": "A String", # Customer's billing structure |
| 301 | "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` |
| 302 | }, |
| 303 | }, |
| 304 | "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. |
| 305 | "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. |
| 306 | "code": "A String", # The high-level, machine-readable status of this Feature. |
| 307 | "description": "A String", # A human-readable description of the current status. |
| 308 | "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| 309 | }, |
| 310 | }, |
| 311 | "updateTime": "A String", # Output only. When the Feature resource was last updated. |
| 312 | } |
| 313 | |
| 314 | featureId: string, The ID of the feature to create. |
| 315 | 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). |
| 316 | x__xgafv: string, V1 error format. |
| 317 | Allowed values |
| 318 | 1 - v1 error format |
| 319 | 2 - v2 error format |
| 320 | |
| 321 | Returns: |
| 322 | An object of the form: |
| 323 | |
| 324 | { # This resource represents a long-running operation that is the result of a network API call. |
| 325 | "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. |
| 326 | "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. |
| 327 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 328 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 329 | { |
| 330 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 331 | }, |
| 332 | ], |
| 333 | "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. |
| 334 | }, |
| 335 | "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. |
| 336 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 337 | }, |
| 338 | "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}`. |
| 339 | "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`. |
| 340 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 341 | }, |
| 342 | }</pre> |
| 343 | </div> |
| 344 | |
| 345 | <div class="method"> |
| 346 | <code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code> |
| 347 | <pre>Removes a Feature. |
| 348 | |
| 349 | Args: |
| 350 | name: string, The Feature resource name in the format `projects/*/locations/*/features/*`. (required) |
| 351 | 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. |
| 352 | 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). |
| 353 | x__xgafv: string, V1 error format. |
| 354 | Allowed values |
| 355 | 1 - v1 error format |
| 356 | 2 - v2 error format |
| 357 | |
| 358 | Returns: |
| 359 | An object of the form: |
| 360 | |
| 361 | { # This resource represents a long-running operation that is the result of a network API call. |
| 362 | "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. |
| 363 | "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. |
| 364 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 365 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 366 | { |
| 367 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 368 | }, |
| 369 | ], |
| 370 | "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. |
| 371 | }, |
| 372 | "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. |
| 373 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 374 | }, |
| 375 | "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}`. |
| 376 | "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`. |
| 377 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 378 | }, |
| 379 | }</pre> |
| 380 | </div> |
| 381 | |
| 382 | <div class="method"> |
| 383 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 384 | <pre>Gets details of a single Feature. |
| 385 | |
| 386 | Args: |
| 387 | name: string, The Feature resource name in the format `projects/*/locations/*/features/*` (required) |
| 388 | x__xgafv: string, V1 error format. |
| 389 | Allowed values |
| 390 | 1 - v1 error format |
| 391 | 2 - v2 error format |
| 392 | |
| 393 | Returns: |
| 394 | An object of the form: |
| 395 | |
| 396 | { # Feature represents the settings and status of any Hub Feature. |
| 397 | "createTime": "A String", # Output only. When the Feature resource was created. |
| 398 | "deleteTime": "A String", # Output only. When the Feature resource was deleted. |
| 399 | "labels": { # GCP labels for this Feature. |
| 400 | "a_key": "A String", |
| 401 | }, |
| 402 | "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. |
| 403 | "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 404 | "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 405 | "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| 406 | "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| 407 | }, |
| 408 | "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| 409 | "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| 410 | "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| 411 | "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| 412 | "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. |
| 413 | "secretType": "A String", # Type of secret configured for access to the Git repo. |
| 414 | "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| 415 | "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| 416 | "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| 417 | "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| 418 | }, |
| 419 | "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| 420 | }, |
| 421 | "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| 422 | "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| 423 | "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| 424 | "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| 425 | }, |
| 426 | "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| 427 | "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| 428 | "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| 429 | "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| 430 | "A String", |
| 431 | ], |
| 432 | "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| 433 | "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| 434 | "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| 435 | }, |
| 436 | "version": "A String", # Version of ACM installed. |
| 437 | }, |
| 438 | }, |
| 439 | }, |
| 440 | "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. |
| 441 | "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 442 | "configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 443 | "binauthzState": { # State for Binauthz # Binauthz status |
| 444 | "version": { # The version of binauthz. # The version of binauthz that is installed. |
| 445 | "webhookVersion": "A String", # The version of the binauthz webhook. |
| 446 | }, |
| 447 | "webhook": "A String", # The state of the binauthz webhook. |
| 448 | }, |
| 449 | "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. |
| 450 | "configSyncState": { # State information for ConfigSync # Current sync status |
| 451 | "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed |
| 452 | "gitSync": "A String", # Deployment state of the git-sync pod |
| 453 | "importer": "A String", # Deployment state of the importer pod |
| 454 | "monitor": "A String", # Deployment state of the monitor pod |
| 455 | "reconcilerManager": "A String", # Deployment state of reconciler-manager pod |
| 456 | "rootReconciler": "A String", # Deployment state of root-reconciler |
| 457 | "syncer": "A String", # Deployment state of the syncer pod |
| 458 | }, |
| 459 | "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster |
| 460 | "code": "A String", # Sync status code |
| 461 | "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. |
| 462 | { # An ACM created error representing a problem syncing configurations |
| 463 | "code": "A String", # An ACM defined error code |
| 464 | "errorMessage": "A String", # A description of the error |
| 465 | "errorResources": [ # A list of config(s) associated with the error, if any |
| 466 | { # Model for a config file in the git repo with an associated Sync error |
| 467 | "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error |
| 468 | "group": "A String", # Kubernetes Group |
| 469 | "kind": "A String", # Kubernetes Kind |
| 470 | "version": "A String", # Kubernetes Version |
| 471 | }, |
| 472 | "resourceName": "A String", # Metadata name of the resource that is causing an error |
| 473 | "resourceNamespace": "A String", # Namespace of the resource that is causing an error |
| 474 | "sourcePath": "A String", # Path in the git repo of the erroneous config |
| 475 | }, |
| 476 | ], |
| 477 | }, |
| 478 | ], |
| 479 | "importToken": "A String", # Token indicating the state of the importer. |
| 480 | "lastSync": "A String", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616) |
| 481 | "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo |
| 482 | "sourceToken": "A String", # Token indicating the state of the repo. |
| 483 | "syncToken": "A String", # Token indicating the state of the syncer. |
| 484 | }, |
| 485 | "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed |
| 486 | "gitSync": "A String", # Version of the deployed git-sync pod |
| 487 | "importer": "A String", # Version of the deployed importer pod |
| 488 | "monitor": "A String", # Version of the deployed monitor pod |
| 489 | "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod |
| 490 | "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod |
| 491 | "syncer": "A String", # Version of the deployed syncer pod |
| 492 | }, |
| 493 | }, |
| 494 | "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status |
| 495 | "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller |
| 496 | "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) |
| 497 | "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) |
| 498 | }, |
| 499 | "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller |
| 500 | "extension": "A String", # Version for Hierarchy Controller extension |
| 501 | "hnc": "A String", # Version for open source HNC |
| 502 | }, |
| 503 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 504 | "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 |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 505 | "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| 506 | "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| 507 | }, |
| 508 | "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| 509 | "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| 510 | "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| 511 | "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| 512 | "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. |
| 513 | "secretType": "A String", # Type of secret configured for access to the Git repo. |
| 514 | "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| 515 | "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| 516 | "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| 517 | "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| 518 | }, |
| 519 | "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| 520 | }, |
| 521 | "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| 522 | "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| 523 | "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| 524 | "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| 525 | }, |
| 526 | "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| 527 | "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| 528 | "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| 529 | "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| 530 | "A String", |
| 531 | ], |
| 532 | "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| 533 | "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| 534 | "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| 535 | }, |
| 536 | "version": "A String", # Version of ACM installed. |
| 537 | }, |
| 538 | "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator |
| 539 | "deploymentState": "A String", # The state of the Operator's deployment |
| 540 | "errors": [ # Install errors. |
| 541 | { # Errors pertaining to the installation of ACM |
| 542 | "errorMessage": "A String", # A string representing the user facing error message |
| 543 | }, |
| 544 | ], |
| 545 | "version": "A String", # The semenatic version number of the operator |
| 546 | }, |
| 547 | "policyControllerState": { # State for PolicyControllerState. # PolicyController status |
| 548 | "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. |
| 549 | "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. |
| 550 | "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. |
| 551 | }, |
| 552 | "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. |
| 553 | "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. |
| 554 | }, |
| 555 | }, |
| 556 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 557 | "metering": { # **Metering**: Per-Membership Feature State. # Metering-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 558 | "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. |
| 559 | "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). |
| 560 | }, |
| 561 | "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. |
| 562 | "code": "A String", # The high-level, machine-readable status of this Feature. |
| 563 | "description": "A String", # A human-readable description of the current status. |
| 564 | "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| 565 | }, |
| 566 | }, |
| 567 | }, |
| 568 | "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. |
| 569 | "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. |
| 570 | "state": "A String", # The current state of the Feature resource in the Hub API. |
| 571 | }, |
| 572 | "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. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 573 | "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 574 | "billing": "A String", # Customer's billing structure |
| 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 | "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. |
| 580 | "code": "A String", # The high-level, machine-readable status of this Feature. |
| 581 | "description": "A String", # A human-readable description of the current status. |
| 582 | "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| 583 | }, |
| 584 | }, |
| 585 | "updateTime": "A String", # Output only. When the Feature resource was last updated. |
| 586 | }</pre> |
| 587 | </div> |
| 588 | |
| 589 | <div class="method"> |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 590 | <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> |
| 591 | <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
| 592 | |
| 593 | Args: |
| 594 | resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) |
| 595 | options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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). |
| 596 | x__xgafv: string, V1 error format. |
| 597 | Allowed values |
| 598 | 1 - v1 error format |
| 599 | 2 - v2 error format |
| 600 | |
| 601 | Returns: |
| 602 | An object of the form: |
| 603 | |
| 604 | { # 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` to a single `role`. Members 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| 605 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 606 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| 607 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 608 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 609 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| 610 | "A String", |
| 611 | ], |
| 612 | "logType": "A String", # The log type that this config enables. |
| 613 | }, |
| 614 | ], |
| 615 | "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. |
| 616 | }, |
| 617 | ], |
| 618 | "bindings": [ # Associates a list of `members` to 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 member. |
| 619 | { # Associates `members` with a `role`. |
| 620 | "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 members 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). |
| 621 | "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. |
| 622 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 623 | "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. |
| 624 | "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. |
| 625 | }, |
| 626 | "members": [ # Specifies the identities 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?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, `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`. |
| 627 | "A String", |
| 628 | ], |
| 629 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 630 | }, |
| 631 | ], |
| 632 | "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. |
| 633 | "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). |
| 634 | }</pre> |
| 635 | </div> |
| 636 | |
| 637 | <div class="method"> |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 638 | <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 639 | <pre>Lists Features in a given project and location. |
| 640 | |
| 641 | Args: |
| 642 | parent: string, The parent (project and location) where the Features will be listed. Specified in the format `projects/*/locations/*`. (required) |
| 643 | 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 |
| 644 | orderBy: string, One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering. |
| 645 | 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. |
| 646 | pageToken: string, Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources. |
| 647 | x__xgafv: string, V1 error format. |
| 648 | Allowed values |
| 649 | 1 - v1 error format |
| 650 | 2 - v2 error format |
| 651 | |
| 652 | Returns: |
| 653 | An object of the form: |
| 654 | |
| 655 | { # Response message for the `GkeHub.ListFeatures` method. |
| 656 | "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. |
| 657 | "resources": [ # The list of matching Features |
| 658 | { # Feature represents the settings and status of any Hub Feature. |
| 659 | "createTime": "A String", # Output only. When the Feature resource was created. |
| 660 | "deleteTime": "A String", # Output only. When the Feature resource was deleted. |
| 661 | "labels": { # GCP labels for this Feature. |
| 662 | "a_key": "A String", |
| 663 | }, |
| 664 | "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. |
| 665 | "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 666 | "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 667 | "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| 668 | "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| 669 | }, |
| 670 | "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| 671 | "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| 672 | "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| 673 | "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| 674 | "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. |
| 675 | "secretType": "A String", # Type of secret configured for access to the Git repo. |
| 676 | "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| 677 | "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| 678 | "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| 679 | "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| 680 | }, |
| 681 | "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| 682 | }, |
| 683 | "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| 684 | "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| 685 | "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| 686 | "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| 687 | }, |
| 688 | "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| 689 | "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| 690 | "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| 691 | "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| 692 | "A String", |
| 693 | ], |
| 694 | "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| 695 | "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| 696 | "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| 697 | }, |
| 698 | "version": "A String", # Version of ACM installed. |
| 699 | }, |
| 700 | }, |
| 701 | }, |
| 702 | "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. |
| 703 | "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 704 | "configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 705 | "binauthzState": { # State for Binauthz # Binauthz status |
| 706 | "version": { # The version of binauthz. # The version of binauthz that is installed. |
| 707 | "webhookVersion": "A String", # The version of the binauthz webhook. |
| 708 | }, |
| 709 | "webhook": "A String", # The state of the binauthz webhook. |
| 710 | }, |
| 711 | "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. |
| 712 | "configSyncState": { # State information for ConfigSync # Current sync status |
| 713 | "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed |
| 714 | "gitSync": "A String", # Deployment state of the git-sync pod |
| 715 | "importer": "A String", # Deployment state of the importer pod |
| 716 | "monitor": "A String", # Deployment state of the monitor pod |
| 717 | "reconcilerManager": "A String", # Deployment state of reconciler-manager pod |
| 718 | "rootReconciler": "A String", # Deployment state of root-reconciler |
| 719 | "syncer": "A String", # Deployment state of the syncer pod |
| 720 | }, |
| 721 | "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster |
| 722 | "code": "A String", # Sync status code |
| 723 | "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. |
| 724 | { # An ACM created error representing a problem syncing configurations |
| 725 | "code": "A String", # An ACM defined error code |
| 726 | "errorMessage": "A String", # A description of the error |
| 727 | "errorResources": [ # A list of config(s) associated with the error, if any |
| 728 | { # Model for a config file in the git repo with an associated Sync error |
| 729 | "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error |
| 730 | "group": "A String", # Kubernetes Group |
| 731 | "kind": "A String", # Kubernetes Kind |
| 732 | "version": "A String", # Kubernetes Version |
| 733 | }, |
| 734 | "resourceName": "A String", # Metadata name of the resource that is causing an error |
| 735 | "resourceNamespace": "A String", # Namespace of the resource that is causing an error |
| 736 | "sourcePath": "A String", # Path in the git repo of the erroneous config |
| 737 | }, |
| 738 | ], |
| 739 | }, |
| 740 | ], |
| 741 | "importToken": "A String", # Token indicating the state of the importer. |
| 742 | "lastSync": "A String", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616) |
| 743 | "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo |
| 744 | "sourceToken": "A String", # Token indicating the state of the repo. |
| 745 | "syncToken": "A String", # Token indicating the state of the syncer. |
| 746 | }, |
| 747 | "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed |
| 748 | "gitSync": "A String", # Version of the deployed git-sync pod |
| 749 | "importer": "A String", # Version of the deployed importer pod |
| 750 | "monitor": "A String", # Version of the deployed monitor pod |
| 751 | "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod |
| 752 | "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod |
| 753 | "syncer": "A String", # Version of the deployed syncer pod |
| 754 | }, |
| 755 | }, |
| 756 | "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status |
| 757 | "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller |
| 758 | "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) |
| 759 | "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) |
| 760 | }, |
| 761 | "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller |
| 762 | "extension": "A String", # Version for Hierarchy Controller extension |
| 763 | "hnc": "A String", # Version for open source HNC |
| 764 | }, |
| 765 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 766 | "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 |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 767 | "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| 768 | "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| 769 | }, |
| 770 | "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| 771 | "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| 772 | "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| 773 | "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| 774 | "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. |
| 775 | "secretType": "A String", # Type of secret configured for access to the Git repo. |
| 776 | "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| 777 | "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| 778 | "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| 779 | "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| 780 | }, |
| 781 | "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| 782 | }, |
| 783 | "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| 784 | "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| 785 | "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| 786 | "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| 787 | }, |
| 788 | "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| 789 | "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| 790 | "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| 791 | "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| 792 | "A String", |
| 793 | ], |
| 794 | "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| 795 | "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| 796 | "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| 797 | }, |
| 798 | "version": "A String", # Version of ACM installed. |
| 799 | }, |
| 800 | "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator |
| 801 | "deploymentState": "A String", # The state of the Operator's deployment |
| 802 | "errors": [ # Install errors. |
| 803 | { # Errors pertaining to the installation of ACM |
| 804 | "errorMessage": "A String", # A string representing the user facing error message |
| 805 | }, |
| 806 | ], |
| 807 | "version": "A String", # The semenatic version number of the operator |
| 808 | }, |
| 809 | "policyControllerState": { # State for PolicyControllerState. # PolicyController status |
| 810 | "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. |
| 811 | "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. |
| 812 | "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. |
| 813 | }, |
| 814 | "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. |
| 815 | "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. |
| 816 | }, |
| 817 | }, |
| 818 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 819 | "metering": { # **Metering**: Per-Membership Feature State. # Metering-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 820 | "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. |
| 821 | "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). |
| 822 | }, |
| 823 | "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. |
| 824 | "code": "A String", # The high-level, machine-readable status of this Feature. |
| 825 | "description": "A String", # A human-readable description of the current status. |
| 826 | "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| 827 | }, |
| 828 | }, |
| 829 | }, |
| 830 | "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. |
| 831 | "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. |
| 832 | "state": "A String", # The current state of the Feature resource in the Hub API. |
| 833 | }, |
| 834 | "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. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 835 | "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 836 | "billing": "A String", # Customer's billing structure |
| 837 | "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` |
| 838 | }, |
| 839 | }, |
| 840 | "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. |
| 841 | "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. |
| 842 | "code": "A String", # The high-level, machine-readable status of this Feature. |
| 843 | "description": "A String", # A human-readable description of the current status. |
| 844 | "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| 845 | }, |
| 846 | }, |
| 847 | "updateTime": "A String", # Output only. When the Feature resource was last updated. |
| 848 | }, |
| 849 | ], |
| 850 | }</pre> |
| 851 | </div> |
| 852 | |
| 853 | <div class="method"> |
| 854 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 855 | <pre>Retrieves the next page of results. |
| 856 | |
| 857 | Args: |
| 858 | previous_request: The request for the previous page. (required) |
| 859 | previous_response: The response from the request for the previous page. (required) |
| 860 | |
| 861 | Returns: |
| 862 | A request object that you can call 'execute()' on to request the next |
| 863 | page. Returns None if there are no more items in the collection. |
| 864 | </pre> |
| 865 | </div> |
| 866 | |
| 867 | <div class="method"> |
| 868 | <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code> |
| 869 | <pre>Updates an existing Feature. |
| 870 | |
| 871 | Args: |
| 872 | name: string, The Feature resource name in the format `projects/*/locations/*/features/*`. (required) |
| 873 | body: object, The request body. |
| 874 | The object takes the form of: |
| 875 | |
| 876 | { # Feature represents the settings and status of any Hub Feature. |
| 877 | "createTime": "A String", # Output only. When the Feature resource was created. |
| 878 | "deleteTime": "A String", # Output only. When the Feature resource was deleted. |
| 879 | "labels": { # GCP labels for this Feature. |
| 880 | "a_key": "A String", |
| 881 | }, |
| 882 | "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. |
| 883 | "a_key": { # MembershipFeatureSpec contains configuration information for a single Membership. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 884 | "configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 885 | "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| 886 | "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| 887 | }, |
| 888 | "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| 889 | "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| 890 | "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| 891 | "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| 892 | "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. |
| 893 | "secretType": "A String", # Type of secret configured for access to the Git repo. |
| 894 | "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| 895 | "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| 896 | "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| 897 | "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| 898 | }, |
| 899 | "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| 900 | }, |
| 901 | "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| 902 | "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| 903 | "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| 904 | "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| 905 | }, |
| 906 | "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| 907 | "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| 908 | "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| 909 | "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| 910 | "A String", |
| 911 | ], |
| 912 | "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| 913 | "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| 914 | "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| 915 | }, |
| 916 | "version": "A String", # Version of ACM installed. |
| 917 | }, |
| 918 | }, |
| 919 | }, |
| 920 | "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. |
| 921 | "a_key": { # MembershipFeatureState contains Feature status information for a single Membership. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 922 | "configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 923 | "binauthzState": { # State for Binauthz # Binauthz status |
| 924 | "version": { # The version of binauthz. # The version of binauthz that is installed. |
| 925 | "webhookVersion": "A String", # The version of the binauthz webhook. |
| 926 | }, |
| 927 | "webhook": "A String", # The state of the binauthz webhook. |
| 928 | }, |
| 929 | "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. |
| 930 | "configSyncState": { # State information for ConfigSync # Current sync status |
| 931 | "deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed |
| 932 | "gitSync": "A String", # Deployment state of the git-sync pod |
| 933 | "importer": "A String", # Deployment state of the importer pod |
| 934 | "monitor": "A String", # Deployment state of the monitor pod |
| 935 | "reconcilerManager": "A String", # Deployment state of reconciler-manager pod |
| 936 | "rootReconciler": "A String", # Deployment state of root-reconciler |
| 937 | "syncer": "A String", # Deployment state of the syncer pod |
| 938 | }, |
| 939 | "syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster |
| 940 | "code": "A String", # Sync status code |
| 941 | "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. |
| 942 | { # An ACM created error representing a problem syncing configurations |
| 943 | "code": "A String", # An ACM defined error code |
| 944 | "errorMessage": "A String", # A description of the error |
| 945 | "errorResources": [ # A list of config(s) associated with the error, if any |
| 946 | { # Model for a config file in the git repo with an associated Sync error |
| 947 | "resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error |
| 948 | "group": "A String", # Kubernetes Group |
| 949 | "kind": "A String", # Kubernetes Kind |
| 950 | "version": "A String", # Kubernetes Version |
| 951 | }, |
| 952 | "resourceName": "A String", # Metadata name of the resource that is causing an error |
| 953 | "resourceNamespace": "A String", # Namespace of the resource that is causing an error |
| 954 | "sourcePath": "A String", # Path in the git repo of the erroneous config |
| 955 | }, |
| 956 | ], |
| 957 | }, |
| 958 | ], |
| 959 | "importToken": "A String", # Token indicating the state of the importer. |
| 960 | "lastSync": "A String", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616) |
| 961 | "lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo |
| 962 | "sourceToken": "A String", # Token indicating the state of the repo. |
| 963 | "syncToken": "A String", # Token indicating the state of the syncer. |
| 964 | }, |
| 965 | "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed |
| 966 | "gitSync": "A String", # Version of the deployed git-sync pod |
| 967 | "importer": "A String", # Version of the deployed importer pod |
| 968 | "monitor": "A String", # Version of the deployed monitor pod |
| 969 | "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod |
| 970 | "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod |
| 971 | "syncer": "A String", # Version of the deployed syncer pod |
| 972 | }, |
| 973 | }, |
| 974 | "hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status |
| 975 | "state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller |
| 976 | "extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1) |
| 977 | "hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0) |
| 978 | }, |
| 979 | "version": { # Version for Hierarchy Controller # The version for Hierarchy Controller |
| 980 | "extension": "A String", # Version for Hierarchy Controller extension |
| 981 | "hnc": "A String", # Version for open source HNC |
| 982 | }, |
| 983 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 984 | "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 |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 985 | "binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster. |
| 986 | "enabled": True or False, # Whether binauthz is enabled in this cluster. |
| 987 | }, |
| 988 | "configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster. |
| 989 | "git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster. |
| 990 | "gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount. |
| 991 | "httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo. |
| 992 | "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. |
| 993 | "secretType": "A String", # Type of secret configured for access to the Git repo. |
| 994 | "syncBranch": "A String", # The branch of the repository to sync from. Default: master. |
| 995 | "syncRepo": "A String", # The URL of the Git repository to use as the source of truth. |
| 996 | "syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD. |
| 997 | "syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15. |
| 998 | }, |
| 999 | "sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode. |
| 1000 | }, |
| 1001 | "hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster. |
| 1002 | "enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster. |
| 1003 | "enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster. |
| 1004 | "enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster. |
| 1005 | }, |
| 1006 | "policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. |
| 1007 | "auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether. |
| 1008 | "enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect. |
| 1009 | "exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster. |
| 1010 | "A String", |
| 1011 | ], |
| 1012 | "logDeniesEnabled": True or False, # Logs all denies and dry run failures. |
| 1013 | "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. |
| 1014 | "templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller. |
| 1015 | }, |
| 1016 | "version": "A String", # Version of ACM installed. |
| 1017 | }, |
| 1018 | "operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator |
| 1019 | "deploymentState": "A String", # The state of the Operator's deployment |
| 1020 | "errors": [ # Install errors. |
| 1021 | { # Errors pertaining to the installation of ACM |
| 1022 | "errorMessage": "A String", # A string representing the user facing error message |
| 1023 | }, |
| 1024 | ], |
| 1025 | "version": "A String", # The semenatic version number of the operator |
| 1026 | }, |
| 1027 | "policyControllerState": { # State for PolicyControllerState. # PolicyController status |
| 1028 | "deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation. |
| 1029 | "gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment. |
| 1030 | "gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod. |
| 1031 | }, |
| 1032 | "version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed. |
| 1033 | "version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number. |
| 1034 | }, |
| 1035 | }, |
| 1036 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 1037 | "metering": { # **Metering**: Per-Membership Feature State. # Metering-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 1038 | "lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster. |
| 1039 | "preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision). |
| 1040 | }, |
| 1041 | "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. |
| 1042 | "code": "A String", # The high-level, machine-readable status of this Feature. |
| 1043 | "description": "A String", # A human-readable description of the current status. |
| 1044 | "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| 1045 | }, |
| 1046 | }, |
| 1047 | }, |
| 1048 | "name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. |
| 1049 | "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. |
| 1050 | "state": "A String", # The current state of the Feature resource in the Hub API. |
| 1051 | }, |
| 1052 | "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. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 1053 | "multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec. |
| yoshi-code-bot | 44a6719 | 2021-05-02 03:48:02 -0700 | [diff] [blame] | 1054 | "billing": "A String", # Customer's billing structure |
| 1055 | "configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar` |
| 1056 | }, |
| 1057 | }, |
| 1058 | "state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state. |
| 1059 | "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. |
| 1060 | "code": "A String", # The high-level, machine-readable status of this Feature. |
| 1061 | "description": "A String", # A human-readable description of the current status. |
| 1062 | "updateTime": "A String", # The time this status and any related Feature-specific details were updated. |
| 1063 | }, |
| 1064 | }, |
| 1065 | "updateTime": "A String", # Output only. When the Feature resource was last updated. |
| 1066 | } |
| 1067 | |
| 1068 | 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). |
| 1069 | updateMask: string, Mask of fields to update. |
| 1070 | x__xgafv: string, V1 error format. |
| 1071 | Allowed values |
| 1072 | 1 - v1 error format |
| 1073 | 2 - v2 error format |
| 1074 | |
| 1075 | Returns: |
| 1076 | An object of the form: |
| 1077 | |
| 1078 | { # This resource represents a long-running operation that is the result of a network API call. |
| 1079 | "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. |
| 1080 | "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. |
| 1081 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1082 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1083 | { |
| 1084 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1085 | }, |
| 1086 | ], |
| 1087 | "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. |
| 1088 | }, |
| 1089 | "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. |
| 1090 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1091 | }, |
| 1092 | "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}`. |
| 1093 | "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`. |
| 1094 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1095 | }, |
| 1096 | }</pre> |
| 1097 | </div> |
| 1098 | |
| 1099 | <div class="method"> |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1100 | <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| 1101 | <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| 1102 | |
| 1103 | Args: |
| 1104 | resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) |
| 1105 | body: object, The request body. |
| 1106 | The object takes the form of: |
| 1107 | |
| 1108 | { # Request message for `SetIamPolicy` method. |
| 1109 | "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` to a single `role`. Members 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](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. |
| 1110 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 1111 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| 1112 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 1113 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 1114 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| 1115 | "A String", |
| 1116 | ], |
| 1117 | "logType": "A String", # The log type that this config enables. |
| 1118 | }, |
| 1119 | ], |
| 1120 | "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. |
| 1121 | }, |
| 1122 | ], |
| 1123 | "bindings": [ # Associates a list of `members` to 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 member. |
| 1124 | { # Associates `members` with a `role`. |
| 1125 | "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 members 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). |
| 1126 | "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. |
| 1127 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1128 | "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. |
| 1129 | "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. |
| 1130 | }, |
| 1131 | "members": [ # Specifies the identities 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?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, `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`. |
| 1132 | "A String", |
| 1133 | ], |
| 1134 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 1135 | }, |
| 1136 | ], |
| 1137 | "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. |
| 1138 | "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). |
| 1139 | }, |
| 1140 | "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"` |
| 1141 | } |
| 1142 | |
| 1143 | x__xgafv: string, V1 error format. |
| 1144 | Allowed values |
| 1145 | 1 - v1 error format |
| 1146 | 2 - v2 error format |
| 1147 | |
| 1148 | Returns: |
| 1149 | An object of the form: |
| 1150 | |
| 1151 | { # 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` to a single `role`. Members 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| 1152 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| 1153 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| 1154 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| 1155 | { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 1156 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. |
| 1157 | "A String", |
| 1158 | ], |
| 1159 | "logType": "A String", # The log type that this config enables. |
| 1160 | }, |
| 1161 | ], |
| 1162 | "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. |
| 1163 | }, |
| 1164 | ], |
| 1165 | "bindings": [ # Associates a list of `members` to 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 member. |
| 1166 | { # Associates `members` with a `role`. |
| 1167 | "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 members 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). |
| 1168 | "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. |
| 1169 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1170 | "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. |
| 1171 | "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. |
| 1172 | }, |
| 1173 | "members": [ # Specifies the identities 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, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?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, `my-other-app@appspot.gserviceaccount.com?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, `admins@example.com?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`. |
| 1174 | "A String", |
| 1175 | ], |
| 1176 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 1177 | }, |
| 1178 | ], |
| 1179 | "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. |
| 1180 | "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). |
| 1181 | }</pre> |
| 1182 | </div> |
| 1183 | |
| 1184 | <div class="method"> |
| 1185 | <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| 1186 | <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. |
| 1187 | |
| 1188 | Args: |
| 1189 | 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) |
| 1190 | body: object, The request body. |
| 1191 | The object takes the form of: |
| 1192 | |
| 1193 | { # Request message for `TestIamPermissions` method. |
| 1194 | "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). |
| 1195 | "A String", |
| 1196 | ], |
| 1197 | } |
| 1198 | |
| 1199 | x__xgafv: string, V1 error format. |
| 1200 | Allowed values |
| 1201 | 1 - v1 error format |
| 1202 | 2 - v2 error format |
| 1203 | |
| 1204 | Returns: |
| 1205 | An object of the form: |
| 1206 | |
| 1207 | { # Response message for `TestIamPermissions` method. |
| 1208 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| 1209 | "A String", |
| 1210 | ], |
| 1211 | }</pre> |
| 1212 | </div> |
| 1213 | |
| 1214 | </body></html> |