Blame - docs/dyn/gkehub_v1alpha.projects.locations.features.html - platform/external/python/google-api-python-client

2021-04-13 14:47:53 -0400

[diff] [blame]

76

<h2>Instance Methods</h2>

77

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

81

<code><a href="#create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Adds a new Feature.</p>

83

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

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

90

<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>

91

<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>

92

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

93

<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Lists Features in a given project and location.</p>

95

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

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

102

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

103

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>

104

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

109

<code class="details" id="close">close()</code>

110

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

114

<code class="details" id="create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</code>

115

<pre>Adds a new Feature.

116

117

Args:

118

parent: string, The parent (project and location) where the Feature will be created. Specified in the format `projects/*/locations/*`. (required)

119

body: object, The request body.

120

The object takes the form of:

121

122

{ # Feature represents the settings and status of any Hub Feature.

123

"createTime": "A String", # Output only. When the Feature resource was created.

124

"deleteTime": "A String", # Output only. When the Feature resource was deleted.

125

"labels": { # GCP labels for this Feature.

126

"a_key": "A String",

127

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

128

"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

129

"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

130

"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

131

"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.

132

"enabled": True or False, # Whether binauthz is enabled in this cluster.

133

},

134

"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.

135

"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.

136

"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.

137

"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.

138

"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.

139

"secretType": "A String", # Type of secret configured for access to the Git repo.

140

"syncBranch": "A String", # The branch of the repository to sync from. Default: master.

141

"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.

142

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.

143

"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.

144

},

145

"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.

146

},

147

"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.

148

"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.

149

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.

150

"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.

151

},

152

"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.

153

"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.

154

"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.

155

"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.

156

"A String",

157

],

158

"logDeniesEnabled": True or False, # Logs all denies and dry run failures.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

159

"mutationEnabled": True or False, # Enable users to try out mutation for PolicyController.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

160

"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.

161

"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.

162

},

163

"version": "A String", # Version of ACM installed.

164

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

165

"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.

166

"authMethods": [ # A member may support multiple auth methods.

167

{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.

168

"name": "A String", # Identifier for auth config.

169

"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.

170

"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.

171

"clientId": "A String", # ID for OIDC client application.

172

"deployCloudConsoleProxy": 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.

173

"extraParams": "A String", # Comma-separated list of key-value pairs.

174

"groupPrefix": "A String", # Prefix to prepend to group name.

175

"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.

176

"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.

177

"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.

178

"scopes": "A String", # Comma-separated list of identifiers.

179

"userClaim": "A String", # Claim in OIDC ID token that holds username.

180

"userPrefix": "A String", # Prefix to prepend to user name.

181

},

182

"proxy": "A String", # Proxy server address to use for auth method.

183

},

184

],

185

},

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

186

},

187

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

188

"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

189

"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

190

"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

191

"binauthzState": { # State for Binauthz # Binauthz status

192

"version": { # The version of binauthz. # The version of binauthz that is installed.

193

"webhookVersion": "A String", # The version of the binauthz webhook.

194

},

195

"webhook": "A String", # The state of the binauthz webhook.

196

},

197

"clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation.

198

"configSyncState": { # State information for ConfigSync # Current sync status

199

"deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed

200

"gitSync": "A String", # Deployment state of the git-sync pod

201

"importer": "A String", # Deployment state of the importer pod

202

"monitor": "A String", # Deployment state of the monitor pod

203

"reconcilerManager": "A String", # Deployment state of reconciler-manager pod

204

"rootReconciler": "A String", # Deployment state of root-reconciler

205

"syncer": "A String", # Deployment state of the syncer pod

206

},

207

"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster

208

"code": "A String", # Sync status code

209

"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.

210

{ # An ACM created error representing a problem syncing configurations

211

"code": "A String", # An ACM defined error code

212

"errorMessage": "A String", # A description of the error

213

"errorResources": [ # A list of config(s) associated with the error, if any

214

{ # Model for a config file in the git repo with an associated Sync error

215

"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error

216

"group": "A String", # Kubernetes Group

217

"kind": "A String", # Kubernetes Kind

218

"version": "A String", # Kubernetes Version

219

},

220

"resourceName": "A String", # Metadata name of the resource that is causing an error

221

"resourceNamespace": "A String", # Namespace of the resource that is causing an error

222

"sourcePath": "A String", # Path in the git repo of the erroneous config

},

],

},

],

"importToken": "A String", # Token indicating the state of the importer.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

228

"lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

229

"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo

230

"sourceToken": "A String", # Token indicating the state of the repo.

231

"syncToken": "A String", # Token indicating the state of the syncer.

232

},

233

"version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed

234

"gitSync": "A String", # Version of the deployed git-sync pod

235

"importer": "A String", # Version of the deployed importer pod

236

"monitor": "A String", # Version of the deployed monitor pod

237

"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod

238

"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod

239

"syncer": "A String", # Version of the deployed syncer pod

240

},

241

},

242

"hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status

243

"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller

244

"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)

245

"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)

246

},

247

"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller

248

"extension": "A String", # Version for Hierarchy Controller extension

249

"hnc": "A String", # Version for open source HNC

250

},

251

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

252

"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

253

"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.

254

"enabled": True or False, # Whether binauthz is enabled in this cluster.

