blob: 7fe99b66fd2002c56b2b2b9cd5fb2b3a51fe6d15 [file] [log] [blame]
Anthonios Partheniou10f4b672021-04-13 14:47:53 -04001<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_v1beta.html">GKE Hub API</a> . <a href="gkehub_v1beta.projects.html">projects</a> . <a href="gkehub_v1beta.projects.locations.html">locations</a> . <a href="gkehub_v1beta.projects.locations.features.html">features</a></h1>
Anthonios Partheniou10f4b672021-04-13 14:47:53 -040076<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-bot44a67192021-05-02 03:48: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">
Anthonios Partheniou10f4b672021-04-13 14:47:53 -040090 <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-bot44a67192021-05-02 03:48: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">
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400102 <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-bot44a67192021-05-02 03:48: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-bot1a4514d2021-07-13 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-bot44a67192021-05-02 03:48:02 -0700129 &quot;a_key&quot;: { # MembershipFeatureSpec contains configuration information for a single Membership.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700130 &quot;configmanagement&quot;: { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700131 &quot;binauthz&quot;: { # Configuration for Binauthz # Binauthz conifguration for the cluster.
132 &quot;enabled&quot;: True or False, # Whether binauthz is enabled in this cluster.
133 },
134 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
135 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
136 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
137 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
138 &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.
139 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
140 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
141 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
142 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
143 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
144 },
145 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
146 },
147 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
148 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
149 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
150 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
151 },
152 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
153 &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.
154 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
155 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
156 &quot;A String&quot;,
157 ],
158 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
159 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
160 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
161 },
162 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
163 },
yoshi-code-bot96afc042021-08-24 00:22:31 -0700164 &quot;identityservice&quot;: { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
165 &quot;authMethods&quot;: [ # A member may support multiple auth methods.
166 { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
167 &quot;name&quot;: &quot;A String&quot;, # Identifier for auth config.
168 &quot;oidcConfig&quot;: { # Configuration for OIDC Auth flow. # OIDC specific configuration.
169 &quot;certificateAuthorityData&quot;: &quot;A String&quot;, # PEM-encoded CA for OIDC provider.
170 &quot;clientId&quot;: &quot;A String&quot;, # ID for OIDC client application.
171 &quot;deployCloudConsoleProxy&quot;: True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
172 &quot;extraParams&quot;: &quot;A String&quot;, # Comma-separated list of key-value pairs.
173 &quot;groupPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to group name.
174 &quot;groupsClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds group information.
175 &quot;issuerUri&quot;: &quot;A String&quot;, # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
176 &quot;kubectlRedirectUri&quot;: &quot;A String&quot;, # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
177 &quot;scopes&quot;: &quot;A String&quot;, # Comma-separated list of identifiers.
178 &quot;userClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds username.
179 &quot;userPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to user name.
180 },
181 &quot;proxy&quot;: &quot;A String&quot;, # Proxy server address to use for auth method.
182 },
183 ],
184 },
yoshi-code-bot44a67192021-05-02 03:48:02 -0700185 },
186 },
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700187 &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-bot44a67192021-05-02 03:48:02 -0700188 &quot;a_key&quot;: { # MembershipFeatureState contains Feature status information for a single Membership.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700189 &quot;configmanagement&quot;: { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700190 &quot;binauthzState&quot;: { # State for Binauthz # Binauthz status
191 &quot;version&quot;: { # The version of binauthz. # The version of binauthz that is installed.
192 &quot;webhookVersion&quot;: &quot;A String&quot;, # The version of the binauthz webhook.
193 },
194 &quot;webhook&quot;: &quot;A String&quot;, # The state of the binauthz webhook.
195 },
196 &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.
197 &quot;configSyncState&quot;: { # State information for ConfigSync # Current sync status
198 &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
199 &quot;gitSync&quot;: &quot;A String&quot;, # Deployment state of the git-sync pod
200 &quot;importer&quot;: &quot;A String&quot;, # Deployment state of the importer pod
201 &quot;monitor&quot;: &quot;A String&quot;, # Deployment state of the monitor pod
202 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Deployment state of reconciler-manager pod
203 &quot;rootReconciler&quot;: &quot;A String&quot;, # Deployment state of root-reconciler
204 &quot;syncer&quot;: &quot;A String&quot;, # Deployment state of the syncer pod
205 },
206 &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
207 &quot;code&quot;: &quot;A String&quot;, # Sync status code
208 &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.
209 { # An ACM created error representing a problem syncing configurations
210 &quot;code&quot;: &quot;A String&quot;, # An ACM defined error code
211 &quot;errorMessage&quot;: &quot;A String&quot;, # A description of the error
212 &quot;errorResources&quot;: [ # A list of config(s) associated with the error, if any
213 { # Model for a config file in the git repo with an associated Sync error
214 &quot;resourceGvk&quot;: { # A Kubernetes object&#x27;s GVK # Group/version/kind of the resource that is causing an error
215 &quot;group&quot;: &quot;A String&quot;, # Kubernetes Group
216 &quot;kind&quot;: &quot;A String&quot;, # Kubernetes Kind
217 &quot;version&quot;: &quot;A String&quot;, # Kubernetes Version
218 },
219 &quot;resourceName&quot;: &quot;A String&quot;, # Metadata name of the resource that is causing an error
220 &quot;resourceNamespace&quot;: &quot;A String&quot;, # Namespace of the resource that is causing an error
221 &quot;sourcePath&quot;: &quot;A String&quot;, # Path in the git repo of the erroneous config
222 },
223 ],
224 },
225 ],
226 &quot;importToken&quot;: &quot;A String&quot;, # Token indicating the state of the importer.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700227 &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-bot44a67192021-05-02 03:48:02 -0700228 &quot;lastSyncTime&quot;: &quot;A String&quot;, # Timestamp type of when ACM last successfully synced the repo
229 &quot;sourceToken&quot;: &quot;A String&quot;, # Token indicating the state of the repo.
230 &quot;syncToken&quot;: &quot;A String&quot;, # Token indicating the state of the syncer.
231 },
232 &quot;version&quot;: { # Specific versioning information pertaining to ConfigSync&#x27;s Pods # The version of ConfigSync deployed
233 &quot;gitSync&quot;: &quot;A String&quot;, # Version of the deployed git-sync pod
234 &quot;importer&quot;: &quot;A String&quot;, # Version of the deployed importer pod
235 &quot;monitor&quot;: &quot;A String&quot;, # Version of the deployed monitor pod
236 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Version of the deployed reconciler-manager pod
237 &quot;rootReconciler&quot;: &quot;A String&quot;, # Version of the deployed reconciler container in root-reconciler pod
238 &quot;syncer&quot;: &quot;A String&quot;, # Version of the deployed syncer pod
239 },
240 },
241 &quot;hierarchyControllerState&quot;: { # State for Hierarchy Controller # Hierarchy Controller status
242 &quot;state&quot;: { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
243 &quot;extension&quot;: &quot;A String&quot;, # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
244 &quot;hnc&quot;: &quot;A String&quot;, # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
245 },
246 &quot;version&quot;: { # Version for Hierarchy Controller # The version for Hierarchy Controller
247 &quot;extension&quot;: &quot;A String&quot;, # Version for Hierarchy Controller extension
248 &quot;hnc&quot;: &quot;A String&quot;, # Version for open source HNC
249 },
250 },
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700251 &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
yoshi-code-bot44a67192021-05-02 03:48:02 -0700252 &quot;binauthz&quot;: { # Configuration for Binauthz # Binauthz conifguration for the cluster.
253 &quot;enabled&quot;: True or False, # Whether binauthz is enabled in this cluster.
254 },
255 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
256 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
257 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
258 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
259 &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.
260 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
261 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
262 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
263 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
264 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
265 },
266 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
267 },
268 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
269 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
270 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
271 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
272 },
273 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
274 &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.
275 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
276 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
277 &quot;A String&quot;,
278 ],
279 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
280 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
281 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
282 },
283 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
284 },
285 &quot;operatorState&quot;: { # State information for an ACM&#x27;s Operator # Current install status of ACM&#x27;s Operator
286 &quot;deploymentState&quot;: &quot;A String&quot;, # The state of the Operator&#x27;s deployment
287 &quot;errors&quot;: [ # Install errors.
288 { # Errors pertaining to the installation of ACM
289 &quot;errorMessage&quot;: &quot;A String&quot;, # A string representing the user facing error message
290 },
291 ],
292 &quot;version&quot;: &quot;A String&quot;, # The semenatic version number of the operator
293 },
294 &quot;policyControllerState&quot;: { # State for PolicyControllerState. # PolicyController status
295 &quot;deploymentState&quot;: { # State of Policy Controller installation. # The state about the policy controller installation.
296 &quot;gatekeeperAudit&quot;: &quot;A String&quot;, # Status of gatekeeper-audit deployment.
297 &quot;gatekeeperControllerManagerState&quot;: &quot;A String&quot;, # Status of gatekeeper-controller-manager pod.
298 },
299 &quot;version&quot;: { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
300 &quot;version&quot;: &quot;A String&quot;, # The gatekeeper image tag that is composed of ACM version, git tag, build number.
301 },
302 },
303 },
yoshi-code-bot96afc042021-08-24 00:22:31 -0700304 &quot;identityservice&quot;: { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.
305 &quot;failureReason&quot;: &quot;A String&quot;, # The reason of the failure.
306 &quot;installedVersion&quot;: &quot;A String&quot;, # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.
307 &quot;memberConfig&quot;: { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration
308 &quot;authMethods&quot;: [ # A member may support multiple auth methods.
309 { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
310 &quot;name&quot;: &quot;A String&quot;, # Identifier for auth config.
311 &quot;oidcConfig&quot;: { # Configuration for OIDC Auth flow. # OIDC specific configuration.
312 &quot;certificateAuthorityData&quot;: &quot;A String&quot;, # PEM-encoded CA for OIDC provider.
313 &quot;clientId&quot;: &quot;A String&quot;, # ID for OIDC client application.
314 &quot;deployCloudConsoleProxy&quot;: True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
315 &quot;extraParams&quot;: &quot;A String&quot;, # Comma-separated list of key-value pairs.
316 &quot;groupPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to group name.
317 &quot;groupsClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds group information.
318 &quot;issuerUri&quot;: &quot;A String&quot;, # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
319 &quot;kubectlRedirectUri&quot;: &quot;A String&quot;, # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
320 &quot;scopes&quot;: &quot;A String&quot;, # Comma-separated list of identifiers.
321 &quot;userClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds username.
322 &quot;userPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to user name.
323 },
324 &quot;proxy&quot;: &quot;A String&quot;, # Proxy server address to use for auth method.
325 },
326 ],
327 },
328 &quot;state&quot;: &quot;A String&quot;, # Deployment state on this member
329 },
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700330 &quot;metering&quot;: { # **Metering**: Per-Membership Feature State. # Metering-specific spec.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700331 &quot;lastMeasurementTime&quot;: &quot;A String&quot;, # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
332 &quot;preciseLastMeasuredClusterVcpuCapacity&quot;: 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
333 },
334 &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.
335 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
336 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
337 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
338 },
339 },
340 },
341 &quot;name&quot;: &quot;A String&quot;, # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
342 &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.
343 &quot;state&quot;: &quot;A String&quot;, # The current state of the Feature resource in the Hub API.
344 },
345 &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.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700346 &quot;multiclusteringress&quot;: { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700347 &quot;billing&quot;: &quot;A String&quot;, # Deprecated: This field will be ignored and should not be set. Customer&#x27;s billing structure.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700348 &quot;configMembership&quot;: &quot;A String&quot;, # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
349 },
350 },
351 &quot;state&quot;: { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
352 &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.
353 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
354 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
355 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
356 },
357 },
358 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was last updated.
359}
360
361 featureId: string, The ID of the feature to create.
362 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).
363 x__xgafv: string, V1 error format.
364 Allowed values
365 1 - v1 error format
366 2 - v2 error format
367
368Returns:
369 An object of the form:
370
371 { # This resource represents a long-running operation that is the result of a network API call.
372 &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.
373 &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.
374 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
375 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
376 {
377 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
378 },
379 ],
380 &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.
381 },
382 &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.
383 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
384 },
385 &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}`.
386 &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`.
387 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
388 },
389}</pre>
390</div>
391
392<div class="method">
393 <code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>
394 <pre>Removes a Feature.
395
396Args:
397 name: string, The Feature resource name in the format `projects/*/locations/*/features/*`. (required)
398 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.
399 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).
400 x__xgafv: string, V1 error format.
401 Allowed values
402 1 - v1 error format
403 2 - v2 error format
404
405Returns:
406 An object of the form:
407
408 { # This resource represents a long-running operation that is the result of a network API call.
409 &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.
410 &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.
411 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
412 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
413 {
414 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
415 },
416 ],
417 &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.
418 },
419 &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.
420 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
421 },
422 &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}`.
423 &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`.
424 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
425 },
426}</pre>
427</div>
428
429<div class="method">
430 <code class="details" id="get">get(name, x__xgafv=None)</code>
431 <pre>Gets details of a single Feature.
432
433Args:
434 name: string, The Feature resource name in the format `projects/*/locations/*/features/*` (required)
435 x__xgafv: string, V1 error format.
436 Allowed values
437 1 - v1 error format
438 2 - v2 error format
439
440Returns:
441 An object of the form:
442
443 { # Feature represents the settings and status of any Hub Feature.
444 &quot;createTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was created.
445 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was deleted.
446 &quot;labels&quot;: { # GCP labels for this Feature.
447 &quot;a_key&quot;: &quot;A String&quot;,
448 },
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700449 &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-bot44a67192021-05-02 03:48:02 -0700450 &quot;a_key&quot;: { # MembershipFeatureSpec contains configuration information for a single Membership.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700451 &quot;configmanagement&quot;: { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700452 &quot;binauthz&quot;: { # Configuration for Binauthz # Binauthz conifguration for the cluster.
453 &quot;enabled&quot;: True or False, # Whether binauthz is enabled in this cluster.
454 },
455 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
456 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
457 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
458 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
459 &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.
460 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
461 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
462 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
463 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
464 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
465 },
466 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
467 },
468 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
469 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
470 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
471 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
472 },
473 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
474 &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.
475 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
476 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
477 &quot;A String&quot;,
478 ],
479 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
480 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
481 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
482 },
483 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
484 },
yoshi-code-bot96afc042021-08-24 00:22:31 -0700485 &quot;identityservice&quot;: { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
486 &quot;authMethods&quot;: [ # A member may support multiple auth methods.
487 { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
488 &quot;name&quot;: &quot;A String&quot;, # Identifier for auth config.
489 &quot;oidcConfig&quot;: { # Configuration for OIDC Auth flow. # OIDC specific configuration.
490 &quot;certificateAuthorityData&quot;: &quot;A String&quot;, # PEM-encoded CA for OIDC provider.
491 &quot;clientId&quot;: &quot;A String&quot;, # ID for OIDC client application.
492 &quot;deployCloudConsoleProxy&quot;: True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
493 &quot;extraParams&quot;: &quot;A String&quot;, # Comma-separated list of key-value pairs.
494 &quot;groupPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to group name.
495 &quot;groupsClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds group information.
496 &quot;issuerUri&quot;: &quot;A String&quot;, # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
497 &quot;kubectlRedirectUri&quot;: &quot;A String&quot;, # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
498 &quot;scopes&quot;: &quot;A String&quot;, # Comma-separated list of identifiers.
499 &quot;userClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds username.
500 &quot;userPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to user name.
501 },
502 &quot;proxy&quot;: &quot;A String&quot;, # Proxy server address to use for auth method.
503 },
504 ],
505 },
yoshi-code-bot44a67192021-05-02 03:48:02 -0700506 },
507 },
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700508 &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-bot44a67192021-05-02 03:48:02 -0700509 &quot;a_key&quot;: { # MembershipFeatureState contains Feature status information for a single Membership.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700510 &quot;configmanagement&quot;: { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700511 &quot;binauthzState&quot;: { # State for Binauthz # Binauthz status
512 &quot;version&quot;: { # The version of binauthz. # The version of binauthz that is installed.
513 &quot;webhookVersion&quot;: &quot;A String&quot;, # The version of the binauthz webhook.
514 },
515 &quot;webhook&quot;: &quot;A String&quot;, # The state of the binauthz webhook.
516 },
517 &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.
518 &quot;configSyncState&quot;: { # State information for ConfigSync # Current sync status
519 &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
520 &quot;gitSync&quot;: &quot;A String&quot;, # Deployment state of the git-sync pod
521 &quot;importer&quot;: &quot;A String&quot;, # Deployment state of the importer pod
522 &quot;monitor&quot;: &quot;A String&quot;, # Deployment state of the monitor pod
523 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Deployment state of reconciler-manager pod
524 &quot;rootReconciler&quot;: &quot;A String&quot;, # Deployment state of root-reconciler
525 &quot;syncer&quot;: &quot;A String&quot;, # Deployment state of the syncer pod
526 },
527 &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
528 &quot;code&quot;: &quot;A String&quot;, # Sync status code
529 &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.
530 { # An ACM created error representing a problem syncing configurations
531 &quot;code&quot;: &quot;A String&quot;, # An ACM defined error code
532 &quot;errorMessage&quot;: &quot;A String&quot;, # A description of the error
533 &quot;errorResources&quot;: [ # A list of config(s) associated with the error, if any
534 { # Model for a config file in the git repo with an associated Sync error
535 &quot;resourceGvk&quot;: { # A Kubernetes object&#x27;s GVK # Group/version/kind of the resource that is causing an error
536 &quot;group&quot;: &quot;A String&quot;, # Kubernetes Group
537 &quot;kind&quot;: &quot;A String&quot;, # Kubernetes Kind
538 &quot;version&quot;: &quot;A String&quot;, # Kubernetes Version
539 },
540 &quot;resourceName&quot;: &quot;A String&quot;, # Metadata name of the resource that is causing an error
541 &quot;resourceNamespace&quot;: &quot;A String&quot;, # Namespace of the resource that is causing an error
542 &quot;sourcePath&quot;: &quot;A String&quot;, # Path in the git repo of the erroneous config
543 },
544 ],
545 },
546 ],
547 &quot;importToken&quot;: &quot;A String&quot;, # Token indicating the state of the importer.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700548 &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-bot44a67192021-05-02 03:48:02 -0700549 &quot;lastSyncTime&quot;: &quot;A String&quot;, # Timestamp type of when ACM last successfully synced the repo
550 &quot;sourceToken&quot;: &quot;A String&quot;, # Token indicating the state of the repo.
551 &quot;syncToken&quot;: &quot;A String&quot;, # Token indicating the state of the syncer.
552 },
553 &quot;version&quot;: { # Specific versioning information pertaining to ConfigSync&#x27;s Pods # The version of ConfigSync deployed
554 &quot;gitSync&quot;: &quot;A String&quot;, # Version of the deployed git-sync pod
555 &quot;importer&quot;: &quot;A String&quot;, # Version of the deployed importer pod
556 &quot;monitor&quot;: &quot;A String&quot;, # Version of the deployed monitor pod
557 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Version of the deployed reconciler-manager pod
558 &quot;rootReconciler&quot;: &quot;A String&quot;, # Version of the deployed reconciler container in root-reconciler pod
559 &quot;syncer&quot;: &quot;A String&quot;, # Version of the deployed syncer pod
560 },
561 },
562 &quot;hierarchyControllerState&quot;: { # State for Hierarchy Controller # Hierarchy Controller status
563 &quot;state&quot;: { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
564 &quot;extension&quot;: &quot;A String&quot;, # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
565 &quot;hnc&quot;: &quot;A String&quot;, # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
566 },
567 &quot;version&quot;: { # Version for Hierarchy Controller # The version for Hierarchy Controller
568 &quot;extension&quot;: &quot;A String&quot;, # Version for Hierarchy Controller extension
569 &quot;hnc&quot;: &quot;A String&quot;, # Version for open source HNC
570 },
571 },
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700572 &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
yoshi-code-bot44a67192021-05-02 03:48:02 -0700573 &quot;binauthz&quot;: { # Configuration for Binauthz # Binauthz conifguration for the cluster.
574 &quot;enabled&quot;: True or False, # Whether binauthz is enabled in this cluster.
575 },
576 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
577 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
578 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
579 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
580 &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.
581 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
582 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
583 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
584 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
585 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
586 },
587 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
588 },
589 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
590 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
591 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
592 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
593 },
594 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
595 &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.
596 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
597 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
598 &quot;A String&quot;,
599 ],
600 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
601 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
602 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
603 },
604 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
605 },
606 &quot;operatorState&quot;: { # State information for an ACM&#x27;s Operator # Current install status of ACM&#x27;s Operator
607 &quot;deploymentState&quot;: &quot;A String&quot;, # The state of the Operator&#x27;s deployment
608 &quot;errors&quot;: [ # Install errors.
609 { # Errors pertaining to the installation of ACM
610 &quot;errorMessage&quot;: &quot;A String&quot;, # A string representing the user facing error message
611 },
612 ],
613 &quot;version&quot;: &quot;A String&quot;, # The semenatic version number of the operator
614 },
615 &quot;policyControllerState&quot;: { # State for PolicyControllerState. # PolicyController status
616 &quot;deploymentState&quot;: { # State of Policy Controller installation. # The state about the policy controller installation.
617 &quot;gatekeeperAudit&quot;: &quot;A String&quot;, # Status of gatekeeper-audit deployment.
618 &quot;gatekeeperControllerManagerState&quot;: &quot;A String&quot;, # Status of gatekeeper-controller-manager pod.
619 },
620 &quot;version&quot;: { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
621 &quot;version&quot;: &quot;A String&quot;, # The gatekeeper image tag that is composed of ACM version, git tag, build number.
622 },
623 },
624 },
yoshi-code-bot96afc042021-08-24 00:22:31 -0700625 &quot;identityservice&quot;: { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.
626 &quot;failureReason&quot;: &quot;A String&quot;, # The reason of the failure.
627 &quot;installedVersion&quot;: &quot;A String&quot;, # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.
628 &quot;memberConfig&quot;: { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration
629 &quot;authMethods&quot;: [ # A member may support multiple auth methods.
630 { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
631 &quot;name&quot;: &quot;A String&quot;, # Identifier for auth config.
632 &quot;oidcConfig&quot;: { # Configuration for OIDC Auth flow. # OIDC specific configuration.
633 &quot;certificateAuthorityData&quot;: &quot;A String&quot;, # PEM-encoded CA for OIDC provider.
634 &quot;clientId&quot;: &quot;A String&quot;, # ID for OIDC client application.
635 &quot;deployCloudConsoleProxy&quot;: True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
636 &quot;extraParams&quot;: &quot;A String&quot;, # Comma-separated list of key-value pairs.
637 &quot;groupPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to group name.
638 &quot;groupsClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds group information.
639 &quot;issuerUri&quot;: &quot;A String&quot;, # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
640 &quot;kubectlRedirectUri&quot;: &quot;A String&quot;, # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
641 &quot;scopes&quot;: &quot;A String&quot;, # Comma-separated list of identifiers.
642 &quot;userClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds username.
643 &quot;userPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to user name.
644 },
645 &quot;proxy&quot;: &quot;A String&quot;, # Proxy server address to use for auth method.
646 },
647 ],
648 },
649 &quot;state&quot;: &quot;A String&quot;, # Deployment state on this member
650 },
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700651 &quot;metering&quot;: { # **Metering**: Per-Membership Feature State. # Metering-specific spec.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700652 &quot;lastMeasurementTime&quot;: &quot;A String&quot;, # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
653 &quot;preciseLastMeasuredClusterVcpuCapacity&quot;: 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
654 },
655 &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.
656 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
657 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
658 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
659 },
660 },
661 },
662 &quot;name&quot;: &quot;A String&quot;, # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
663 &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.
664 &quot;state&quot;: &quot;A String&quot;, # The current state of the Feature resource in the Hub API.
665 },
666 &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.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700667 &quot;multiclusteringress&quot;: { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700668 &quot;billing&quot;: &quot;A String&quot;, # Deprecated: This field will be ignored and should not be set. Customer&#x27;s billing structure.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700669 &quot;configMembership&quot;: &quot;A String&quot;, # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
670 },
671 },
672 &quot;state&quot;: { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
673 &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.
674 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
675 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
676 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
677 },
678 },
679 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was last updated.
680}</pre>
681</div>
682
683<div class="method">
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400684 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
685 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
686
687Args:
688 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
689 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).
690 x__xgafv: string, V1 error format.
691 Allowed values
692 1 - v1 error format
693 2 - v2 error format
694
695Returns:
696 An object of the form:
697
yoshi-code-bot96afc042021-08-24 00:22:31 -0700698 { # 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/).
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400699 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
700 { # 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.
701 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
702 { # 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.
703 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
704 &quot;A String&quot;,
705 ],
706 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
707 },
708 ],
709 &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.
710 },
711 ],
712 &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.
713 { # Associates `members` with a `role`.
714 &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).
715 &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.
716 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
717 &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.
718 &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.
719 },
720 &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`.
721 &quot;A String&quot;,
722 ],
723 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
724 },
725 ],
726 &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.
727 &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).
728}</pre>
729</div>
730
731<div class="method">
yoshi-code-bot44a67192021-05-02 03:48:02 -0700732 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
733 <pre>Lists Features in a given project and location.
734
735Args:
736 parent: string, The parent (project and location) where the Features will be listed. Specified in the format `projects/*/locations/*`. (required)
737 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
738 orderBy: string, One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
739 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.
740 pageToken: string, Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources.
741 x__xgafv: string, V1 error format.
742 Allowed values
743 1 - v1 error format
744 2 - v2 error format
745
746Returns:
747 An object of the form:
748
749 { # Response message for the `GkeHub.ListFeatures` method.
750 &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.
751 &quot;resources&quot;: [ # The list of matching Features
752 { # Feature represents the settings and status of any Hub Feature.
753 &quot;createTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was created.
754 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was deleted.
755 &quot;labels&quot;: { # GCP labels for this Feature.
756 &quot;a_key&quot;: &quot;A String&quot;,
757 },
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700758 &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-bot44a67192021-05-02 03:48:02 -0700759 &quot;a_key&quot;: { # MembershipFeatureSpec contains configuration information for a single Membership.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700760 &quot;configmanagement&quot;: { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700761 &quot;binauthz&quot;: { # Configuration for Binauthz # Binauthz conifguration for the cluster.
762 &quot;enabled&quot;: True or False, # Whether binauthz is enabled in this cluster.
763 },
764 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
765 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
766 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
767 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
768 &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.
769 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
770 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
771 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
772 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
773 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
774 },
775 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
776 },
777 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
778 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
779 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
780 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
781 },
782 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
783 &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.
784 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
785 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
786 &quot;A String&quot;,
787 ],
788 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
789 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
790 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
791 },
792 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
793 },
yoshi-code-bot96afc042021-08-24 00:22:31 -0700794 &quot;identityservice&quot;: { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
795 &quot;authMethods&quot;: [ # A member may support multiple auth methods.
796 { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
797 &quot;name&quot;: &quot;A String&quot;, # Identifier for auth config.
798 &quot;oidcConfig&quot;: { # Configuration for OIDC Auth flow. # OIDC specific configuration.
799 &quot;certificateAuthorityData&quot;: &quot;A String&quot;, # PEM-encoded CA for OIDC provider.
800 &quot;clientId&quot;: &quot;A String&quot;, # ID for OIDC client application.
801 &quot;deployCloudConsoleProxy&quot;: True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
802 &quot;extraParams&quot;: &quot;A String&quot;, # Comma-separated list of key-value pairs.
803 &quot;groupPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to group name.
804 &quot;groupsClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds group information.
805 &quot;issuerUri&quot;: &quot;A String&quot;, # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
806 &quot;kubectlRedirectUri&quot;: &quot;A String&quot;, # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
807 &quot;scopes&quot;: &quot;A String&quot;, # Comma-separated list of identifiers.
808 &quot;userClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds username.
809 &quot;userPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to user name.
810 },
811 &quot;proxy&quot;: &quot;A String&quot;, # Proxy server address to use for auth method.
812 },
813 ],
814 },
yoshi-code-bot44a67192021-05-02 03:48:02 -0700815 },
816 },
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700817 &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-bot44a67192021-05-02 03:48:02 -0700818 &quot;a_key&quot;: { # MembershipFeatureState contains Feature status information for a single Membership.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700819 &quot;configmanagement&quot;: { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700820 &quot;binauthzState&quot;: { # State for Binauthz # Binauthz status
821 &quot;version&quot;: { # The version of binauthz. # The version of binauthz that is installed.
822 &quot;webhookVersion&quot;: &quot;A String&quot;, # The version of the binauthz webhook.
823 },
824 &quot;webhook&quot;: &quot;A String&quot;, # The state of the binauthz webhook.
825 },
826 &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.
827 &quot;configSyncState&quot;: { # State information for ConfigSync # Current sync status
828 &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
829 &quot;gitSync&quot;: &quot;A String&quot;, # Deployment state of the git-sync pod
830 &quot;importer&quot;: &quot;A String&quot;, # Deployment state of the importer pod
831 &quot;monitor&quot;: &quot;A String&quot;, # Deployment state of the monitor pod
832 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Deployment state of reconciler-manager pod
833 &quot;rootReconciler&quot;: &quot;A String&quot;, # Deployment state of root-reconciler
834 &quot;syncer&quot;: &quot;A String&quot;, # Deployment state of the syncer pod
835 },
836 &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
837 &quot;code&quot;: &quot;A String&quot;, # Sync status code
838 &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.
839 { # An ACM created error representing a problem syncing configurations
840 &quot;code&quot;: &quot;A String&quot;, # An ACM defined error code
841 &quot;errorMessage&quot;: &quot;A String&quot;, # A description of the error
842 &quot;errorResources&quot;: [ # A list of config(s) associated with the error, if any
843 { # Model for a config file in the git repo with an associated Sync error
844 &quot;resourceGvk&quot;: { # A Kubernetes object&#x27;s GVK # Group/version/kind of the resource that is causing an error
845 &quot;group&quot;: &quot;A String&quot;, # Kubernetes Group
846 &quot;kind&quot;: &quot;A String&quot;, # Kubernetes Kind
847 &quot;version&quot;: &quot;A String&quot;, # Kubernetes Version
848 },
849 &quot;resourceName&quot;: &quot;A String&quot;, # Metadata name of the resource that is causing an error
850 &quot;resourceNamespace&quot;: &quot;A String&quot;, # Namespace of the resource that is causing an error
851 &quot;sourcePath&quot;: &quot;A String&quot;, # Path in the git repo of the erroneous config
852 },
853 ],
854 },
855 ],
856 &quot;importToken&quot;: &quot;A String&quot;, # Token indicating the state of the importer.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700857 &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-bot44a67192021-05-02 03:48:02 -0700858 &quot;lastSyncTime&quot;: &quot;A String&quot;, # Timestamp type of when ACM last successfully synced the repo
859 &quot;sourceToken&quot;: &quot;A String&quot;, # Token indicating the state of the repo.
860 &quot;syncToken&quot;: &quot;A String&quot;, # Token indicating the state of the syncer.
861 },
862 &quot;version&quot;: { # Specific versioning information pertaining to ConfigSync&#x27;s Pods # The version of ConfigSync deployed
863 &quot;gitSync&quot;: &quot;A String&quot;, # Version of the deployed git-sync pod
864 &quot;importer&quot;: &quot;A String&quot;, # Version of the deployed importer pod
865 &quot;monitor&quot;: &quot;A String&quot;, # Version of the deployed monitor pod
866 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Version of the deployed reconciler-manager pod
867 &quot;rootReconciler&quot;: &quot;A String&quot;, # Version of the deployed reconciler container in root-reconciler pod
868 &quot;syncer&quot;: &quot;A String&quot;, # Version of the deployed syncer pod
869 },
870 },
871 &quot;hierarchyControllerState&quot;: { # State for Hierarchy Controller # Hierarchy Controller status
872 &quot;state&quot;: { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
873 &quot;extension&quot;: &quot;A String&quot;, # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
874 &quot;hnc&quot;: &quot;A String&quot;, # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
875 },
876 &quot;version&quot;: { # Version for Hierarchy Controller # The version for Hierarchy Controller
877 &quot;extension&quot;: &quot;A String&quot;, # Version for Hierarchy Controller extension
878 &quot;hnc&quot;: &quot;A String&quot;, # Version for open source HNC
879 },
880 },
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700881 &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
yoshi-code-bot44a67192021-05-02 03:48:02 -0700882 &quot;binauthz&quot;: { # Configuration for Binauthz # Binauthz conifguration for the cluster.
883 &quot;enabled&quot;: True or False, # Whether binauthz is enabled in this cluster.
884 },
885 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
886 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
887 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
888 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
889 &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.
890 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
891 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
892 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
893 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
894 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
895 },
896 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
897 },
898 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
899 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
900 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
901 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
902 },
903 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
904 &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.
905 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
906 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
907 &quot;A String&quot;,
908 ],
909 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
910 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
911 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
912 },
913 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
914 },
915 &quot;operatorState&quot;: { # State information for an ACM&#x27;s Operator # Current install status of ACM&#x27;s Operator
916 &quot;deploymentState&quot;: &quot;A String&quot;, # The state of the Operator&#x27;s deployment
917 &quot;errors&quot;: [ # Install errors.
918 { # Errors pertaining to the installation of ACM
919 &quot;errorMessage&quot;: &quot;A String&quot;, # A string representing the user facing error message
920 },
921 ],
922 &quot;version&quot;: &quot;A String&quot;, # The semenatic version number of the operator
923 },
924 &quot;policyControllerState&quot;: { # State for PolicyControllerState. # PolicyController status
925 &quot;deploymentState&quot;: { # State of Policy Controller installation. # The state about the policy controller installation.
926 &quot;gatekeeperAudit&quot;: &quot;A String&quot;, # Status of gatekeeper-audit deployment.
927 &quot;gatekeeperControllerManagerState&quot;: &quot;A String&quot;, # Status of gatekeeper-controller-manager pod.
928 },
929 &quot;version&quot;: { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
930 &quot;version&quot;: &quot;A String&quot;, # The gatekeeper image tag that is composed of ACM version, git tag, build number.
931 },
932 },
933 },
yoshi-code-bot96afc042021-08-24 00:22:31 -0700934 &quot;identityservice&quot;: { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.
935 &quot;failureReason&quot;: &quot;A String&quot;, # The reason of the failure.
936 &quot;installedVersion&quot;: &quot;A String&quot;, # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.
937 &quot;memberConfig&quot;: { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration
938 &quot;authMethods&quot;: [ # A member may support multiple auth methods.
939 { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
940 &quot;name&quot;: &quot;A String&quot;, # Identifier for auth config.
941 &quot;oidcConfig&quot;: { # Configuration for OIDC Auth flow. # OIDC specific configuration.
942 &quot;certificateAuthorityData&quot;: &quot;A String&quot;, # PEM-encoded CA for OIDC provider.
943 &quot;clientId&quot;: &quot;A String&quot;, # ID for OIDC client application.
944 &quot;deployCloudConsoleProxy&quot;: True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
945 &quot;extraParams&quot;: &quot;A String&quot;, # Comma-separated list of key-value pairs.
946 &quot;groupPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to group name.
947 &quot;groupsClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds group information.
948 &quot;issuerUri&quot;: &quot;A String&quot;, # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
949 &quot;kubectlRedirectUri&quot;: &quot;A String&quot;, # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
950 &quot;scopes&quot;: &quot;A String&quot;, # Comma-separated list of identifiers.
951 &quot;userClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds username.
952 &quot;userPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to user name.
953 },
954 &quot;proxy&quot;: &quot;A String&quot;, # Proxy server address to use for auth method.
955 },
956 ],
957 },
958 &quot;state&quot;: &quot;A String&quot;, # Deployment state on this member
959 },
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700960 &quot;metering&quot;: { # **Metering**: Per-Membership Feature State. # Metering-specific spec.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700961 &quot;lastMeasurementTime&quot;: &quot;A String&quot;, # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
962 &quot;preciseLastMeasuredClusterVcpuCapacity&quot;: 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
963 },
964 &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.
965 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
966 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
967 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
968 },
969 },
970 },
971 &quot;name&quot;: &quot;A String&quot;, # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
972 &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.
973 &quot;state&quot;: &quot;A String&quot;, # The current state of the Feature resource in the Hub API.
974 },
975 &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.
yoshi-code-botc2cd3262021-05-16 02:16:04 -0700976 &quot;multiclusteringress&quot;: { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700977 &quot;billing&quot;: &quot;A String&quot;, # Deprecated: This field will be ignored and should not be set. Customer&#x27;s billing structure.
yoshi-code-bot44a67192021-05-02 03:48:02 -0700978 &quot;configMembership&quot;: &quot;A String&quot;, # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
979 },
980 },
981 &quot;state&quot;: { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
982 &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.
983 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
984 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
985 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
986 },
987 },
988 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was last updated.
989 },
990 ],
991}</pre>
992</div>
993
994<div class="method">
995 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
996 <pre>Retrieves the next page of results.
997
998Args:
999 previous_request: The request for the previous page. (required)
1000 previous_response: The response from the request for the previous page. (required)
1001
1002Returns:
1003 A request object that you can call &#x27;execute()&#x27; on to request the next
1004 page. Returns None if there are no more items in the collection.
1005 </pre>
1006</div>
1007
1008<div class="method">
1009 <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
1010 <pre>Updates an existing Feature.
1011
1012Args:
1013 name: string, The Feature resource name in the format `projects/*/locations/*/features/*`. (required)
1014 body: object, The request body.
1015 The object takes the form of:
1016
1017{ # Feature represents the settings and status of any Hub Feature.
1018 &quot;createTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was created.
1019 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was deleted.
1020 &quot;labels&quot;: { # GCP labels for this Feature.
1021 &quot;a_key&quot;: &quot;A String&quot;,
1022 },
yoshi-code-bot1a4514d2021-07-13 00:20:24 -07001023 &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-bot44a67192021-05-02 03:48:02 -07001024 &quot;a_key&quot;: { # MembershipFeatureSpec contains configuration information for a single Membership.
yoshi-code-botc2cd3262021-05-16 02:16:04 -07001025 &quot;configmanagement&quot;: { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
yoshi-code-bot44a67192021-05-02 03:48:02 -07001026 &quot;binauthz&quot;: { # Configuration for Binauthz # Binauthz conifguration for the cluster.
1027 &quot;enabled&quot;: True or False, # Whether binauthz is enabled in this cluster.
1028 },
1029 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
1030 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
1031 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
1032 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
1033 &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.
1034 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
1035 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
1036 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
1037 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
1038 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
1039 },
1040 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
1041 },
1042 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
1043 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
1044 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
1045 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
1046 },
1047 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
1048 &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.
1049 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
1050 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
1051 &quot;A String&quot;,
1052 ],
1053 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
1054 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
1055 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
1056 },
1057 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
1058 },
yoshi-code-bot96afc042021-08-24 00:22:31 -07001059 &quot;identityservice&quot;: { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
1060 &quot;authMethods&quot;: [ # A member may support multiple auth methods.
1061 { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
1062 &quot;name&quot;: &quot;A String&quot;, # Identifier for auth config.
1063 &quot;oidcConfig&quot;: { # Configuration for OIDC Auth flow. # OIDC specific configuration.
1064 &quot;certificateAuthorityData&quot;: &quot;A String&quot;, # PEM-encoded CA for OIDC provider.
1065 &quot;clientId&quot;: &quot;A String&quot;, # ID for OIDC client application.
1066 &quot;deployCloudConsoleProxy&quot;: True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
1067 &quot;extraParams&quot;: &quot;A String&quot;, # Comma-separated list of key-value pairs.
1068 &quot;groupPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to group name.
1069 &quot;groupsClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds group information.
1070 &quot;issuerUri&quot;: &quot;A String&quot;, # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
1071 &quot;kubectlRedirectUri&quot;: &quot;A String&quot;, # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
1072 &quot;scopes&quot;: &quot;A String&quot;, # Comma-separated list of identifiers.
1073 &quot;userClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds username.
1074 &quot;userPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to user name.
1075 },
1076 &quot;proxy&quot;: &quot;A String&quot;, # Proxy server address to use for auth method.
1077 },
1078 ],
1079 },
yoshi-code-bot44a67192021-05-02 03:48:02 -07001080 },
1081 },
yoshi-code-bot1a4514d2021-07-13 00:20:24 -07001082 &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-bot44a67192021-05-02 03:48:02 -07001083 &quot;a_key&quot;: { # MembershipFeatureState contains Feature status information for a single Membership.
yoshi-code-botc2cd3262021-05-16 02:16:04 -07001084 &quot;configmanagement&quot;: { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
yoshi-code-bot44a67192021-05-02 03:48:02 -07001085 &quot;binauthzState&quot;: { # State for Binauthz # Binauthz status
1086 &quot;version&quot;: { # The version of binauthz. # The version of binauthz that is installed.
1087 &quot;webhookVersion&quot;: &quot;A String&quot;, # The version of the binauthz webhook.
1088 },
1089 &quot;webhook&quot;: &quot;A String&quot;, # The state of the binauthz webhook.
1090 },
1091 &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.
1092 &quot;configSyncState&quot;: { # State information for ConfigSync # Current sync status
1093 &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
1094 &quot;gitSync&quot;: &quot;A String&quot;, # Deployment state of the git-sync pod
1095 &quot;importer&quot;: &quot;A String&quot;, # Deployment state of the importer pod
1096 &quot;monitor&quot;: &quot;A String&quot;, # Deployment state of the monitor pod
1097 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Deployment state of reconciler-manager pod
1098 &quot;rootReconciler&quot;: &quot;A String&quot;, # Deployment state of root-reconciler
1099 &quot;syncer&quot;: &quot;A String&quot;, # Deployment state of the syncer pod
1100 },
1101 &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
1102 &quot;code&quot;: &quot;A String&quot;, # Sync status code
1103 &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.
1104 { # An ACM created error representing a problem syncing configurations
1105 &quot;code&quot;: &quot;A String&quot;, # An ACM defined error code
1106 &quot;errorMessage&quot;: &quot;A String&quot;, # A description of the error
1107 &quot;errorResources&quot;: [ # A list of config(s) associated with the error, if any
1108 { # Model for a config file in the git repo with an associated Sync error
1109 &quot;resourceGvk&quot;: { # A Kubernetes object&#x27;s GVK # Group/version/kind of the resource that is causing an error
1110 &quot;group&quot;: &quot;A String&quot;, # Kubernetes Group
1111 &quot;kind&quot;: &quot;A String&quot;, # Kubernetes Kind
1112 &quot;version&quot;: &quot;A String&quot;, # Kubernetes Version
1113 },
1114 &quot;resourceName&quot;: &quot;A String&quot;, # Metadata name of the resource that is causing an error
1115 &quot;resourceNamespace&quot;: &quot;A String&quot;, # Namespace of the resource that is causing an error
1116 &quot;sourcePath&quot;: &quot;A String&quot;, # Path in the git repo of the erroneous config
1117 },
1118 ],
1119 },
1120 ],
1121 &quot;importToken&quot;: &quot;A String&quot;, # Token indicating the state of the importer.
yoshi-code-bot04bafe12021-06-29 00:20:25 -07001122 &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-bot44a67192021-05-02 03:48:02 -07001123 &quot;lastSyncTime&quot;: &quot;A String&quot;, # Timestamp type of when ACM last successfully synced the repo
1124 &quot;sourceToken&quot;: &quot;A String&quot;, # Token indicating the state of the repo.
1125 &quot;syncToken&quot;: &quot;A String&quot;, # Token indicating the state of the syncer.
1126 },
1127 &quot;version&quot;: { # Specific versioning information pertaining to ConfigSync&#x27;s Pods # The version of ConfigSync deployed
1128 &quot;gitSync&quot;: &quot;A String&quot;, # Version of the deployed git-sync pod
1129 &quot;importer&quot;: &quot;A String&quot;, # Version of the deployed importer pod
1130 &quot;monitor&quot;: &quot;A String&quot;, # Version of the deployed monitor pod
1131 &quot;reconcilerManager&quot;: &quot;A String&quot;, # Version of the deployed reconciler-manager pod
1132 &quot;rootReconciler&quot;: &quot;A String&quot;, # Version of the deployed reconciler container in root-reconciler pod
1133 &quot;syncer&quot;: &quot;A String&quot;, # Version of the deployed syncer pod
1134 },
1135 },
1136 &quot;hierarchyControllerState&quot;: { # State for Hierarchy Controller # Hierarchy Controller status
1137 &quot;state&quot;: { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
1138 &quot;extension&quot;: &quot;A String&quot;, # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
1139 &quot;hnc&quot;: &quot;A String&quot;, # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
1140 },
1141 &quot;version&quot;: { # Version for Hierarchy Controller # The version for Hierarchy Controller
1142 &quot;extension&quot;: &quot;A String&quot;, # Version for Hierarchy Controller extension
1143 &quot;hnc&quot;: &quot;A String&quot;, # Version for open source HNC
1144 },
1145 },
yoshi-code-botc2cd3262021-05-16 02:16:04 -07001146 &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
yoshi-code-bot44a67192021-05-02 03:48:02 -07001147 &quot;binauthz&quot;: { # Configuration for Binauthz # Binauthz conifguration for the cluster.
1148 &quot;enabled&quot;: True or False, # Whether binauthz is enabled in this cluster.
1149 },
1150 &quot;configSync&quot;: { # Configuration for Config Sync # Config Sync configuration for the cluster.
1151 &quot;git&quot;: { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
1152 &quot;gcpServiceAccountEmail&quot;: &quot;A String&quot;, # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
1153 &quot;httpsProxy&quot;: &quot;A String&quot;, # URL for the HTTPS proxy to be used when communicating with the Git repo.
1154 &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.
1155 &quot;secretType&quot;: &quot;A String&quot;, # Type of secret configured for access to the Git repo.
1156 &quot;syncBranch&quot;: &quot;A String&quot;, # The branch of the repository to sync from. Default: master.
1157 &quot;syncRepo&quot;: &quot;A String&quot;, # The URL of the Git repository to use as the source of truth.
1158 &quot;syncRev&quot;: &quot;A String&quot;, # Git revision (tag or hash) to check out. Default HEAD.
1159 &quot;syncWaitSecs&quot;: &quot;A String&quot;, # Period in seconds between consecutive syncs. Default: 15.
1160 },
1161 &quot;sourceFormat&quot;: &quot;A String&quot;, # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
1162 },
1163 &quot;hierarchyController&quot;: { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
1164 &quot;enableHierarchicalResourceQuota&quot;: True or False, # Whether hierarchical resource quota is enabled in this cluster.
1165 &quot;enablePodTreeLabels&quot;: True or False, # Whether pod tree labels are enabled in this cluster.
1166 &quot;enabled&quot;: True or False, # Whether Hierarchy Controller is enabled in this cluster.
1167 },
1168 &quot;policyController&quot;: { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
1169 &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.
1170 &quot;enabled&quot;: True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
1171 &quot;exemptableNamespaces&quot;: [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
1172 &quot;A String&quot;,
1173 ],
1174 &quot;logDeniesEnabled&quot;: True or False, # Logs all denies and dry run failures.
1175 &quot;referentialRulesEnabled&quot;: True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
1176 &quot;templateLibraryInstalled&quot;: True or False, # Installs the default template library along with Policy Controller.
1177 },
1178 &quot;version&quot;: &quot;A String&quot;, # Version of ACM installed.
1179 },
1180 &quot;operatorState&quot;: { # State information for an ACM&#x27;s Operator # Current install status of ACM&#x27;s Operator
1181 &quot;deploymentState&quot;: &quot;A String&quot;, # The state of the Operator&#x27;s deployment
1182 &quot;errors&quot;: [ # Install errors.
1183 { # Errors pertaining to the installation of ACM
1184 &quot;errorMessage&quot;: &quot;A String&quot;, # A string representing the user facing error message
1185 },
1186 ],
1187 &quot;version&quot;: &quot;A String&quot;, # The semenatic version number of the operator
1188 },
1189 &quot;policyControllerState&quot;: { # State for PolicyControllerState. # PolicyController status
1190 &quot;deploymentState&quot;: { # State of Policy Controller installation. # The state about the policy controller installation.
1191 &quot;gatekeeperAudit&quot;: &quot;A String&quot;, # Status of gatekeeper-audit deployment.
1192 &quot;gatekeeperControllerManagerState&quot;: &quot;A String&quot;, # Status of gatekeeper-controller-manager pod.
1193 },
1194 &quot;version&quot;: { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
1195 &quot;version&quot;: &quot;A String&quot;, # The gatekeeper image tag that is composed of ACM version, git tag, build number.
1196 },
1197 },
1198 },
yoshi-code-bot96afc042021-08-24 00:22:31 -07001199 &quot;identityservice&quot;: { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.
1200 &quot;failureReason&quot;: &quot;A String&quot;, # The reason of the failure.
1201 &quot;installedVersion&quot;: &quot;A String&quot;, # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.
1202 &quot;memberConfig&quot;: { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration
1203 &quot;authMethods&quot;: [ # A member may support multiple auth methods.
1204 { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
1205 &quot;name&quot;: &quot;A String&quot;, # Identifier for auth config.
1206 &quot;oidcConfig&quot;: { # Configuration for OIDC Auth flow. # OIDC specific configuration.
1207 &quot;certificateAuthorityData&quot;: &quot;A String&quot;, # PEM-encoded CA for OIDC provider.
1208 &quot;clientId&quot;: &quot;A String&quot;, # ID for OIDC client application.
1209 &quot;deployCloudConsoleProxy&quot;: True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
1210 &quot;extraParams&quot;: &quot;A String&quot;, # Comma-separated list of key-value pairs.
1211 &quot;groupPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to group name.
1212 &quot;groupsClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds group information.
1213 &quot;issuerUri&quot;: &quot;A String&quot;, # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
1214 &quot;kubectlRedirectUri&quot;: &quot;A String&quot;, # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
1215 &quot;scopes&quot;: &quot;A String&quot;, # Comma-separated list of identifiers.
1216 &quot;userClaim&quot;: &quot;A String&quot;, # Claim in OIDC ID token that holds username.
1217 &quot;userPrefix&quot;: &quot;A String&quot;, # Prefix to prepend to user name.
1218 },
1219 &quot;proxy&quot;: &quot;A String&quot;, # Proxy server address to use for auth method.
1220 },
1221 ],
1222 },
1223 &quot;state&quot;: &quot;A String&quot;, # Deployment state on this member
1224 },
yoshi-code-botc2cd3262021-05-16 02:16:04 -07001225 &quot;metering&quot;: { # **Metering**: Per-Membership Feature State. # Metering-specific spec.
yoshi-code-bot44a67192021-05-02 03:48:02 -07001226 &quot;lastMeasurementTime&quot;: &quot;A String&quot;, # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
1227 &quot;preciseLastMeasuredClusterVcpuCapacity&quot;: 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
1228 },
1229 &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.
1230 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
1231 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
1232 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
1233 },
1234 },
1235 },
1236 &quot;name&quot;: &quot;A String&quot;, # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.
1237 &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.
1238 &quot;state&quot;: &quot;A String&quot;, # The current state of the Feature resource in the Hub API.
1239 },
1240 &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.
yoshi-code-botc2cd3262021-05-16 02:16:04 -07001241 &quot;multiclusteringress&quot;: { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
yoshi-code-bot1a4514d2021-07-13 00:20:24 -07001242 &quot;billing&quot;: &quot;A String&quot;, # Deprecated: This field will be ignored and should not be set. Customer&#x27;s billing structure.
yoshi-code-bot44a67192021-05-02 03:48:02 -07001243 &quot;configMembership&quot;: &quot;A String&quot;, # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
1244 },
1245 },
1246 &quot;state&quot;: { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
1247 &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.
1248 &quot;code&quot;: &quot;A String&quot;, # The high-level, machine-readable status of this Feature.
1249 &quot;description&quot;: &quot;A String&quot;, # A human-readable description of the current status.
1250 &quot;updateTime&quot;: &quot;A String&quot;, # The time this status and any related Feature-specific details were updated.
1251 },
1252 },
1253 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When the Feature resource was last updated.
1254}
1255
1256 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).
1257 updateMask: string, Mask of fields to update.
1258 x__xgafv: string, V1 error format.
1259 Allowed values
1260 1 - v1 error format
1261 2 - v2 error format
1262
1263Returns:
1264 An object of the form:
1265
1266 { # This resource represents a long-running operation that is the result of a network API call.
1267 &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.
1268 &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.
1269 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1270 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1271 {
1272 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1273 },
1274 ],
1275 &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.
1276 },
1277 &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.
1278 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1279 },
1280 &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}`.
1281 &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`.
1282 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1283 },
1284}</pre>
1285</div>
1286
1287<div class="method">
Anthonios Partheniou10f4b672021-04-13 14:47:53 -04001288 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
1289 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
1290
1291Args:
1292 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
1293 body: object, The request body.
1294 The object takes the form of:
1295
1296{ # Request message for `SetIamPolicy` method.
yoshi-code-bot96afc042021-08-24 00:22:31 -07001297 &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.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -04001298 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1299 { # 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.
1300 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1301 { # 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.
1302 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
1303 &quot;A String&quot;,
1304 ],
1305 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1306 },
1307 ],
1308 &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.
1309 },
1310 ],
1311 &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.
1312 { # Associates `members` with a `role`.
1313 &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).
1314 &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.
1315 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1316 &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.
1317 &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.
1318 },
1319 &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`.
1320 &quot;A String&quot;,
1321 ],
1322 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1323 },
1324 ],
1325 &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.
1326 &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).
1327 },
1328 &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;`
1329}
1330
1331 x__xgafv: string, V1 error format.
1332 Allowed values
1333 1 - v1 error format
1334 2 - v2 error format
1335
1336Returns:
1337 An object of the form:
1338
yoshi-code-bot96afc042021-08-24 00:22:31 -07001339 { # 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/).
Anthonios Partheniou10f4b672021-04-13 14:47:53 -04001340 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1341 { # 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.
1342 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1343 { # 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.
1344 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
1345 &quot;A String&quot;,
1346 ],
1347 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1348 },
1349 ],
1350 &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.
1351 },
1352 ],
1353 &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.
1354 { # Associates `members` with a `role`.
1355 &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).
1356 &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.
1357 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1358 &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.
1359 &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.
1360 },
1361 &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`.
1362 &quot;A String&quot;,
1363 ],
1364 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1365 },
1366 ],
1367 &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.
1368 &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).
1369}</pre>
1370</div>
1371
1372<div class="method">
1373 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
1374 <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.
1375
1376Args:
1377 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)
1378 body: object, The request body.
1379 The object takes the form of:
1380
1381{ # Request message for `TestIamPermissions` method.
1382 &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).
1383 &quot;A String&quot;,
1384 ],
1385}
1386
1387 x__xgafv: string, V1 error format.
1388 Allowed values
1389 1 - v1 error format
1390 2 - v2 error format
1391
1392Returns:
1393 An object of the form:
1394
1395 { # Response message for `TestIamPermissions` method.
1396 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1397 &quot;A String&quot;,
1398 ],
1399}</pre>
1400</div>
1401
1402</body></html>