Blame - docs/dyn/apigateway_v1beta.projects.locations.apis.configs.html - platform/external/python/google-api-python-client

2020-12-09 08:56:03 -0800

[diff] [blame^]

93

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

94

<p class="firstline">Lists ApiConfigs 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, updateMask=None, x__xgafv=None)</a></code></p>

100

<p class="firstline">Updates the parameters of a single ApiConfig.</p>

101

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>

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

115

<pre>Creates a new ApiConfig in a given project and location.

116

117

Args:

118

parent: string, Required. Parent resource of the API Config, of the form: `projects/*/locations/global/apis/*` (required)

119

body: object, The request body.

120

The object takes the form of:

121

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

122

{ # An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

123

"labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

124

"a_key": "A String",

125

},

126

"displayName": "A String", # Optional. Display name.

127

"updateTime": "A String", # Output only. Updated time.

128

"name": "A String", # Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

129

"grpcServices": [ # Optional. gRPC service definition files. If specified, openapi_documents must not be included.

130

{ # A gRPC service definition.

131

"fileDescriptorSet": { # A lightweight description of a file. # Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

132

"contents": "A String", # The bytes that constitute the file.

133

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

134

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

135

"source": [ # Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

136

{ # A lightweight description of a file.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

137

"contents": "A String", # The bytes that constitute the file.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

138

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

139

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

140

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

141

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

142

],

143

"state": "A String", # Output only. State of the API Config.

144

"managedServiceConfigs": [ # Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https: //cloud.google.com/endpoints/docs/grpc/g // rpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.

145

{ # A lightweight description of a file.

146

"contents": "A String", # The bytes that constitute the file.

147

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

148

},

149

],

150

"gatewayConfig": { # Configuration settings for Gateways. # Immutable. Gateway specific configuration. If not specified, backend authentication will be set to use OIDC authentication using the default compute service account.

151

"backendConfig": { # Configuration for a backend. # Required. Backend settings that are applied to all backends of the Gateway.

152

"googleServiceAccount": "A String", # Google Cloud IAM service account used to sign OIDC tokens for backends that have authentication configured (https: //cloud.google.com/service-infrastructur // e/docs/service-management/reference/rest/v1/services.configs#backend). This may either be the Service Account's email (i.e. "{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com") or its full resource name (i.e. "projects/{PROJECT}/accounts/{UNIQUE_ID}"). This is most often used when the backend is a GCP resource such as a Cloud Run Service or an IAP-secured service. Note that this token is always sent as an authorization header bearer token. The audience of the OIDC token is configured in the associated Service Config in the BackendRule option (https: //github.com/googleapis/googleapis/blob/ // master/google/api/backend.proto#L125).

153

},

154

},

155

"serviceConfigId": "A String", # Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

156

"openapiDocuments": [ # Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_config must not be included.

157

{ # An OpenAPI Specification Document describing an API.

158

"document": { # A lightweight description of a file. # The OpenAPI Specification document file.

159

"contents": "A String", # The bytes that constitute the file.

160

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

},

},

],

"createTime": "A String", # Output only. Created time.

165

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

166

167

apiConfigId: string, Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.

168

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

175

176

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

177

"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}`.

178

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

179

"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`.

180

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

181

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

182

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

183

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

184

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

185

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

186

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

187

{

188

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

189

},

190

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

191

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

192

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

193

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

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

199

<pre>Deletes a single ApiConfig.

200

201

Args:

202

name: string, Required. Resource name of the form: `projects/*/locations/global/apis/*/configs/*` (required)

203

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

210

211

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

212

"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}`.

213

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

214

"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`.

215

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

216

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

217

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

218

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

219

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

220

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

221

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

222

{

223

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

224

},

225

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

226

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

227

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

228

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

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

234

<pre>Gets details of a single ApiConfig.

235

236

Args:

237

name: string, Required. Resource name of the form: `projects/*/locations/global/apis/*/configs/*` (required)

238

view: string, Specifies which fields of the API Config are returned in the response. Defaults to `BASIC` view.

239

Allowed values

240

CONFIG_VIEW_UNSPECIFIED -

241

BASIC - Do not include configuration source files.

242

FULL - Include configuration source files.

243

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

250

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

251

{ # An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

252

"labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

253

"a_key": "A String",

254

},

255

"displayName": "A String", # Optional. Display name.

256

"updateTime": "A String", # Output only. Updated time.

257

"name": "A String", # Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

258

"grpcServices": [ # Optional. gRPC service definition files. If specified, openapi_documents must not be included.

259

{ # A gRPC service definition.

260

"fileDescriptorSet": { # A lightweight description of a file. # Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

261

"contents": "A String", # The bytes that constitute the file.

262

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

263

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

264

"source": [ # Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

265

{ # A lightweight description of a file.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

266

"contents": "A String", # The bytes that constitute the file.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

267

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

268

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

269

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

270

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

271

],

272

"state": "A String", # Output only. State of the API Config.

273

"managedServiceConfigs": [ # Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https: //cloud.google.com/endpoints/docs/grpc/g // rpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.

274

{ # A lightweight description of a file.

275

"contents": "A String", # The bytes that constitute the file.

276

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

277

},

278

],

279

"gatewayConfig": { # Configuration settings for Gateways. # Immutable. Gateway specific configuration. If not specified, backend authentication will be set to use OIDC authentication using the default compute service account.

280

"backendConfig": { # Configuration for a backend. # Required. Backend settings that are applied to all backends of the Gateway.

281

"googleServiceAccount": "A String", # Google Cloud IAM service account used to sign OIDC tokens for backends that have authentication configured (https: //cloud.google.com/service-infrastructur // e/docs/service-management/reference/rest/v1/services.configs#backend). This may either be the Service Account's email (i.e. "{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com") or its full resource name (i.e. "projects/{PROJECT}/accounts/{UNIQUE_ID}"). This is most often used when the backend is a GCP resource such as a Cloud Run Service or an IAP-secured service. Note that this token is always sent as an authorization header bearer token. The audience of the OIDC token is configured in the associated Service Config in the BackendRule option (https: //github.com/googleapis/googleapis/blob/ // master/google/api/backend.proto#L125).

282

},

283

},

284

"serviceConfigId": "A String", # Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

285

"openapiDocuments": [ # Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_config must not be included.

286

{ # An OpenAPI Specification Document describing an API.

287

"document": { # A lightweight description of a file. # The OpenAPI Specification document file.

288

"contents": "A String", # The bytes that constitute the file.

289

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

},

},

],

"createTime": "A String", # Output only. Created time.

294

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

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

299

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

300

301

Args:

302

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

303

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

304

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

311

312

{ # 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/).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

313

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

314

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

315

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

316

{ # 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.

317

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

318

"A String",

319

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

320

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

321

},

322

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

323

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

324

},

325

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

326

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

327

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

328

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

329

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

330

"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`.

331

"A String",

332

],

333

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

334

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

335

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

336

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

337

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

338

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

339

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

340

"bindingId": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

341

},

342

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

347

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

348

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

349

350

Args:

351

parent: string, Required. Parent resource of the API Config, of the form: `projects/*/locations/global/apis/*` (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

352

orderBy: string, Order by parameters.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

353

pageToken: string, Page token.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

354

filter: string, Filter.

355

pageSize: integer, Page size.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

356

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

363

364

{ # Response message for ApiGatewayService.ListApiConfigs

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

365

"unreachableLocations": [ # Locations that could not be reached.

366

"A String",

367

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

368

"apiConfigs": [ # API Configs.

369

{ # An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

370

"labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

371

"a_key": "A String",

372

},

373

"displayName": "A String", # Optional. Display name.

374

"updateTime": "A String", # Output only. Updated time.

375

"name": "A String", # Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

376

"grpcServices": [ # Optional. gRPC service definition files. If specified, openapi_documents must not be included.

377

{ # A gRPC service definition.

378

"fileDescriptorSet": { # A lightweight description of a file. # Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

379

"contents": "A String", # The bytes that constitute the file.

380

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

381

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

382

"source": [ # Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

383

{ # A lightweight description of a file.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

384

"contents": "A String", # The bytes that constitute the file.

385

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

386

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

],

},

],

"state": "A String", # Output only. State of the API Config.

391

"managedServiceConfigs": [ # Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https: //cloud.google.com/endpoints/docs/grpc/g // rpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.

392

{ # A lightweight description of a file.

393

"contents": "A String", # The bytes that constitute the file.

394

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

395

},

396

],

397

"gatewayConfig": { # Configuration settings for Gateways. # Immutable. Gateway specific configuration. If not specified, backend authentication will be set to use OIDC authentication using the default compute service account.

398

"backendConfig": { # Configuration for a backend. # Required. Backend settings that are applied to all backends of the Gateway.

399

"googleServiceAccount": "A String", # Google Cloud IAM service account used to sign OIDC tokens for backends that have authentication configured (https: //cloud.google.com/service-infrastructur // e/docs/service-management/reference/rest/v1/services.configs#backend). This may either be the Service Account's email (i.e. "{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com") or its full resource name (i.e. "projects/{PROJECT}/accounts/{UNIQUE_ID}"). This is most often used when the backend is a GCP resource such as a Cloud Run Service or an IAP-secured service. Note that this token is always sent as an authorization header bearer token. The audience of the OIDC token is configured in the associated Service Config in the BackendRule option (https: //github.com/googleapis/googleapis/blob/ // master/google/api/backend.proto#L125).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

400

},

401

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

402

"serviceConfigId": "A String", # Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

403

"openapiDocuments": [ # Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_config must not be included.

404

{ # An OpenAPI Specification Document describing an API.

405

"document": { # A lightweight description of a file. # The OpenAPI Specification document file.

406

"contents": "A String", # The bytes that constitute the file.

407

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

},

},

],

"createTime": "A String", # Output only. Created time.

412

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

413

],

414

"nextPageToken": "A String", # Next page token.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

420

<pre>Retrieves the next page of results.

421

422

Args:

423

previous_request: The request for the previous page. (required)

424

previous_response: The response from the request for the previous page. (required)

425

426

Returns:

427

A request object that you can call 'execute()' on to request the next

428

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

434

<pre>Updates the parameters of a single ApiConfig.

435

436

Args:

437

name: string, Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config} (required)

438

body: object, The request body.

439

The object takes the form of:

440

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

441

{ # An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

442

"labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

443

"a_key": "A String",

444

},

445

"displayName": "A String", # Optional. Display name.

446

"updateTime": "A String", # Output only. Updated time.

447

"name": "A String", # Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

448

"grpcServices": [ # Optional. gRPC service definition files. If specified, openapi_documents must not be included.

449

{ # A gRPC service definition.

450

"fileDescriptorSet": { # A lightweight description of a file. # Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

451

"contents": "A String", # The bytes that constitute the file.

452

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

453

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

454

"source": [ # Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

455

{ # A lightweight description of a file.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

456

"contents": "A String", # The bytes that constitute the file.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

457

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

458

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

459

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

460

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

461

],

462

"state": "A String", # Output only. State of the API Config.

463

"managedServiceConfigs": [ # Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https: //cloud.google.com/endpoints/docs/grpc/g // rpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.

464

{ # A lightweight description of a file.

465

"contents": "A String", # The bytes that constitute the file.

466

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

467

},

468

],

469

"gatewayConfig": { # Configuration settings for Gateways. # Immutable. Gateway specific configuration. If not specified, backend authentication will be set to use OIDC authentication using the default compute service account.

470

"backendConfig": { # Configuration for a backend. # Required. Backend settings that are applied to all backends of the Gateway.

471

"googleServiceAccount": "A String", # Google Cloud IAM service account used to sign OIDC tokens for backends that have authentication configured (https: //cloud.google.com/service-infrastructur // e/docs/service-management/reference/rest/v1/services.configs#backend). This may either be the Service Account's email (i.e. "{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com") or its full resource name (i.e. "projects/{PROJECT}/accounts/{UNIQUE_ID}"). This is most often used when the backend is a GCP resource such as a Cloud Run Service or an IAP-secured service. Note that this token is always sent as an authorization header bearer token. The audience of the OIDC token is configured in the associated Service Config in the BackendRule option (https: //github.com/googleapis/googleapis/blob/ // master/google/api/backend.proto#L125).

472

},

473

},

474

"serviceConfigId": "A String", # Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

475

"openapiDocuments": [ # Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_config must not be included.

476

{ # An OpenAPI Specification Document describing an API.

477

"document": { # A lightweight description of a file. # The OpenAPI Specification document file.

478

"contents": "A String", # The bytes that constitute the file.

479

"path": "A String", # The file path (full or relative path). This is typically the path of the file when it is uploaded.

},

},

],

"createTime": "A String", # Output only. Created time.

484

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

485

486

updateMask: string, Field mask is used to specify the fields to be overwritten in the ApiConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

487

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

494

495

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

496

"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}`.

497

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

498

"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`.

499

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

500

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

501

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

502

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

503

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

504

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

505

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

506

{

507

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

508

},

509

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

510

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

511

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

512

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

518

<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

519

520

Args:

521

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

522

body: object, The request body.

523

The object takes the form of:

524

525

{ # Request message for `SetIamPolicy` method.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

526

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

527

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

528

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

529

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

530

{ # 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.

531

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

532

"A String",

533

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

534

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

535

},

536

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

537

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

538

},

539

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

540

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

541

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

542

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

543

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

544

"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`.

545

"A String",

546

],

547

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

548

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

549

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

550

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

551

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

552

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

553

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

554

"bindingId": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

555

},

556

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

557

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

558

"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"`

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

559

}

560

561

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

568

569

{ # 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/).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

570

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

571

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

572

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

573

{ # 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.

574

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

575

"A String",

576

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

577

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

578

},

579

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

580

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

581

},

582

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

583

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

584

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

585

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

586

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

587

"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`.

588

"A String",

589

],

590

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

591

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

592

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

593

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

594

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

595

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

596

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

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

597

"bindingId": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

598

},

599

],

Dmitry Frenkel