255

},

256

"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.

257

"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.

258

"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.

259

"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.

260

"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.

261

"secretType": "A String", # Type of secret configured for access to the Git repo.

262

"syncBranch": "A String", # The branch of the repository to sync from. Default: master.

263

"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.

264

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.

265

"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.

266

},

267

"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.

268

},

269

"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.

270

"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.

271

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.

272

"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.

273

},

274

"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.

275

"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.

276

"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.

277

"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.

278

"A String",

279

],

280

"logDeniesEnabled": True or False, # Logs all denies and dry run failures.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

281

"mutationEnabled": True or False, # Enable users to try out mutation for PolicyController.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

282

"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.

283

"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.

284

},

285

"version": "A String", # Version of ACM installed.

286

},

287

"operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator

288

"deploymentState": "A String", # The state of the Operator's deployment

289

"errors": [ # Install errors.

290

{ # Errors pertaining to the installation of ACM

291

"errorMessage": "A String", # A string representing the user facing error message

292

},

293

],

294

"version": "A String", # The semenatic version number of the operator

295

},

296

"policyControllerState": { # State for PolicyControllerState. # PolicyController status

297

"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.

298

"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.

299

"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

300

"gatekeeperMutation": "A String", # Status of the pod serving the mutation webhook.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

301

},

302

"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.

303

"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.

304

},

305

},

306

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

307

"identityservice": { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.

308

"failureReason": "A String", # The reason of the failure.

309

"installedVersion": "A String", # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.

310

"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration

311

"authMethods": [ # A member may support multiple auth methods.

312

{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.

313

"name": "A String", # Identifier for auth config.

314

"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.

315

"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.

316

"clientId": "A String", # ID for OIDC client application.

317

"deployCloudConsoleProxy": 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.

318

"extraParams": "A String", # Comma-separated list of key-value pairs.

319

"groupPrefix": "A String", # Prefix to prepend to group name.

320

"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.

321

"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.

322

"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.

323

"scopes": "A String", # Comma-separated list of identifiers.

324

"userClaim": "A String", # Claim in OIDC ID token that holds username.

325

"userPrefix": "A String", # Prefix to prepend to user name.

326

},

327

"proxy": "A String", # Proxy server address to use for auth method.

},

],

},

"state": "A String", # Deployment state on this member

332

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

333

"metering": { # **Metering**: Per-Membership Feature State. # Metering-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

334

"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.

335

"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).

336

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

337

"servicemesh": { # **Service Mesh**: State for a single Membership, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

338

"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.

339

{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.

340

"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.

341

"a_key": "", # Properties of the object.

342

},

343

"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.

344

"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.

345

"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.

346

"level": "A String", # Represents how severe a message is.

347

"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.

348

"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)

349

"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)

350

},

351

},

352

"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster

"A String",

],

},

],

},

"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.

359

"code": "A String", # The high-level, machine-readable status of this Feature.

360

"description": "A String", # A human-readable description of the current status.

361

"updateTime": "A String", # The time this status and any related Feature-specific details were updated.

},

},

},

"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.

366

"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.

367

"state": "A String", # The current state of the Feature resource in the Hub API.

368

},

369

"spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

370

