blob: 89b39055e3fe7b71d2f9c84f0e2b207c6a3d1a90 [file] [log] [blame]
yoshi-code-bot227f8c92021-05-26 00:34:03 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
yoshi-code-bot96afc042021-08-24 00:22:31 -070075<h1><a href="gkehub_v1.html">GKE Hub API</a> . <a href="gkehub_v1.projects.html">projects</a> . <a href="gkehub_v1.projects.locations.html">locations</a> . <a href="gkehub_v1.projects.locations.features.html">features</a></h1>
yoshi-code-bot227f8c92021-05-26 00:34:03 -070076<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-botb1eafb32021-06-15 00:26:02 -070081 <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">
yoshi-code-bot227f8c92021-05-26 00:34:03 -070090 <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-botb1eafb32021-06-15 00:26:02 -070093 <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">
yoshi-code-bot227f8c92021-05-26 00:34:03 -0700102 <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-botb1eafb32021-06-15 00:26:02 -0700114 <code class="details" id="create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</code>
115 <pre>Adds a new Feature.
116
117Args:
118 parent: string, The parent (project and location) where the Feature will be created. Specified in the format `projects/*/locations/*`. (required)
119 body: object, The request body.
120 The object takes the form of:
121
122{ # Feature represents the settings and status of any Hub Feature.
123 &quot;createTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was created.
124 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was deleted.
125 &quot;labels&quot;: { # GCP labels for this Feature.
126 &quot;a_key&quot;: &quot;A String&quot;,
127 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700128 &quot;membershipSpecs&quot;: { # 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&#x27;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.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700129 &quot;a_key&quot;: { # MembershipFeatureSpec contains configuration information for a single Membership.
130 &quot;configmanagement&quot;: { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
131 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
132 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
133 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
134 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700135 &quot;noSslVerify&quot;: True or False, # Enable or disable the SSL certificate verification Default: false.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700136 &quot;policyDir&quot;: &quot;A String&quot;, # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
137 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
138 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700139 &quot;syncDepth&quot;: &quot;A String&quot;, # The depth of git commits synced by the git-sync container.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700140 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
141 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
142 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
143 },
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700144 &quot;resourceRequirements&quot;: { # Specifies CPU and memory limits for containers, keyed by container name
145 &quot;a_key&quot;: { # ResourceRequirements allows to override the CPU and memory resource requirements of a container.
146 &quot;containerName&quot;: &quot;A String&quot;, # Name of the container
147 &quot;cpuLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the CPU limit of a container
148 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
149 },
150 &quot;memoryLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the memory limit of a container
151 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
152 },
153 },
154 },
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700155 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
156 },
157 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
158 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
159 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
160 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
161 },
162 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
163 &quot;auditIntervalSeconds&quot;: &quot;A String&quot;, # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
164 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
165 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
166 &quot;A String&quot;,
167 ],
168 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
169 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
170 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
171 },
172 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
173 },
174 },
175 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700176 &quot;membershipStates&quot;: { # 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&#x27;s project number.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700177 &quot;a_key&quot;: { # MembershipFeatureState contains Feature status information for a single Membership.
178 &quot;configmanagement&quot;: { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
179 &quot;clusterName&quot;: &quot;A String&quot;, # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership&#x27;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.
180 &quot;configSyncState&quot;: { # State information for ConfigSync # Current sync status
181 &quot;deploymentState&quot;: { # The state of ConfigSync&#x27;s deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700182 &quot;admissionWebhook&quot;: &quot;A String&quot;, # Deployment state of admission-webhook
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700183 &quot;gitSync&quot;: &quot;A String&quot;, # Deployment state of the git-sync pod
184 &quot;importer&quot;: &quot;A String&quot;, # Deployment state of the importer pod
185 &quot;monitor&quot;: &quot;A String&quot;, # Deployment state of the monitor pod
186 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Deployment state of reconciler-manager pod
187 &quot;rootReconciler&quot;: &quot;A String&quot;, # Deployment state of root-reconciler
188 &quot;syncer&quot;: &quot;A String&quot;, # Deployment state of the syncer pod
189 },
190 &quot;syncState&quot;: { # State indicating an ACM&#x27;s progress syncing configurations to a cluster # The state of ConfigSync&#x27;s process to sync configs to a cluster
191 &quot;code&quot;: &quot;A String&quot;, # Sync status code
192 &quot;errors&quot;: [ # 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.
193 { # An ACM created error representing a problem syncing configurations
194 &quot;code&quot;: &quot;A String&quot;, # An ACM defined error code
195 &quot;errorMessage&quot;: &quot;A String&quot;, # A description of the error
196 &quot;errorResources&quot;: [ # A list of config(s) associated with the error, if any
197 { # Model for a config file in the git repo with an associated Sync error
198 &quot;resourceGvk&quot;: { # A Kubernetes object&#x27;s GVK # Group/version/kind of the resource that is causing an error
199 &quot;group&quot;: &quot;A String&quot;, # Kubernetes Group
200 &quot;kind&quot;: &quot;A String&quot;, # Kubernetes Kind
201 &quot;version&quot;: &quot;A String&quot;, # Kubernetes Version
202 },
203 &quot;resourceName&quot;: &quot;A String&quot;, # Metadata name of the resource that is causing an error
204 &quot;resourceNamespace&quot;: &quot;A String&quot;, # Namespace of the resource that is causing an error
205 &quot;sourcePath&quot;: &quot;A String&quot;, # Path in the git repo of the erroneous config
206 },
207 ],
208 },
209 ],
210 &quot;importToken&quot;: &quot;A String&quot;, # Token indicating the state of the importer.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700211 &quot;lastSync&quot;: &quot;A String&quot;, # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700212 &quot;lastSyncTime&quot;: &quot;A String&quot;, # Timestamp type of when ACM last successfully synced the repo
213 &quot;sourceToken&quot;: &quot;A String&quot;, # Token indicating the state of the repo.
214 &quot;syncToken&quot;: &quot;A String&quot;, # Token indicating the state of the syncer.
215 },
216 &quot;version&quot;: { # Specific versioning information pertaining to ConfigSync&#x27;s Pods # The version of ConfigSync deployed
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700217 &quot;admissionWebhook&quot;: &quot;A String&quot;, # Version of the deployed admission_webhook pod
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700218 &quot;gitSync&quot;: &quot;A String&quot;, # Version of the deployed git-sync pod
219 &quot;importer&quot;: &quot;A String&quot;, # Version of the deployed importer pod
220 &quot;monitor&quot;: &quot;A String&quot;, # Version of the deployed monitor pod
221 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Version of the deployed reconciler-manager pod
222 &quot;rootReconciler&quot;: &quot;A String&quot;, # Version of the deployed reconciler container in root-reconciler pod
223 &quot;syncer&quot;: &quot;A String&quot;, # Version of the deployed syncer pod
224 },
225 },
226 &quot;hierarchyControllerState&quot;: { # State for Hierarchy Controller # Hierarchy Controller status
227 &quot;state&quot;: { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
228 &quot;extension&quot;: &quot;A String&quot;, # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
229 &quot;hnc&quot;: &quot;A String&quot;, # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
230 },
231 &quot;version&quot;: { # Version for Hierarchy Controller # The version for Hierarchy Controller
232 &quot;extension&quot;: &quot;A String&quot;, # Version for Hierarchy Controller extension
233 &quot;hnc&quot;: &quot;A String&quot;, # Version for open source HNC
234 },
235 },
236 &quot;membershipSpec&quot;: { # **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
237 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
238 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
239 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
240 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700241 &quot;noSslVerify&quot;: True or False, # Enable or disable the SSL certificate verification Default: false.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700242 &quot;policyDir&quot;: &quot;A String&quot;, # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
243 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
244 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700245 &quot;syncDepth&quot;: &quot;A String&quot;, # The depth of git commits synced by the git-sync container.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700246 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
247 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
248 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
249 },
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700250 &quot;resourceRequirements&quot;: { # Specifies CPU and memory limits for containers, keyed by container name
251 &quot;a_key&quot;: { # ResourceRequirements allows to override the CPU and memory resource requirements of a container.
252 &quot;containerName&quot;: &quot;A String&quot;, # Name of the container
253 &quot;cpuLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the CPU limit of a container
254 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
255 },
256 &quot;memoryLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the memory limit of a container
257 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
258 },
259 },
260 },
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700261 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
262 },
263 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
264 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
265 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
266 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
267 },
268 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
269 &quot;auditIntervalSeconds&quot;: &quot;A String&quot;, # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
270 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
271 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
272 &quot;A String&quot;,
273 ],
274 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
275 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
276 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
277 },
278 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
279 },
280 &quot;operatorState&quot;: { # State information for an ACM&#x27;s Operator # Current install status of ACM&#x27;s Operator
281 &quot;deploymentState&quot;: &quot;A String&quot;, # The state of the Operator&#x27;s deployment
282 &quot;errors&quot;: [ # Install errors.
283 { # Errors pertaining to the installation of ACM
284 &quot;errorMessage&quot;: &quot;A String&quot;, # A string representing the user facing error message
285 },
286 ],
287 &quot;version&quot;: &quot;A String&quot;, # The semenatic version number of the operator
288 },
289 &quot;policyControllerState&quot;: { # State for PolicyControllerState. # PolicyController status
290 &quot;deploymentState&quot;: { # State of Policy Controller installation. # The state about the policy controller installation.
291 &quot;gatekeeperAudit&quot;: &quot;A String&quot;, # Status of gatekeeper-audit deployment.
292 &quot;gatekeeperControllerManagerState&quot;: &quot;A String&quot;, # Status of gatekeeper-controller-manager pod.
293 },
294 &quot;version&quot;: { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
295 &quot;version&quot;: &quot;A String&quot;, # The gatekeeper image tag that is composed of ACM version, git tag, build number.
296 },
297 },
298 },
299 &quot;state&quot;: { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature&#x27;s state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
300 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
301 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
302 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
303 },
304 },
305 },
306 &quot;name&quot;: &quot;A String&quot;, # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
307 &quot;resourceState&quot;: { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the &quot;running state&quot; of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.
308 &quot;state&quot;: &quot;A String&quot;, # The current state of the Feature resource in the Hub API.
309 },
310 &quot;spec&quot;: { # 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.
311 &quot;multiclusteringress&quot;: { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
312 &quot;configMembership&quot;: &quot;A String&quot;, # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
313 },
314 },
315 &quot;state&quot;: { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
316 &quot;state&quot;: { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature&#x27;s state at the environ-level, or per-membershop, depending on the context. # Output only. The &quot;running state&quot; of the Feature in this Hub.
317 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
318 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
319 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
320 },
321 },
322 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was last updated.
323}
324
325 featureId: string, The ID of the feature to create.
326 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).
327 x__xgafv: string, V1 error format.
328 Allowed values
329 1 - v1 error format
330 2 - v2 error format
331
332Returns:
333 An object of the form:
334
335 { # This resource represents a long-running operation that is the result of a network API call.
336 &quot;done&quot;: 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.
337 &quot;error&quot;: { # 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.
338 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
339 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
340 {
341 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
342 },
343 ],
344 &quot;message&quot;: &quot;A String&quot;, # 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.
345 },
346 &quot;metadata&quot;: { # 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.
347 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
348 },
349 &quot;name&quot;: &quot;A String&quot;, # 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}`.
350 &quot;response&quot;: { # 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`.
351 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
352 },
353}</pre>
354</div>
355
356<div class="method">
357 <code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>
358 <pre>Removes a Feature.
359
360Args:
361 name: string, The Feature resource name in the format `projects/*/locations/*/features/*`. (required)
362 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.
363 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).
364 x__xgafv: string, V1 error format.
365 Allowed values
366 1 - v1 error format
367 2 - v2 error format
368
369Returns:
370 An object of the form:
371
372 { # This resource represents a long-running operation that is the result of a network API call.
373 &quot;done&quot;: 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.
374 &quot;error&quot;: { # 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.
375 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
376 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
377 {
378 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
379 },
380 ],
381 &quot;message&quot;: &quot;A String&quot;, # 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.
382 },
383 &quot;metadata&quot;: { # 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.
384 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
385 },
386 &quot;name&quot;: &quot;A String&quot;, # 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}`.
387 &quot;response&quot;: { # 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`.
388 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
389 },
390}</pre>
391</div>
392
393<div class="method">
394 <code class="details" id="get">get(name, x__xgafv=None)</code>
395 <pre>Gets details of a single Feature.
396
397Args:
398 name: string, The Feature resource name in the format `projects/*/locations/*/features/*` (required)
399 x__xgafv: string, V1 error format.
400 Allowed values
401 1 - v1 error format
402 2 - v2 error format
403
404Returns:
405 An object of the form:
406
407 { # Feature represents the settings and status of any Hub Feature.
408 &quot;createTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was created.
409 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was deleted.
410 &quot;labels&quot;: { # GCP labels for this Feature.
411 &quot;a_key&quot;: &quot;A String&quot;,
412 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700413 &quot;membershipSpecs&quot;: { # 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&#x27;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.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700414 &quot;a_key&quot;: { # MembershipFeatureSpec contains configuration information for a single Membership.
415 &quot;configmanagement&quot;: { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
416 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
417 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
418 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
419 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700420 &quot;noSslVerify&quot;: True or False, # Enable or disable the SSL certificate verification Default: false.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700421 &quot;policyDir&quot;: &quot;A String&quot;, # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
422 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
423 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700424 &quot;syncDepth&quot;: &quot;A String&quot;, # The depth of git commits synced by the git-sync container.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700425 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
426 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
427 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
428 },
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700429 &quot;resourceRequirements&quot;: { # Specifies CPU and memory limits for containers, keyed by container name
430 &quot;a_key&quot;: { # ResourceRequirements allows to override the CPU and memory resource requirements of a container.
431 &quot;containerName&quot;: &quot;A String&quot;, # Name of the container
432 &quot;cpuLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the CPU limit of a container
433 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
434 },
435 &quot;memoryLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the memory limit of a container
436 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
437 },
438 },
439 },
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700440 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
441 },
442 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
443 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
444 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
445 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
446 },
447 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
448 &quot;auditIntervalSeconds&quot;: &quot;A String&quot;, # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
449 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
450 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
451 &quot;A String&quot;,
452 ],
453 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
454 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
455 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
456 },
457 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
458 },
459 },
460 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700461 &quot;membershipStates&quot;: { # 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&#x27;s project number.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700462 &quot;a_key&quot;: { # MembershipFeatureState contains Feature status information for a single Membership.
463 &quot;configmanagement&quot;: { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
464 &quot;clusterName&quot;: &quot;A String&quot;, # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership&#x27;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.
465 &quot;configSyncState&quot;: { # State information for ConfigSync # Current sync status
466 &quot;deploymentState&quot;: { # The state of ConfigSync&#x27;s deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700467 &quot;admissionWebhook&quot;: &quot;A String&quot;, # Deployment state of admission-webhook
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700468 &quot;gitSync&quot;: &quot;A String&quot;, # Deployment state of the git-sync pod
469 &quot;importer&quot;: &quot;A String&quot;, # Deployment state of the importer pod
470 &quot;monitor&quot;: &quot;A String&quot;, # Deployment state of the monitor pod
471 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Deployment state of reconciler-manager pod
472 &quot;rootReconciler&quot;: &quot;A String&quot;, # Deployment state of root-reconciler
473 &quot;syncer&quot;: &quot;A String&quot;, # Deployment state of the syncer pod
474 },
475 &quot;syncState&quot;: { # State indicating an ACM&#x27;s progress syncing configurations to a cluster # The state of ConfigSync&#x27;s process to sync configs to a cluster
476 &quot;code&quot;: &quot;A String&quot;, # Sync status code
477 &quot;errors&quot;: [ # 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.
478 { # An ACM created error representing a problem syncing configurations
479 &quot;code&quot;: &quot;A String&quot;, # An ACM defined error code
480 &quot;errorMessage&quot;: &quot;A String&quot;, # A description of the error
481 &quot;errorResources&quot;: [ # A list of config(s) associated with the error, if any
482 { # Model for a config file in the git repo with an associated Sync error
483 &quot;resourceGvk&quot;: { # A Kubernetes object&#x27;s GVK # Group/version/kind of the resource that is causing an error
484 &quot;group&quot;: &quot;A String&quot;, # Kubernetes Group
485 &quot;kind&quot;: &quot;A String&quot;, # Kubernetes Kind
486 &quot;version&quot;: &quot;A String&quot;, # Kubernetes Version
487 },
488 &quot;resourceName&quot;: &quot;A String&quot;, # Metadata name of the resource that is causing an error
489 &quot;resourceNamespace&quot;: &quot;A String&quot;, # Namespace of the resource that is causing an error
490 &quot;sourcePath&quot;: &quot;A String&quot;, # Path in the git repo of the erroneous config
491 },
492 ],
493 },
494 ],
495 &quot;importToken&quot;: &quot;A String&quot;, # Token indicating the state of the importer.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700496 &quot;lastSync&quot;: &quot;A String&quot;, # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700497 &quot;lastSyncTime&quot;: &quot;A String&quot;, # Timestamp type of when ACM last successfully synced the repo
498 &quot;sourceToken&quot;: &quot;A String&quot;, # Token indicating the state of the repo.
499 &quot;syncToken&quot;: &quot;A String&quot;, # Token indicating the state of the syncer.
500 },
501 &quot;version&quot;: { # Specific versioning information pertaining to ConfigSync&#x27;s Pods # The version of ConfigSync deployed
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700502 &quot;admissionWebhook&quot;: &quot;A String&quot;, # Version of the deployed admission_webhook pod
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700503 &quot;gitSync&quot;: &quot;A String&quot;, # Version of the deployed git-sync pod
504 &quot;importer&quot;: &quot;A String&quot;, # Version of the deployed importer pod
505 &quot;monitor&quot;: &quot;A String&quot;, # Version of the deployed monitor pod
506 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Version of the deployed reconciler-manager pod
507 &quot;rootReconciler&quot;: &quot;A String&quot;, # Version of the deployed reconciler container in root-reconciler pod
508 &quot;syncer&quot;: &quot;A String&quot;, # Version of the deployed syncer pod
509 },
510 },
511 &quot;hierarchyControllerState&quot;: { # State for Hierarchy Controller # Hierarchy Controller status
512 &quot;state&quot;: { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
513 &quot;extension&quot;: &quot;A String&quot;, # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
514 &quot;hnc&quot;: &quot;A String&quot;, # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
515 },
516 &quot;version&quot;: { # Version for Hierarchy Controller # The version for Hierarchy Controller
517 &quot;extension&quot;: &quot;A String&quot;, # Version for Hierarchy Controller extension
518 &quot;hnc&quot;: &quot;A String&quot;, # Version for open source HNC
519 },
520 },
521 &quot;membershipSpec&quot;: { # **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
522 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
523 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
524 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
525 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700526 &quot;noSslVerify&quot;: True or False, # Enable or disable the SSL certificate verification Default: false.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700527 &quot;policyDir&quot;: &quot;A String&quot;, # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
528 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
529 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700530 &quot;syncDepth&quot;: &quot;A String&quot;, # The depth of git commits synced by the git-sync container.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700531 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
532 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
533 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
534 },
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700535 &quot;resourceRequirements&quot;: { # Specifies CPU and memory limits for containers, keyed by container name
536 &quot;a_key&quot;: { # ResourceRequirements allows to override the CPU and memory resource requirements of a container.
537 &quot;containerName&quot;: &quot;A String&quot;, # Name of the container
538 &quot;cpuLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the CPU limit of a container
539 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
540 },
541 &quot;memoryLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the memory limit of a container
542 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
543 },
544 },
545 },
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700546 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
547 },
548 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
549 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
550 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
551 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
552 },
553 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
554 &quot;auditIntervalSeconds&quot;: &quot;A String&quot;, # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
555 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
556 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
557 &quot;A String&quot;,
558 ],
559 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
560 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
561 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
562 },
563 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
564 },
565 &quot;operatorState&quot;: { # State information for an ACM&#x27;s Operator # Current install status of ACM&#x27;s Operator
566 &quot;deploymentState&quot;: &quot;A String&quot;, # The state of the Operator&#x27;s deployment
567 &quot;errors&quot;: [ # Install errors.
568 { # Errors pertaining to the installation of ACM
569 &quot;errorMessage&quot;: &quot;A String&quot;, # A string representing the user facing error message
570 },
571 ],
572 &quot;version&quot;: &quot;A String&quot;, # The semenatic version number of the operator
573 },
574 &quot;policyControllerState&quot;: { # State for PolicyControllerState. # PolicyController status
575 &quot;deploymentState&quot;: { # State of Policy Controller installation. # The state about the policy controller installation.
576 &quot;gatekeeperAudit&quot;: &quot;A String&quot;, # Status of gatekeeper-audit deployment.
577 &quot;gatekeeperControllerManagerState&quot;: &quot;A String&quot;, # Status of gatekeeper-controller-manager pod.
578 },
579 &quot;version&quot;: { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
580 &quot;version&quot;: &quot;A String&quot;, # The gatekeeper image tag that is composed of ACM version, git tag, build number.
581 },
582 },
583 },
584 &quot;state&quot;: { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature&#x27;s state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
585 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
586 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
587 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
588 },
589 },
590 },
591 &quot;name&quot;: &quot;A String&quot;, # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
592 &quot;resourceState&quot;: { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the &quot;running state&quot; of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.
593 &quot;state&quot;: &quot;A String&quot;, # The current state of the Feature resource in the Hub API.
594 },
595 &quot;spec&quot;: { # 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.
596 &quot;multiclusteringress&quot;: { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
597 &quot;configMembership&quot;: &quot;A String&quot;, # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
598 },
599 },
600 &quot;state&quot;: { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
601 &quot;state&quot;: { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature&#x27;s state at the environ-level, or per-membershop, depending on the context. # Output only. The &quot;running state&quot; of the Feature in this Hub.
602 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
603 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
604 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
605 },
606 },
607 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was last updated.
608}</pre>
609</div>
610
611<div class="method">
yoshi-code-bot227f8c92021-05-26 00:34:03 -0700612 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
613 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
614
615Args:
616 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
617 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).
618 x__xgafv: string, V1 error format.
619 Allowed values
620 1 - v1 error format
621 2 - v2 error format
622
623Returns:
624 An object of the form:
625
yoshi-code-bot96afc042021-08-24 00:22:31 -0700626 { # 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:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
yoshi-code-bot227f8c92021-05-26 00:34:03 -0700627 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
628 { # 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: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } 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.
629 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
630 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
631 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
632 &quot;A String&quot;,
633 ],
634 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
635 },
636 ],
637 &quot;service&quot;: &quot;A String&quot;, # 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.
638 },
639 ],
640 &quot;bindings&quot;: [ # 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.
641 { # Associates `members` with a `role`.
642 &quot;condition&quot;: { # 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: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; 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).
643 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
644 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
645 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
646 &quot;title&quot;: &quot;A String&quot;, # 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.
647 },
648 &quot;members&quot;: [ # 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`.
649 &quot;A String&quot;,
650 ],
651 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
652 },
653 ],
654 &quot;etag&quot;: &quot;A String&quot;, # `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.
655 &quot;version&quot;: 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).
656}</pre>
657</div>
658
659<div class="method">
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700660 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
661 <pre>Lists Features in a given project and location.
662
663Args:
664 parent: string, The parent (project and location) where the Features will be listed. Specified in the format `projects/*/locations/*`. (required)
665 filter: string, Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name &quot;servicemesh&quot; in project &quot;foo-proj&quot;: name = &quot;projects/foo-proj/locations/global/features/servicemesh&quot; - Features that have a label called `foo`: labels.foo:* - Features that have a label called `foo` whose value is `bar`: labels.foo = bar
666 orderBy: string, One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
667 pageSize: integer, When requesting a &#x27;page&#x27; of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
668 pageToken: string, Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources.
669 x__xgafv: string, V1 error format.
670 Allowed values
671 1 - v1 error format
672 2 - v2 error format
673
674Returns:
675 An object of the form:
676
677 { # Response message for the `GkeHub.ListFeatures` method.
678 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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.
679 &quot;resources&quot;: [ # The list of matching Features
680 { # Feature represents the settings and status of any Hub Feature.
681 &quot;createTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was created.
682 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was deleted.
683 &quot;labels&quot;: { # GCP labels for this Feature.
684 &quot;a_key&quot;: &quot;A String&quot;,
685 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700686 &quot;membershipSpecs&quot;: { # 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&#x27;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.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700687 &quot;a_key&quot;: { # MembershipFeatureSpec contains configuration information for a single Membership.
688 &quot;configmanagement&quot;: { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
689 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
690 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
691 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
692 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700693 &quot;noSslVerify&quot;: True or False, # Enable or disable the SSL certificate verification Default: false.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700694 &quot;policyDir&quot;: &quot;A String&quot;, # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
695 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
696 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700697 &quot;syncDepth&quot;: &quot;A String&quot;, # The depth of git commits synced by the git-sync container.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700698 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
699 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
700 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
701 },
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700702 &quot;resourceRequirements&quot;: { # Specifies CPU and memory limits for containers, keyed by container name
703 &quot;a_key&quot;: { # ResourceRequirements allows to override the CPU and memory resource requirements of a container.
704 &quot;containerName&quot;: &quot;A String&quot;, # Name of the container
705 &quot;cpuLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the CPU limit of a container
706 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
707 },
708 &quot;memoryLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the memory limit of a container
709 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
710 },
711 },
712 },
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700713 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
714 },
715 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
716 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
717 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
718 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
719 },
720 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
721 &quot;auditIntervalSeconds&quot;: &quot;A String&quot;, # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
722 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
723 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
724 &quot;A String&quot;,
725 ],
726 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
727 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
728 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
729 },
730 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
731 },
732 },
733 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700734 &quot;membershipStates&quot;: { # 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&#x27;s project number.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700735 &quot;a_key&quot;: { # MembershipFeatureState contains Feature status information for a single Membership.
736 &quot;configmanagement&quot;: { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
737 &quot;clusterName&quot;: &quot;A String&quot;, # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership&#x27;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.
738 &quot;configSyncState&quot;: { # State information for ConfigSync # Current sync status
739 &quot;deploymentState&quot;: { # The state of ConfigSync&#x27;s deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700740 &quot;admissionWebhook&quot;: &quot;A String&quot;, # Deployment state of admission-webhook
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700741 &quot;gitSync&quot;: &quot;A String&quot;, # Deployment state of the git-sync pod
742 &quot;importer&quot;: &quot;A String&quot;, # Deployment state of the importer pod
743 &quot;monitor&quot;: &quot;A String&quot;, # Deployment state of the monitor pod
744 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Deployment state of reconciler-manager pod
745 &quot;rootReconciler&quot;: &quot;A String&quot;, # Deployment state of root-reconciler
746 &quot;syncer&quot;: &quot;A String&quot;, # Deployment state of the syncer pod
747 },
748 &quot;syncState&quot;: { # State indicating an ACM&#x27;s progress syncing configurations to a cluster # The state of ConfigSync&#x27;s process to sync configs to a cluster
749 &quot;code&quot;: &quot;A String&quot;, # Sync status code
750 &quot;errors&quot;: [ # 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.
751 { # An ACM created error representing a problem syncing configurations
752 &quot;code&quot;: &quot;A String&quot;, # An ACM defined error code
753 &quot;errorMessage&quot;: &quot;A String&quot;, # A description of the error
754 &quot;errorResources&quot;: [ # A list of config(s) associated with the error, if any
755 { # Model for a config file in the git repo with an associated Sync error
756 &quot;resourceGvk&quot;: { # A Kubernetes object&#x27;s GVK # Group/version/kind of the resource that is causing an error
757 &quot;group&quot;: &quot;A String&quot;, # Kubernetes Group
758 &quot;kind&quot;: &quot;A String&quot;, # Kubernetes Kind
759 &quot;version&quot;: &quot;A String&quot;, # Kubernetes Version
760 },
761 &quot;resourceName&quot;: &quot;A String&quot;, # Metadata name of the resource that is causing an error
762 &quot;resourceNamespace&quot;: &quot;A String&quot;, # Namespace of the resource that is causing an error
763 &quot;sourcePath&quot;: &quot;A String&quot;, # Path in the git repo of the erroneous config
764 },
765 ],
766 },
767 ],
768 &quot;importToken&quot;: &quot;A String&quot;, # Token indicating the state of the importer.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700769 &quot;lastSync&quot;: &quot;A String&quot;, # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700770 &quot;lastSyncTime&quot;: &quot;A String&quot;, # Timestamp type of when ACM last successfully synced the repo
771 &quot;sourceToken&quot;: &quot;A String&quot;, # Token indicating the state of the repo.
772 &quot;syncToken&quot;: &quot;A String&quot;, # Token indicating the state of the syncer.
773 },
774 &quot;version&quot;: { # Specific versioning information pertaining to ConfigSync&#x27;s Pods # The version of ConfigSync deployed
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700775 &quot;admissionWebhook&quot;: &quot;A String&quot;, # Version of the deployed admission_webhook pod
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700776 &quot;gitSync&quot;: &quot;A String&quot;, # Version of the deployed git-sync pod
777 &quot;importer&quot;: &quot;A String&quot;, # Version of the deployed importer pod
778 &quot;monitor&quot;: &quot;A String&quot;, # Version of the deployed monitor pod
779 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Version of the deployed reconciler-manager pod
780 &quot;rootReconciler&quot;: &quot;A String&quot;, # Version of the deployed reconciler container in root-reconciler pod
781 &quot;syncer&quot;: &quot;A String&quot;, # Version of the deployed syncer pod
782 },
783 },
784 &quot;hierarchyControllerState&quot;: { # State for Hierarchy Controller # Hierarchy Controller status
785 &quot;state&quot;: { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
786 &quot;extension&quot;: &quot;A String&quot;, # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
787 &quot;hnc&quot;: &quot;A String&quot;, # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
788 },
789 &quot;version&quot;: { # Version for Hierarchy Controller # The version for Hierarchy Controller
790 &quot;extension&quot;: &quot;A String&quot;, # Version for Hierarchy Controller extension
791 &quot;hnc&quot;: &quot;A String&quot;, # Version for open source HNC
792 },
793 },
794 &quot;membershipSpec&quot;: { # **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
795 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
796 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
797 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
798 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700799 &quot;noSslVerify&quot;: True or False, # Enable or disable the SSL certificate verification Default: false.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700800 &quot;policyDir&quot;: &quot;A String&quot;, # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
801 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
802 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700803 &quot;syncDepth&quot;: &quot;A String&quot;, # The depth of git commits synced by the git-sync container.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700804 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
805 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
806 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
807 },
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700808 &quot;resourceRequirements&quot;: { # Specifies CPU and memory limits for containers, keyed by container name
809 &quot;a_key&quot;: { # ResourceRequirements allows to override the CPU and memory resource requirements of a container.
810 &quot;containerName&quot;: &quot;A String&quot;, # Name of the container
811 &quot;cpuLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the CPU limit of a container
812 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
813 },
814 &quot;memoryLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the memory limit of a container
815 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
816 },
817 },
818 },
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700819 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
820 },
821 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
822 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
823 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
824 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
825 },
826 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
827 &quot;auditIntervalSeconds&quot;: &quot;A String&quot;, # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
828 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
829 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
830 &quot;A String&quot;,
831 ],
832 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
833 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
834 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
835 },
836 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
837 },
838 &quot;operatorState&quot;: { # State information for an ACM&#x27;s Operator # Current install status of ACM&#x27;s Operator
839 &quot;deploymentState&quot;: &quot;A String&quot;, # The state of the Operator&#x27;s deployment
840 &quot;errors&quot;: [ # Install errors.
841 { # Errors pertaining to the installation of ACM
842 &quot;errorMessage&quot;: &quot;A String&quot;, # A string representing the user facing error message
843 },
844 ],
845 &quot;version&quot;: &quot;A String&quot;, # The semenatic version number of the operator
846 },
847 &quot;policyControllerState&quot;: { # State for PolicyControllerState. # PolicyController status
848 &quot;deploymentState&quot;: { # State of Policy Controller installation. # The state about the policy controller installation.
849 &quot;gatekeeperAudit&quot;: &quot;A String&quot;, # Status of gatekeeper-audit deployment.
850 &quot;gatekeeperControllerManagerState&quot;: &quot;A String&quot;, # Status of gatekeeper-controller-manager pod.
851 },
852 &quot;version&quot;: { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
853 &quot;version&quot;: &quot;A String&quot;, # The gatekeeper image tag that is composed of ACM version, git tag, build number.
854 },
855 },
856 },
857 &quot;state&quot;: { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature&#x27;s state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
858 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
859 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
860 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
861 },
862 },
863 },
864 &quot;name&quot;: &quot;A String&quot;, # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
865 &quot;resourceState&quot;: { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the &quot;running state&quot; of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.
866 &quot;state&quot;: &quot;A String&quot;, # The current state of the Feature resource in the Hub API.
867 },
868 &quot;spec&quot;: { # 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.
869 &quot;multiclusteringress&quot;: { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
870 &quot;configMembership&quot;: &quot;A String&quot;, # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
871 },
872 },
873 &quot;state&quot;: { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
874 &quot;state&quot;: { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature&#x27;s state at the environ-level, or per-membershop, depending on the context. # Output only. The &quot;running state&quot; of the Feature in this Hub.
875 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
876 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
877 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
878 },
879 },
880 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was last updated.
881 },
882 ],
883}</pre>
884</div>
885
886<div class="method">
887 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
888 <pre>Retrieves the next page of results.
889
890Args:
891 previous_request: The request for the previous page. (required)
892 previous_response: The response from the request for the previous page. (required)
893
894Returns:
895 A request object that you can call &#x27;execute()&#x27; on to request the next
896 page. Returns None if there are no more items in the collection.
897 </pre>
898</div>
899
900<div class="method">
901 <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
902 <pre>Updates an existing Feature.
903
904Args:
905 name: string, The Feature resource name in the format `projects/*/locations/*/features/*`. (required)
906 body: object, The request body.
907 The object takes the form of:
908
909{ # Feature represents the settings and status of any Hub Feature.
910 &quot;createTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was created.
911 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was deleted.
912 &quot;labels&quot;: { # GCP labels for this Feature.
913 &quot;a_key&quot;: &quot;A String&quot;,
914 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700915 &quot;membershipSpecs&quot;: { # 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&#x27;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.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700916 &quot;a_key&quot;: { # MembershipFeatureSpec contains configuration information for a single Membership.
917 &quot;configmanagement&quot;: { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
918 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
919 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
920 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
921 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700922 &quot;noSslVerify&quot;: True or False, # Enable or disable the SSL certificate verification Default: false.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700923 &quot;policyDir&quot;: &quot;A String&quot;, # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
924 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
925 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700926 &quot;syncDepth&quot;: &quot;A String&quot;, # The depth of git commits synced by the git-sync container.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700927 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
928 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
929 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
930 },
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700931 &quot;resourceRequirements&quot;: { # Specifies CPU and memory limits for containers, keyed by container name
932 &quot;a_key&quot;: { # ResourceRequirements allows to override the CPU and memory resource requirements of a container.
933 &quot;containerName&quot;: &quot;A String&quot;, # Name of the container
934 &quot;cpuLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the CPU limit of a container
935 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
936 },
937 &quot;memoryLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the memory limit of a container
938 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
939 },
940 },
941 },
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700942 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
943 },
944 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
945 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
946 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
947 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
948 },
949 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
950 &quot;auditIntervalSeconds&quot;: &quot;A String&quot;, # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
951 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
952 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
953 &quot;A String&quot;,
954 ],
955 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
956 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
957 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
958 },
959 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
960 },
961 },
962 },
yoshi-code-bot07708072021-07-20 00:20:24 -0700963 &quot;membershipStates&quot;: { # 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&#x27;s project number.
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700964 &quot;a_key&quot;: { # MembershipFeatureState contains Feature status information for a single Membership.
965 &quot;configmanagement&quot;: { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
966 &quot;clusterName&quot;: &quot;A String&quot;, # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership&#x27;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.
967 &quot;configSyncState&quot;: { # State information for ConfigSync # Current sync status
968 &quot;deploymentState&quot;: { # The state of ConfigSync&#x27;s deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700969 &quot;admissionWebhook&quot;: &quot;A String&quot;, # Deployment state of admission-webhook
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700970 &quot;gitSync&quot;: &quot;A String&quot;, # Deployment state of the git-sync pod
971 &quot;importer&quot;: &quot;A String&quot;, # Deployment state of the importer pod
972 &quot;monitor&quot;: &quot;A String&quot;, # Deployment state of the monitor pod
973 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Deployment state of reconciler-manager pod
974 &quot;rootReconciler&quot;: &quot;A String&quot;, # Deployment state of root-reconciler
975 &quot;syncer&quot;: &quot;A String&quot;, # Deployment state of the syncer pod
976 },
977 &quot;syncState&quot;: { # State indicating an ACM&#x27;s progress syncing configurations to a cluster # The state of ConfigSync&#x27;s process to sync configs to a cluster
978 &quot;code&quot;: &quot;A String&quot;, # Sync status code
979 &quot;errors&quot;: [ # 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.
980 { # An ACM created error representing a problem syncing configurations
981 &quot;code&quot;: &quot;A String&quot;, # An ACM defined error code
982 &quot;errorMessage&quot;: &quot;A String&quot;, # A description of the error
983 &quot;errorResources&quot;: [ # A list of config(s) associated with the error, if any
984 { # Model for a config file in the git repo with an associated Sync error
985 &quot;resourceGvk&quot;: { # A Kubernetes object&#x27;s GVK # Group/version/kind of the resource that is causing an error
986 &quot;group&quot;: &quot;A String&quot;, # Kubernetes Group
987 &quot;kind&quot;: &quot;A String&quot;, # Kubernetes Kind
988 &quot;version&quot;: &quot;A String&quot;, # Kubernetes Version
989 },
990 &quot;resourceName&quot;: &quot;A String&quot;, # Metadata name of the resource that is causing an error
991 &quot;resourceNamespace&quot;: &quot;A String&quot;, # Namespace of the resource that is causing an error
992 &quot;sourcePath&quot;: &quot;A String&quot;, # Path in the git repo of the erroneous config
993 },
994 ],
995 },
996 ],
997 &quot;importToken&quot;: &quot;A String&quot;, # Token indicating the state of the importer.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700998 &quot;lastSync&quot;: &quot;A String&quot;, # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String
yoshi-code-botb1eafb32021-06-15 00:26:02 -0700999 &quot;lastSyncTime&quot;: &quot;A String&quot;, # Timestamp type of when ACM last successfully synced the repo
1000 &quot;sourceToken&quot;: &quot;A String&quot;, # Token indicating the state of the repo.
1001 &quot;syncToken&quot;: &quot;A String&quot;, # Token indicating the state of the syncer.
1002 },
1003 &quot;version&quot;: { # Specific versioning information pertaining to ConfigSync&#x27;s Pods # The version of ConfigSync deployed
yoshi-code-botad81f3d2021-09-28 00:22:30 -07001004 &quot;admissionWebhook&quot;: &quot;A String&quot;, # Version of the deployed admission_webhook pod
yoshi-code-botb1eafb32021-06-15 00:26:02 -07001005 &quot;gitSync&quot;: &quot;A String&quot;, # Version of the deployed git-sync pod
1006 &quot;importer&quot;: &quot;A String&quot;, # Version of the deployed importer pod
1007 &quot;monitor&quot;: &quot;A String&quot;, # Version of the deployed monitor pod
1008 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Version of the deployed reconciler-manager pod
1009 &quot;rootReconciler&quot;: &quot;A String&quot;, # Version of the deployed reconciler container in root-reconciler pod
1010 &quot;syncer&quot;: &quot;A String&quot;, # Version of the deployed syncer pod
1011 },
1012 },
1013 &quot;hierarchyControllerState&quot;: { # State for Hierarchy Controller # Hierarchy Controller status
1014 &quot;state&quot;: { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
1015 &quot;extension&quot;: &quot;A String&quot;, # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
1016 &quot;hnc&quot;: &quot;A String&quot;, # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
1017 },
1018 &quot;version&quot;: { # Version for Hierarchy Controller # The version for Hierarchy Controller
1019 &quot;extension&quot;: &quot;A String&quot;, # Version for Hierarchy Controller extension
1020 &quot;hnc&quot;: &quot;A String&quot;, # Version for open source HNC
1021 },
1022 },
1023 &quot;membershipSpec&quot;: { # **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
1024 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
1025 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
1026 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
1027 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
yoshi-code-botad81f3d2021-09-28 00:22:30 -07001028 &quot;noSslVerify&quot;: True or False, # Enable or disable the SSL certificate verification Default: false.
yoshi-code-botb1eafb32021-06-15 00:26:02 -07001029 &quot;policyDir&quot;: &quot;A String&quot;, # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
1030 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
1031 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
yoshi-code-botad81f3d2021-09-28 00:22:30 -07001032 &quot;syncDepth&quot;: &quot;A String&quot;, # The depth of git commits synced by the git-sync container.
yoshi-code-botb1eafb32021-06-15 00:26:02 -07001033 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
1034 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
1035 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
1036 },
yoshi-code-botad81f3d2021-09-28 00:22:30 -07001037 &quot;resourceRequirements&quot;: { # Specifies CPU and memory limits for containers, keyed by container name
1038 &quot;a_key&quot;: { # ResourceRequirements allows to override the CPU and memory resource requirements of a container.
1039 &quot;containerName&quot;: &quot;A String&quot;, # Name of the container
1040 &quot;cpuLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the CPU limit of a container
1041 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
1042 },
1043 &quot;memoryLimit&quot;: { # The view model of a single quantity, e.g. &quot;800 MiB&quot;. Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto # Allows to override the memory limit of a container
1044 &quot;string&quot;: &quot;A String&quot;, # Stringified version of the quantity, e.g., &quot;800 MiB&quot;.
1045 },
1046 },
1047 },
yoshi-code-botb1eafb32021-06-15 00:26:02 -07001048 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
1049 },
1050 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
1051 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
1052 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
1053 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
1054 },
1055 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
1056 &quot;auditIntervalSeconds&quot;: &quot;A String&quot;, # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
1057 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
1058 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
1059 &quot;A String&quot;,
1060 ],
1061 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
1062 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
1063 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
1064 },
1065 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
1066 },
1067 &quot;operatorState&quot;: { # State information for an ACM&#x27;s Operator # Current install status of ACM&#x27;s Operator
1068 &quot;deploymentState&quot;: &quot;A String&quot;, # The state of the Operator&#x27;s deployment
1069 &quot;errors&quot;: [ # Install errors.
1070 { # Errors pertaining to the installation of ACM
1071 &quot;errorMessage&quot;: &quot;A String&quot;, # A string representing the user facing error message
1072 },
1073 ],
1074 &quot;version&quot;: &quot;A String&quot;, # The semenatic version number of the operator
1075 },
1076 &quot;policyControllerState&quot;: { # State for PolicyControllerState. # PolicyController status
1077 &quot;deploymentState&quot;: { # State of Policy Controller installation. # The state about the policy controller installation.
1078 &quot;gatekeeperAudit&quot;: &quot;A String&quot;, # Status of gatekeeper-audit deployment.
1079 &quot;gatekeeperControllerManagerState&quot;: &quot;A String&quot;, # Status of gatekeeper-controller-manager pod.
1080 },
1081 &quot;version&quot;: { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
1082 &quot;version&quot;: &quot;A String&quot;, # The gatekeeper image tag that is composed of ACM version, git tag, build number.
1083 },
1084 },
1085 },
1086 &quot;state&quot;: { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature&#x27;s state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
1087 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
1088 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
1089 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
1090 },
1091 },
1092 },
1093 &quot;name&quot;: &quot;A String&quot;, # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
1094 &quot;resourceState&quot;: { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the &quot;running state&quot; of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.
1095 &quot;state&quot;: &quot;A String&quot;, # The current state of the Feature resource in the Hub API.
1096 },
1097 &quot;spec&quot;: { # 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.
1098 &quot;multiclusteringress&quot;: { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
1099 &quot;configMembership&quot;: &quot;A String&quot;, # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
1100 },
1101 },
1102 &quot;state&quot;: { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
1103 &quot;state&quot;: { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature&#x27;s state at the environ-level, or per-membershop, depending on the context. # Output only. The &quot;running state&quot; of the Feature in this Hub.
1104 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
1105 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
1106 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
1107 },
1108 },
1109 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was last updated.
1110}
1111
1112 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).
1113 updateMask: string, Mask of fields to update.
1114 x__xgafv: string, V1 error format.
1115 Allowed values
1116 1 - v1 error format
1117 2 - v2 error format
1118
1119Returns:
1120 An object of the form:
1121
1122 { # This resource represents a long-running operation that is the result of a network API call.
1123 &quot;done&quot;: 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.
1124 &quot;error&quot;: { # 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.
1125 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1126 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1127 {
1128 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1129 },
1130 ],
1131 &quot;message&quot;: &quot;A String&quot;, # 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.
1132 },
1133 &quot;metadata&quot;: { # 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.
1134 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1135 },
1136 &quot;name&quot;: &quot;A String&quot;, # 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}`.
1137 &quot;response&quot;: { # 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`.
1138 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1139 },
1140}</pre>
1141</div>
1142
1143<div class="method">
yoshi-code-bot227f8c92021-05-26 00:34:03 -07001144 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
1145 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
1146
1147Args:
1148 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
1149 body: object, The request body.
1150 The object takes the form of:
1151
1152{ # Request message for `SetIamPolicy` method.
yoshi-code-bot96afc042021-08-24 00:22:31 -07001153 &quot;policy&quot;: { # 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:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) 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.
yoshi-code-bot227f8c92021-05-26 00:34:03 -07001154 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1155 { # 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: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } 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.
1156 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1157 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
1158 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
1159 &quot;A String&quot;,
1160 ],
1161 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1162 },
1163 ],
1164 &quot;service&quot;: &quot;A String&quot;, # 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.
1165 },
1166 ],
1167 &quot;bindings&quot;: [ # 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.
1168 { # Associates `members` with a `role`.
1169 &quot;condition&quot;: { # 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: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; 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).
1170 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1171 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1172 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1173 &quot;title&quot;: &quot;A String&quot;, # 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.
1174 },
1175 &quot;members&quot;: [ # 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`.
1176 &quot;A String&quot;,
1177 ],
1178 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1179 },
1180 ],
1181 &quot;etag&quot;: &quot;A String&quot;, # `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.
1182 &quot;version&quot;: 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).
1183 },
1184 &quot;updateMask&quot;: &quot;A String&quot;, # 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: &quot;bindings, etag&quot;`
1185}
1186
1187 x__xgafv: string, V1 error format.
1188 Allowed values
1189 1 - v1 error format
1190 2 - v2 error format
1191
1192Returns:
1193 An object of the form:
1194
yoshi-code-bot96afc042021-08-24 00:22:31 -07001195 { # 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:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
yoshi-code-bot227f8c92021-05-26 00:34:03 -07001196 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1197 { # 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: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } 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.
1198 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1199 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
1200 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
1201 &quot;A String&quot;,
1202 ],
1203 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1204 },
1205 ],
1206 &quot;service&quot;: &quot;A String&quot;, # 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.
1207 },
1208 ],
1209 &quot;bindings&quot;: [ # 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.
1210 { # Associates `members` with a `role`.
1211 &quot;condition&quot;: { # 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: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; 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).
1212 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1213 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1214 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1215 &quot;title&quot;: &quot;A String&quot;, # 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.
1216 },
1217 &quot;members&quot;: [ # 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`.
1218 &quot;A String&quot;,
1219 ],
1220 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1221 },
1222 ],
1223 &quot;etag&quot;: &quot;A String&quot;, # `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.
1224 &quot;version&quot;: 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).
1225}</pre>
1226</div>
1227
1228<div class="method">
1229 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
1230 <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 &quot;fail open&quot; without warning.
1231
1232Args:
1233 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)
1234 body: object, The request body.
1235 The object takes the form of:
1236
1237{ # Request message for `TestIamPermissions` method.
1238 &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
1239 &quot;A String&quot;,
1240 ],
1241}
1242
1243 x__xgafv: string, V1 error format.
1244 Allowed values
1245 1 - v1 error format
1246 2 - v2 error format
1247
1248Returns:
1249 An object of the form:
1250
1251 { # Response message for `TestIamPermissions` method.
1252 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1253 &quot;A String&quot;,
1254 ],
1255}</pre>
1256</div>
1257
1258</body></html>