"cloudauditlogging": { # **Cloud Audit Logging**: Spec for Audit Logging Allowlisting. # Cloud Audit Logging-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

371

"allowlistedServiceAccounts": [ # Service account that should be allowlisted to send the audit logs; eg cloudauditlogging@gcp-project.iam.gserviceaccount.com. These accounts must already exist, but do not need to have any permissions granted to them. The customer's entitlements will be checked prior to allowlisting (i.e. the customer must be an Anthos customer.)

372

"A String",

373

],

374

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

375

"multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

376

"billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

377

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`

378

},

379

},

380

"state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

381

"servicemesh": { # **Service Mesh**: State for the whole Hub, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

382

"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.

383

{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.

384

"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.

385

"a_key": "", # Properties of the object.

386

},

387

"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.

388

"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.

389

"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.

390

"level": "A String", # Represents how severe a message is.

391

"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.

392

"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)

393

"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)

394

},

395

},

396

"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster

"A String",

],

},

],

},

"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub.

403

"code": "A String", # The high-level, machine-readable status of this Feature.

404

"description": "A String", # A human-readable description of the current status.

405

"updateTime": "A String", # The time this status and any related Feature-specific details were updated.

406

},

407

},

408

"updateTime": "A String", # Output only. When the Feature resource was last updated.

409

}

410

411

featureId: string, The ID of the feature to create.

412

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).

413

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

420

421

{ # This resource represents a long-running operation that is the result of a network API call.

422

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

423

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

424

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

425

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

426

{

427

"a_key": "", # Properties of the object. Contains field @type with type URL.

428

},

429

],

430

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

431

},

432

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

433

"a_key": "", # Properties of the object. Contains field @type with type URL.

434

},

435

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

436

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

437

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>

444

<pre>Removes a Feature.

445

446

Args:

447

name: string, The Feature resource name in the format `projects/*/locations/*/features/*`. (required)

448

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.

449

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).

450

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

457

458

{ # This resource represents a long-running operation that is the result of a network API call.

459

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

460

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

461

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

462

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

463

{

464

"a_key": "", # Properties of the object. Contains field @type with type URL.

465

},

466

],

467

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

468

},

469

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

470

"a_key": "", # Properties of the object. Contains field @type with type URL.

471

},

472

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

473

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

474

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

481

<pre>Gets details of a single Feature.

482

483

Args:

484

name: string, The Feature resource name in the format `projects/*/locations/*/features/*` (required)

485

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

492

493

{ # Feature represents the settings and status of any Hub Feature.

494

"createTime": "A String", # Output only. When the Feature resource was created.

495

"deleteTime": "A String", # Output only. When the Feature resource was deleted.

496

"labels": { # GCP labels for this Feature.

497

"a_key": "A String",

498

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

499

"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

500

"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

501

"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

502

"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.

503

"enabled": True or False, # Whether binauthz is enabled in this cluster.

504

},

505

"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.

506

"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.

507

"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.

508

"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.

509

"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.

510

"secretType": "A String", # Type of secret configured for access to the Git repo.

511

"syncBranch": "A String", # The branch of the repository to sync from. Default: master.

512

"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.

513

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.

514

"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.

515

},

516

"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.

517

},

518

"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.

519

"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.

520

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.

521

"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.

522

},

523

"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.

524

"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.

525

"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.

526

"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.

527

"A String",

528

],

529

"logDeniesEnabled": True or False, # Logs all denies and dry run failures.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

530

"mutationEnabled": True or False, # Enable users to try out mutation for PolicyController.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

531

"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.

532

"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.

533

},

534

"version": "A String", # Version of ACM installed.

535

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

536

"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.

537

"authMethods": [ # A member may support multiple auth methods.

538

{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.

539

"name": "A String", # Identifier for auth config.

540

"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.

541

"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.

542

"clientId": "A String", # ID for OIDC client application.

543

"deployCloudConsoleProxy": 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.

544

"extraParams": "A String", # Comma-separated list of key-value pairs.

545

"groupPrefix": "A String", # Prefix to prepend to group name.

546

"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.

547

"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.

548

"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.

549

"scopes": "A String", # Comma-separated list of identifiers.

550

"userClaim": "A String", # Claim in OIDC ID token that holds username.

551

"userPrefix": "A String", # Prefix to prepend to user name.

552

},

553

"proxy": "A String", # Proxy server address to use for auth method.

554

},

555

],

556

},

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

557

},

558

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

559

"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

560

"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

561

"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

562

"binauthzState": { # State for Binauthz # Binauthz status

563

"version": { # The version of binauthz. # The version of binauthz that is installed.

564

"webhookVersion": "A String", # The version of the binauthz webhook.

565

},

566

"webhook": "A String", # The state of the binauthz webhook.

567

},

568

"clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation.

569

"configSyncState": { # State information for ConfigSync # Current sync status

570

"deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed

571

"gitSync": "A String", # Deployment state of the git-sync pod

572

"importer": "A String", # Deployment state of the importer pod

573

"monitor": "A String", # Deployment state of the monitor pod

574

"reconcilerManager": "A String", # Deployment state of reconciler-manager pod

575

"rootReconciler": "A String", # Deployment state of root-reconciler

576

"syncer": "A String", # Deployment state of the syncer pod

577

},

578

"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster

579

"code": "A String", # Sync status code

580

"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.

581

{ # An ACM created error representing a problem syncing configurations

582

"code": "A String", # An ACM defined error code

583

"errorMessage": "A String", # A description of the error

584

"errorResources": [ # A list of config(s) associated with the error, if any

585

{ # Model for a config file in the git repo with an associated Sync error

586

"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error

587

"group": "A String", # Kubernetes Group

588

"kind": "A String", # Kubernetes Kind

589

"version": "A String", # Kubernetes Version

590

},

591

"resourceName": "A String", # Metadata name of the resource that is causing an error

592

"resourceNamespace": "A String", # Namespace of the resource that is causing an error

593

"sourcePath": "A String", # Path in the git repo of the erroneous config

},

],

},

],

"importToken": "A String", # Token indicating the state of the importer.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

599

"lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

600

"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo

601

"sourceToken": "A String", # Token indicating the state of the repo.

602

"syncToken": "A String", # Token indicating the state of the syncer.

603

},

604

"version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed

605

"gitSync": "A String", # Version of the deployed git-sync pod

606

"importer": "A String", # Version of the deployed importer pod

607

"monitor": "A String", # Version of the deployed monitor pod

608

"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod

609

"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod

610

"syncer": "A String", # Version of the deployed syncer pod

611

},

612

},

613

"hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status

614

"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller

615

"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)

616

"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)

617

},

618

"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller

619

"extension": "A String", # Version for Hierarchy Controller extension

620

"hnc": "A String", # Version for open source HNC

621

},

622

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

623

"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

624

"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.

625

"enabled": True or False, # Whether binauthz is enabled in this cluster.

626

},

627

"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.

628

"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.

629

"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.

630

"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.

631

"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.

632

"secretType": "A String", # Type of secret configured for access to the Git repo.

633

"syncBranch": "A String", # The branch of the repository to sync from. Default: master.

634

"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.

635

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.

636

"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.

637

},

638

"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.

639

},

640

"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.

641

"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.

642

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.

643

"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.

644

},

645

"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.

646

"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.

647

"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.

648

"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.

649

"A String",

650

],

651

"logDeniesEnabled": True or False, # Logs all denies and dry run failures.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

652

"mutationEnabled": True or False, # Enable users to try out mutation for PolicyController.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

653

"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.

654

"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.

655

},

656

"version": "A String", # Version of ACM installed.

657

},

658

"operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator

659

"deploymentState": "A String", # The state of the Operator's deployment

660

"errors": [ # Install errors.

661

{ # Errors pertaining to the installation of ACM

662

"errorMessage": "A String", # A string representing the user facing error message

663

},

664

],

665

"version": "A String", # The semenatic version number of the operator

666

},

667

"policyControllerState": { # State for PolicyControllerState. # PolicyController status

668

"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.

669

"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.

670

"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

671

"gatekeeperMutation": "A String", # Status of the pod serving the mutation webhook.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

672

},

673

"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.

674

"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.

675

},

676

},

677

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

678

"identityservice": { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.

679

"failureReason": "A String", # The reason of the failure.

680

"installedVersion": "A String", # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.

681

"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration

682

"authMethods": [ # A member may support multiple auth methods.

683

{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.

684

"name": "A String", # Identifier for auth config.

685

"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.

686

"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.

687

"clientId": "A String", # ID for OIDC client application.

688

"deployCloudConsoleProxy": 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.

689

"extraParams": "A String", # Comma-separated list of key-value pairs.

690

"groupPrefix": "A String", # Prefix to prepend to group name.

691

"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.

692

"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.

693

"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.

694

"scopes": "A String", # Comma-separated list of identifiers.

695

"userClaim": "A String", # Claim in OIDC ID token that holds username.

696

"userPrefix": "A String", # Prefix to prepend to user name.

697

},

698

"proxy": "A String", # Proxy server address to use for auth method.

},

],

},

"state": "A String", # Deployment state on this member

703

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

704

"metering": { # **Metering**: Per-Membership Feature State. # Metering-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

705

"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.

706

"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).

707

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

708

"servicemesh": { # **Service Mesh**: State for a single Membership, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

709

"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.

710

{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.

711

"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.

712

"a_key": "", # Properties of the object.

713

},

714

"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.

715

"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.

716

"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.

717

"level": "A String", # Represents how severe a message is.

718

"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.

719

"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)

720

"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)

721

},

722

},

723

"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster

"A String",

],

},

],

},

"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.

730

"code": "A String", # The high-level, machine-readable status of this Feature.

731

"description": "A String", # A human-readable description of the current status.

732

"updateTime": "A String", # The time this status and any related Feature-specific details were updated.

},

},

},

"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.

737

"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.

738

"state": "A String", # The current state of the Feature resource in the Hub API.

739

},

740

"spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

741

"cloudauditlogging": { # **Cloud Audit Logging**: Spec for Audit Logging Allowlisting. # Cloud Audit Logging-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

742

"allowlistedServiceAccounts": [ # Service account that should be allowlisted to send the audit logs; eg cloudauditlogging@gcp-project.iam.gserviceaccount.com. These accounts must already exist, but do not need to have any permissions granted to them. The customer's entitlements will be checked prior to allowlisting (i.e. the customer must be an Anthos customer.)

743

"A String",

744

],

745

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

746

"multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

747

"billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

748

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`

749

},

750

},

751

"state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

752

"servicemesh": { # **Service Mesh**: State for the whole Hub, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

753

"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.

754

{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.

755

"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.

756

"a_key": "", # Properties of the object.

757

},

758

"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.

759

"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.

760

"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.

761

"level": "A String", # Represents how severe a message is.

762

"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.

763

"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)

764

"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)

765

},

766

},

767

"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster

"A String",

],

},

],

},

"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub.

774

"code": "A String", # The high-level, machine-readable status of this Feature.

775

"description": "A String", # A human-readable description of the current status.

776

"updateTime": "A String", # The time this status and any related Feature-specific details were updated.

777

},

778

},

779

"updateTime": "A String", # Output only. When the Feature resource was last updated.

}</pre>

</div>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

784

<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>

785

<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

786

787

Args:

788

resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)

789

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).

790

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

797

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

798

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

799

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

800

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

801

"auditLogConfigs": [ # The configuration for logging of each type of permission.

802

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

803

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

804

"A String",

805

],

806

"logType": "A String", # The log type that this config enables.

807

},

808

],

809

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

810

},

811

],

812

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

813

{ # Associates `members` with a `role`.

814

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

815

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

816

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

817

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

818

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

819

},

820

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

821

"A String",

822

],

823

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

824

},

825

],

826

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

827

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

}</pre>

</div>

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

832

<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

833

<pre>Lists Features in a given project and location.

834

835

Args:

836

parent: string, The parent (project and location) where the Features will be listed. Specified in the format `projects/*/locations/*`. (required)

837

filter: string, Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name "servicemesh" in project "foo-proj": name = "projects/foo-proj/locations/global/features/servicemesh" - Features that have a label called `foo`: labels.foo:* - Features that have a label called `foo` whose value is `bar`: labels.foo = bar

838

orderBy: string, One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

839

pageSize: integer, When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

840

pageToken: string, Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources.

841

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

848

849

{ # Response message for the `GkeHub.ListFeatures` method.

850

"nextPageToken": "A String", # A token to request the next page of resources from the `ListFeatures` method. The value of an empty string means that there are no more resources to return.

851

"resources": [ # The list of matching Features

852

{ # Feature represents the settings and status of any Hub Feature.

853

"createTime": "A String", # Output only. When the Feature resource was created.

854

"deleteTime": "A String", # Output only. When the Feature resource was deleted.

855

"labels": { # GCP labels for this Feature.

856

"a_key": "A String",

857

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

858

"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

859

"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

860

"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

861

"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.

862

"enabled": True or False, # Whether binauthz is enabled in this cluster.

863

},

864

"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.

865

"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.

866

"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.

867

"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.

868

"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.

869

"secretType": "A String", # Type of secret configured for access to the Git repo.

870

"syncBranch": "A String", # The branch of the repository to sync from. Default: master.

871

"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.

872

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.

873

"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.

874

},

875

"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.

876

},

877

"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.

878

"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.

879

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.

880

"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.

881

},

882

"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.

883

"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.

884

"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.

885

"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.

886

"A String",

887

],

888

"logDeniesEnabled": True or False, # Logs all denies and dry run failures.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

889

"mutationEnabled": True or False, # Enable users to try out mutation for PolicyController.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

890

"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.

891

"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.

892

},

893

"version": "A String", # Version of ACM installed.

894

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

895

"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.

896

"authMethods": [ # A member may support multiple auth methods.

897

{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.

898

"name": "A String", # Identifier for auth config.

899

"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.

900

"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.

901

"clientId": "A String", # ID for OIDC client application.

902

"deployCloudConsoleProxy": 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.

903

"extraParams": "A String", # Comma-separated list of key-value pairs.

904

"groupPrefix": "A String", # Prefix to prepend to group name.

905

"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.

906

"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.

907

"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.

908

"scopes": "A String", # Comma-separated list of identifiers.

909

"userClaim": "A String", # Claim in OIDC ID token that holds username.

910

"userPrefix": "A String", # Prefix to prepend to user name.

911

},

912

"proxy": "A String", # Proxy server address to use for auth method.

913

},

914

],

915

},

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

916

},

917

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

918

"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

919

"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

920

"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

921

"binauthzState": { # State for Binauthz # Binauthz status

922

"version": { # The version of binauthz. # The version of binauthz that is installed.

923

"webhookVersion": "A String", # The version of the binauthz webhook.

924

},

925

"webhook": "A String", # The state of the binauthz webhook.

926

},

927

"clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation.

928

"configSyncState": { # State information for ConfigSync # Current sync status

929

"deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed

930

"gitSync": "A String", # Deployment state of the git-sync pod

931

"importer": "A String", # Deployment state of the importer pod

932

"monitor": "A String", # Deployment state of the monitor pod

933

"reconcilerManager": "A String", # Deployment state of reconciler-manager pod

934

"rootReconciler": "A String", # Deployment state of root-reconciler

935

"syncer": "A String", # Deployment state of the syncer pod

936

},

937

"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster

938

"code": "A String", # Sync status code

939

"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.

940

{ # An ACM created error representing a problem syncing configurations

941

"code": "A String", # An ACM defined error code

942

"errorMessage": "A String", # A description of the error

943

"errorResources": [ # A list of config(s) associated with the error, if any

944

{ # Model for a config file in the git repo with an associated Sync error

945

"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error

946

"group": "A String", # Kubernetes Group

947

"kind": "A String", # Kubernetes Kind

948

"version": "A String", # Kubernetes Version

949

},

950

"resourceName": "A String", # Metadata name of the resource that is causing an error

951

"resourceNamespace": "A String", # Namespace of the resource that is causing an error

952

"sourcePath": "A String", # Path in the git repo of the erroneous config

},

],

},

],

"importToken": "A String", # Token indicating the state of the importer.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

958

"lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

959

"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo

960

"sourceToken": "A String", # Token indicating the state of the repo.

961

"syncToken": "A String", # Token indicating the state of the syncer.

962

},

963

"version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed

964

"gitSync": "A String", # Version of the deployed git-sync pod

965

"importer": "A String", # Version of the deployed importer pod

966

"monitor": "A String", # Version of the deployed monitor pod

967

"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod

968

"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod

969

"syncer": "A String", # Version of the deployed syncer pod

970

},

971

},

972

"hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status

973

"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller

974

"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)

975

"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)

976

},

977

"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller

978

"extension": "A String", # Version for Hierarchy Controller extension

979

"hnc": "A String", # Version for open source HNC

980

},

981

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

982

"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

983

"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.

984

"enabled": True or False, # Whether binauthz is enabled in this cluster.

985

},

986

"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.

987

"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.

988

"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.

989

"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.

990

"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.

991

"secretType": "A String", # Type of secret configured for access to the Git repo.

992

"syncBranch": "A String", # The branch of the repository to sync from. Default: master.

993

"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.

994

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.

995

"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.

996

},

997

"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.

998

},

999

"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.

1000

"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.

1001

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.

1002

"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.

1003

},

1004

"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.

1005

"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.

1006

"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.

1007

"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.

1008

"A String",

1009

],

1010

"logDeniesEnabled": True or False, # Logs all denies and dry run failures.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

1011

"mutationEnabled": True or False, # Enable users to try out mutation for PolicyController.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1012

"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.

1013

"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.

1014

},

1015

"version": "A String", # Version of ACM installed.

1016

},

1017

"operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator

1018

"deploymentState": "A String", # The state of the Operator's deployment

1019

"errors": [ # Install errors.

1020

{ # Errors pertaining to the installation of ACM

1021

"errorMessage": "A String", # A string representing the user facing error message

1022

},

1023

],

1024

"version": "A String", # The semenatic version number of the operator

1025

},

1026

"policyControllerState": { # State for PolicyControllerState. # PolicyController status

1027

"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.

1028

"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.

1029

"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

1030

"gatekeeperMutation": "A String", # Status of the pod serving the mutation webhook.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1031

},

1032

"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.

1033

"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.

1034

},

1035

},

1036

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1037

"identityservice": { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.

1038

"failureReason": "A String", # The reason of the failure.

1039

"installedVersion": "A String", # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.

1040

"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration

1041

"authMethods": [ # A member may support multiple auth methods.

1042

{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.

1043

"name": "A String", # Identifier for auth config.

1044

"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.

1045

"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.

1046

"clientId": "A String", # ID for OIDC client application.

1047

"deployCloudConsoleProxy": 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.

1048

"extraParams": "A String", # Comma-separated list of key-value pairs.

1049

"groupPrefix": "A String", # Prefix to prepend to group name.

1050

"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.

1051

"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.

1052

"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.

1053

"scopes": "A String", # Comma-separated list of identifiers.

1054

"userClaim": "A String", # Claim in OIDC ID token that holds username.

1055

"userPrefix": "A String", # Prefix to prepend to user name.

1056

},

1057

"proxy": "A String", # Proxy server address to use for auth method.

},

],

},

"state": "A String", # Deployment state on this member

1062

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1063

"metering": { # **Metering**: Per-Membership Feature State. # Metering-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1064

"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.

1065

"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).

1066

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1067

"servicemesh": { # **Service Mesh**: State for a single Membership, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1068

"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.

1069

{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.

1070

"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.

1071

"a_key": "", # Properties of the object.

1072

},

1073

"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.

1074

"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.

1075

"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.

1076

"level": "A String", # Represents how severe a message is.

1077

"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.

1078

"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)

1079

"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)

1080

},

1081

},

1082

"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster

"A String",

],

},

],

},

"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.

1089

"code": "A String", # The high-level, machine-readable status of this Feature.

1090

"description": "A String", # A human-readable description of the current status.

1091

"updateTime": "A String", # The time this status and any related Feature-specific details were updated.

},

},

},

"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.

1096

"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.

1097

"state": "A String", # The current state of the Feature resource in the Hub API.

1098

},

1099

"spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1100

"cloudauditlogging": { # **Cloud Audit Logging**: Spec for Audit Logging Allowlisting. # Cloud Audit Logging-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1101

"allowlistedServiceAccounts": [ # Service account that should be allowlisted to send the audit logs; eg cloudauditlogging@gcp-project.iam.gserviceaccount.com. These accounts must already exist, but do not need to have any permissions granted to them. The customer's entitlements will be checked prior to allowlisting (i.e. the customer must be an Anthos customer.)

1102

"A String",

1103

],

1104

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1105

"multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

1106

"billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1107

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`

1108

},

1109

},

1110

"state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1111

"servicemesh": { # **Service Mesh**: State for the whole Hub, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1112

"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.

1113

{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.

1114

"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.

1115

"a_key": "", # Properties of the object.

1116

},

1117

"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.

1118

"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.

1119

"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.

1120

"level": "A String", # Represents how severe a message is.

1121

"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.

1122

"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)

1123

"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)

1124

},

1125

},

1126

"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster

"A String",

],

},

],

},

"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub.

1133

"code": "A String", # The high-level, machine-readable status of this Feature.

1134

"description": "A String", # A human-readable description of the current status.

1135

"updateTime": "A String", # The time this status and any related Feature-specific details were updated.

1136

},

1137

},

1138

"updateTime": "A String", # Output only. When the Feature resource was last updated.

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1146

<pre>Retrieves the next page of results.

1147

1148

Args:

1149

previous_request: The request for the previous page. (required)

1150

previous_response: The response from the request for the previous page. (required)

1151

1152

Returns:

1153

A request object that you can call 'execute()' on to request the next

1154

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>

1160

<pre>Updates an existing Feature.

1161

1162

Args:

1163

name: string, The Feature resource name in the format `projects/*/locations/*/features/*`. (required)

1164

body: object, The request body.

1165

The object takes the form of:

1166

1167

{ # Feature represents the settings and status of any Hub Feature.

1168

"createTime": "A String", # Output only. When the Feature resource was created.

1169

"deleteTime": "A String", # Output only. When the Feature resource was deleted.

1170

"labels": { # GCP labels for this Feature.

1171

"a_key": "A String",

1172

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

1173

"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1174

"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1175

"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1176

"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.

1177

"enabled": True or False, # Whether binauthz is enabled in this cluster.

1178

},

1179

"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.

1180

"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.

1181

"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.

1182

"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.

1183

"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.

1184

"secretType": "A String", # Type of secret configured for access to the Git repo.

1185

"syncBranch": "A String", # The branch of the repository to sync from. Default: master.

1186

"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.

1187

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.

1188

"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.

1189

},

1190

"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.

1191

},

1192

"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.

1193

"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.

1194

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.

1195

"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.

1196

},

1197

"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.

1198

"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.

1199

"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.

1200

"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.

1201

"A String",

1202

],

1203

"logDeniesEnabled": True or False, # Logs all denies and dry run failures.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

1204

"mutationEnabled": True or False, # Enable users to try out mutation for PolicyController.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1205

"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.

1206

"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.

1207

},

1208

"version": "A String", # Version of ACM installed.

1209

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1210

"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.

1211

"authMethods": [ # A member may support multiple auth methods.

1212

{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.

1213

"name": "A String", # Identifier for auth config.

1214

"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.

1215

"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.

1216

"clientId": "A String", # ID for OIDC client application.

1217

"deployCloudConsoleProxy": 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.

1218

"extraParams": "A String", # Comma-separated list of key-value pairs.

1219

"groupPrefix": "A String", # Prefix to prepend to group name.

1220

"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.

1221

"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.

1222

"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.

1223

"scopes": "A String", # Comma-separated list of identifiers.

1224

"userClaim": "A String", # Claim in OIDC ID token that holds username.

1225

"userPrefix": "A String", # Prefix to prepend to user name.

1226

},

1227

"proxy": "A String", # Proxy server address to use for auth method.

1228

},

1229

],

1230

},

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1231

},

1232

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

1233

"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1234

"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1235

"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1236

"binauthzState": { # State for Binauthz # Binauthz status

1237

"version": { # The version of binauthz. # The version of binauthz that is installed.

1238

"webhookVersion": "A String", # The version of the binauthz webhook.

1239

},

1240

"webhook": "A String", # The state of the binauthz webhook.

1241

},

1242

"clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation.

1243

"configSyncState": { # State information for ConfigSync # Current sync status

1244

"deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed

1245

"gitSync": "A String", # Deployment state of the git-sync pod

1246

"importer": "A String", # Deployment state of the importer pod

1247

"monitor": "A String", # Deployment state of the monitor pod

1248

"reconcilerManager": "A String", # Deployment state of reconciler-manager pod

1249

"rootReconciler": "A String", # Deployment state of root-reconciler

1250

"syncer": "A String", # Deployment state of the syncer pod

1251

},

1252

"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster

1253

"code": "A String", # Sync status code

1254

"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.

1255

{ # An ACM created error representing a problem syncing configurations

1256

"code": "A String", # An ACM defined error code

1257

"errorMessage": "A String", # A description of the error

1258

"errorResources": [ # A list of config(s) associated with the error, if any

1259

{ # Model for a config file in the git repo with an associated Sync error

1260

"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error

1261

"group": "A String", # Kubernetes Group

1262

"kind": "A String", # Kubernetes Kind

1263

"version": "A String", # Kubernetes Version

1264

},

1265

"resourceName": "A String", # Metadata name of the resource that is causing an error

1266

"resourceNamespace": "A String", # Namespace of the resource that is causing an error

1267

"sourcePath": "A String", # Path in the git repo of the erroneous config

},

],

},

],

"importToken": "A String", # Token indicating the state of the importer.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

1273

"lastSync": "A String", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1274

"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo

1275

"sourceToken": "A String", # Token indicating the state of the repo.

1276

"syncToken": "A String", # Token indicating the state of the syncer.

1277

},

1278

"version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed

1279

"gitSync": "A String", # Version of the deployed git-sync pod

1280

"importer": "A String", # Version of the deployed importer pod

1281

"monitor": "A String", # Version of the deployed monitor pod

1282

"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod

1283

"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod

1284

"syncer": "A String", # Version of the deployed syncer pod

1285

},

1286

},

1287

"hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status

1288

"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller

1289

"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)

1290

"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)

1291

},

1292

"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller

1293

"extension": "A String", # Version for Hierarchy Controller extension

1294

"hnc": "A String", # Version for open source HNC

1295

},

1296

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1297

"membershipSpec": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1298

"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.

1299

"enabled": True or False, # Whether binauthz is enabled in this cluster.

1300

},

1301

"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.

1302

"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.

1303

"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.

1304

"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.

1305

"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.

1306

"secretType": "A String", # Type of secret configured for access to the Git repo.

1307

"syncBranch": "A String", # The branch of the repository to sync from. Default: master.

1308

"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.

1309

"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.

1310

"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.

1311

},

1312

"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.

1313

},

1314

"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.

1315

"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.

1316

"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.

1317

"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.

1318

},

1319

"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.

1320

"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.

1321

"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.

1322

"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.

1323

"A String",

1324

],

1325

"logDeniesEnabled": True or False, # Logs all denies and dry run failures.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

1326

"mutationEnabled": True or False, # Enable users to try out mutation for PolicyController.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1327

"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.

1328

"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.

1329

},

1330

"version": "A String", # Version of ACM installed.

1331

},

1332

"operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator

1333

"deploymentState": "A String", # The state of the Operator's deployment

1334

"errors": [ # Install errors.

1335

{ # Errors pertaining to the installation of ACM

1336

"errorMessage": "A String", # A string representing the user facing error message

1337

},

1338

],

1339

"version": "A String", # The semenatic version number of the operator

1340

},

1341

"policyControllerState": { # State for PolicyControllerState. # PolicyController status

1342

"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.

1343

"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.

1344

"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.

yoshi-code-bot

2021-05-29 00:50:02 -0700

[diff] [blame]

1345

"gatekeeperMutation": "A String", # Status of the pod serving the mutation webhook.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1346

},

1347

"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.

1348

"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.

1349

},

1350

},

1351

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1352

"identityservice": { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.

1353

"failureReason": "A String", # The reason of the failure.

1354

"installedVersion": "A String", # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.

1355

"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration

1356

"authMethods": [ # A member may support multiple auth methods.

1357

{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.

1358

"name": "A String", # Identifier for auth config.

1359

"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.

1360

"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.

1361

"clientId": "A String", # ID for OIDC client application.

1362

"deployCloudConsoleProxy": 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.

1363

"extraParams": "A String", # Comma-separated list of key-value pairs.

1364

"groupPrefix": "A String", # Prefix to prepend to group name.

1365

"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.

1366

"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.

1367

"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.

1368

"scopes": "A String", # Comma-separated list of identifiers.

1369

"userClaim": "A String", # Claim in OIDC ID token that holds username.

1370

"userPrefix": "A String", # Prefix to prepend to user name.

1371

},

1372

"proxy": "A String", # Proxy server address to use for auth method.

},

],

},

"state": "A String", # Deployment state on this member

1377

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1378

"metering": { # **Metering**: Per-Membership Feature State. # Metering-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1379

"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.

1380

"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).

1381

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1382

"servicemesh": { # **Service Mesh**: State for a single Membership, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1383

"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.

1384

{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.

1385

"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.

1386

"a_key": "", # Properties of the object.

1387

},

1388

"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.

1389

"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.

1390

"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.

1391

"level": "A String", # Represents how severe a message is.

1392

"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.

1393

"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)

1394

"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)

1395

},

1396

},

1397

"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster

"A String",

],

},

],

},

"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.

1404

"code": "A String", # The high-level, machine-readable status of this Feature.

1405

"description": "A String", # A human-readable description of the current status.

1406

"updateTime": "A String", # The time this status and any related Feature-specific details were updated.

},

},

},

"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`.

1411

"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.

1412

"state": "A String", # The current state of the Feature resource in the Hub API.

1413

},

1414

"spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1415

"cloudauditlogging": { # **Cloud Audit Logging**: Spec for Audit Logging Allowlisting. # Cloud Audit Logging-specific spec.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1416

"allowlistedServiceAccounts": [ # Service account that should be allowlisted to send the audit logs; eg cloudauditlogging@gcp-project.iam.gserviceaccount.com. These accounts must already exist, but do not need to have any permissions granted to them. The customer's entitlements will be checked prior to allowlisting (i.e. the customer must be an Anthos customer.)

1417

"A String",

1418

],

1419

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1420

"multiclusteringress": { # **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

1421

"billing": "A String", # Deprecated: This field will be ignored and should not be set. Customer's billing structure.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1422

"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`

1423

},

1424

},

1425

"state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1426

"servicemesh": { # **Service Mesh**: State for the whole Hub, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.

yoshi-code-bot

2021-05-02 03:48:02 -0700

[diff] [blame]

1427

"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.

1428

{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.

1429

"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.

1430

"a_key": "", # Properties of the object.

1431

},

1432

"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.

1433

"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.

1434

"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.

1435

"level": "A String", # Represents how severe a message is.

1436

"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.

1437

"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)

1438

"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)

1439

},

1440

},

1441

"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster

"A String",

],

},

],

},

"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub.

1448

"code": "A String", # The high-level, machine-readable status of this Feature.

1449

"description": "A String", # A human-readable description of the current status.

1450

"updateTime": "A String", # The time this status and any related Feature-specific details were updated.

1451

},

1452

},

1453

"updateTime": "A String", # Output only. When the Feature resource was last updated.

1454

}

1455

1456

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).

1457

updateMask: string, Mask of fields to update.

1458

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1465

1466

{ # This resource represents a long-running operation that is the result of a network API call.

1467

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

1468

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

1469

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1470

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1471

{

1472

"a_key": "", # Properties of the object. Contains field @type with type URL.

1473

},

1474

],

1475

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1476

},

1477

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

1478

"a_key": "", # Properties of the object. Contains field @type with type URL.

1479

},

1480

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

1481

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

1482

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1488

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

1489

<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

1490

1491

Args:

1492

resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)

1493

body: object, The request body.

1494

The object takes the form of:

1495

1496

{ # Request message for `SetIamPolicy` method.

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1497

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1498

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

1499

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

1500

"auditLogConfigs": [ # The configuration for logging of each type of permission.

1501

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1502

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

1503

"A String",

1504

],

1505

"logType": "A String", # The log type that this config enables.

1506

},

1507

],

1508

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

1509

},

1510

],

1511

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

1512

{ # Associates `members` with a `role`.

1513

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1514

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1515

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1516

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1517

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1518

},

1519

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

1520

"A String",

1521

],

1522

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1523

},

1524

],

1525

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1526

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1527

},

1528

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`

1529

}

1530

1531

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1538

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1539

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Anthonios Partheniou