1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
// This file is @generated by prost-build.
/// A deny rule in an IAM deny policy.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DenyRule {
/// The identities that are prevented from using one or more permissions on
/// Google Cloud resources. This field can contain the following values:
///
/// * `principalSet://goog/public:all`: A special identifier that represents
/// any principal that is on the internet, even if they do not have a Google
/// Account or are not logged in.
///
/// * `principal://goog/subject/{email_id}`: A specific Google Account.
/// Includes Gmail, Cloud Identity, and Google Workspace user accounts. For
/// example, `principal://goog/subject/alice@example.com`.
///
/// * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific
/// Google Account that was deleted recently. For example,
/// `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If
/// the Google Account is recovered, this identifier reverts to the standard
/// identifier for a Google Account.
///
/// * `principalSet://goog/group/{group_id}`: A Google group. For example,
/// `principalSet://goog/group/admins@example.com`.
///
/// * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group
/// that was deleted recently. For example,
/// `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If
/// the Google group is restored, this identifier reverts to the standard
/// identifier for a Google group.
///
/// * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`:
/// A Google Cloud service account. For example,
/// `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`.
///
/// * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`:
/// A Google Cloud service account that was deleted recently. For example,
/// `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`.
/// If the service account is undeleted, this identifier reverts to the
/// standard identifier for a service account.
///
/// * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the
/// principals associated with the specified Google Workspace or Cloud
/// Identity customer ID. For example,
/// `principalSet://goog/cloudIdentityCustomerId/C01Abc35`.
#[prost(string, repeated, tag = "1")]
pub denied_principals: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The identities that are excluded from the deny rule, even if they are
/// listed in the `denied_principals`. For example, you could add a Google
/// group to the `denied_principals`, then exclude specific users who belong to
/// that group.
///
/// This field can contain the same values as the `denied_principals` field,
/// excluding `principalSet://goog/public:all`, which represents all users on
/// the internet.
#[prost(string, repeated, tag = "2")]
pub exception_principals: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The permissions that are explicitly denied by this rule. Each permission
/// uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}`
/// is the fully qualified domain name for the service. For example,
/// `iam.googleapis.com/roles.list`.
#[prost(string, repeated, tag = "3")]
pub denied_permissions: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Specifies the permissions that this rule excludes from the set of denied
/// permissions given by `denied_permissions`. If a permission appears in
/// `denied_permissions` _and_ in `exception_permissions` then it will _not_ be
/// denied.
///
/// The excluded permissions can be specified using the same syntax as
/// `denied_permissions`.
#[prost(string, repeated, tag = "4")]
pub exception_permissions: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The condition that determines whether this deny rule applies to a request.
/// If the condition expression evaluates to `true`, then the deny rule is
/// applied; otherwise, the deny rule is not applied.
///
/// Each deny rule is evaluated independently. If this deny rule does not apply
/// to a request, other deny rules might still apply.
///
/// The condition can use CEL functions that evaluate
/// [resource
/// tags](<https://cloud.google.com/iam/help/conditions/resource-tags>). Other
/// functions and operators are not supported.
#[prost(message, optional, tag = "5")]
pub denial_condition: ::core::option::Option<super::super::r#type::Expr>,
}
/// Data for an IAM policy.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Policy {
/// Immutable. The resource name of the `Policy`, which must be unique. Format:
/// `policies/{attachment_point}/denypolicies/{policy_id}`
///
///
/// The attachment point is identified by its URL-encoded full resource name,
/// which means that the forward-slash character, `/`, must be written as
/// `%2F`. For example,
/// `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`.
///
/// For organizations and folders, use the numeric ID in the full resource
/// name. For projects, requests can use the alphanumeric or the numeric ID.
/// Responses always contain the numeric ID.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Immutable. The globally unique ID of the `Policy`. Assigned automatically when the
/// `Policy` is created.
#[prost(string, tag = "2")]
pub uid: ::prost::alloc::string::String,
/// Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`.
#[prost(string, tag = "3")]
pub kind: ::prost::alloc::string::String,
/// A user-specified description of the `Policy`. This value can be up to 63
/// characters.
#[prost(string, tag = "4")]
pub display_name: ::prost::alloc::string::String,
/// A key-value map to store arbitrary metadata for the `Policy`. Keys
/// can be up to 63 characters. Values can be up to 255 characters.
#[prost(btree_map = "string, string", tag = "5")]
pub annotations: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// An opaque tag that identifies the current version of the `Policy`. IAM uses
/// this value to help manage concurrent updates, so they do not cause one
/// update to be overwritten by another.
///
/// If this field is present in a [CreatePolicy][] request, the value is
/// ignored.
#[prost(string, tag = "6")]
pub etag: ::prost::alloc::string::String,
/// Output only. The time when the `Policy` was created.
#[prost(message, optional, tag = "7")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The time when the `Policy` was last updated.
#[prost(message, optional, tag = "8")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted.
#[prost(message, optional, tag = "9")]
pub delete_time: ::core::option::Option<::prost_types::Timestamp>,
/// A list of rules that specify the behavior of the `Policy`. All of the rules
/// should be of the `kind` specified in the `Policy`.
#[prost(message, repeated, tag = "10")]
pub rules: ::prost::alloc::vec::Vec<PolicyRule>,
}
/// A single rule in a `Policy`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PolicyRule {
/// A user-specified description of the rule. This value can be up to 256
/// characters.
#[prost(string, tag = "1")]
pub description: ::prost::alloc::string::String,
#[prost(oneof = "policy_rule::Kind", tags = "2")]
pub kind: ::core::option::Option<policy_rule::Kind>,
}
/// Nested message and enum types in `PolicyRule`.
pub mod policy_rule {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Kind {
/// A rule for a deny policy.
#[prost(message, tag = "2")]
DenyRule(super::DenyRule),
}
}
/// Request message for `ListPolicies`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPoliciesRequest {
/// Required. The resource that the policy is attached to, along with the kind of policy
/// to list. Format:
/// `policies/{attachment_point}/denypolicies`
///
///
/// The attachment point is identified by its URL-encoded full resource name,
/// which means that the forward-slash character, `/`, must be written as
/// `%2F`. For example,
/// `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`.
///
/// For organizations and folders, use the numeric ID in the full resource
/// name. For projects, you can use the alphanumeric or the numeric ID.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of policies to return. IAM ignores this value and uses
/// the value 1000.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// A page token received in a [ListPoliciesResponse][google.iam.v2beta.ListPoliciesResponse]. Provide this token to
/// retrieve the next page.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for `ListPolicies`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListPoliciesResponse {
/// Metadata for the policies that are attached to the resource.
#[prost(message, repeated, tag = "1")]
pub policies: ::prost::alloc::vec::Vec<Policy>,
/// A page token that you can use in a [ListPoliciesRequest][google.iam.v2beta.ListPoliciesRequest] to retrieve the
/// next page. If this field is omitted, there are no additional pages.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for `GetPolicy`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetPolicyRequest {
/// Required. The resource name of the policy to retrieve. Format:
/// `policies/{attachment_point}/denypolicies/{policy_id}`
///
///
/// Use the URL-encoded full resource name, which means that the forward-slash
/// character, `/`, must be written as `%2F`. For example,
/// `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-policy`.
///
/// For organizations and folders, use the numeric ID in the full resource
/// name. For projects, you can use the alphanumeric or the numeric ID.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for `CreatePolicy`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreatePolicyRequest {
/// Required. The resource that the policy is attached to, along with the kind of policy
/// to create. Format: `policies/{attachment_point}/denypolicies`
///
///
/// The attachment point is identified by its URL-encoded full resource name,
/// which means that the forward-slash character, `/`, must be written as
/// `%2F`. For example,
/// `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`.
///
/// For organizations and folders, use the numeric ID in the full resource
/// name. For projects, you can use the alphanumeric or the numeric ID.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The policy to create.
#[prost(message, optional, tag = "2")]
pub policy: ::core::option::Option<Policy>,
/// The ID to use for this policy, which will become the final component of
/// the policy's resource name. The ID must contain 3 to 63 characters. It can
/// contain lowercase letters and numbers, as well as dashes (`-`) and periods
/// (`.`). The first character must be a lowercase letter.
#[prost(string, tag = "3")]
pub policy_id: ::prost::alloc::string::String,
}
/// Request message for `UpdatePolicy`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdatePolicyRequest {
/// Required. The policy to update.
///
/// To prevent conflicting updates, the `etag` value must match the value that
/// is stored in IAM. If the `etag` values do not match, the request fails with
/// a `409` error code and `ABORTED` status.
#[prost(message, optional, tag = "1")]
pub policy: ::core::option::Option<Policy>,
}
/// Request message for `DeletePolicy`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeletePolicyRequest {
/// Required. The resource name of the policy to delete. Format:
/// `policies/{attachment_point}/denypolicies/{policy_id}`
///
///
/// Use the URL-encoded full resource name, which means that the forward-slash
/// character, `/`, must be written as `%2F`. For example,
/// `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-policy`.
///
/// For organizations and folders, use the numeric ID in the full resource
/// name. For projects, you can use the alphanumeric or the numeric ID.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Optional. The expected `etag` of the policy to delete. If the value does not match
/// the value that is stored in IAM, the request fails with a `409` error code
/// and `ABORTED` status.
///
/// If you omit this field, the policy is deleted regardless of its current
/// `etag`.
#[prost(string, tag = "2")]
pub etag: ::prost::alloc::string::String,
}
/// Metadata for long-running `Policy` operations.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct PolicyOperationMetadata {
/// Timestamp when the `google.longrunning.Operation` was created.
#[prost(message, optional, tag = "1")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Generated client implementations.
pub mod policies_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// An interface for managing Identity and Access Management (IAM) policies.
#[derive(Debug, Clone)]
pub struct PoliciesClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> PoliciesClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> PoliciesClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
PoliciesClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Retrieves the policies of the specified kind that are attached to a
/// resource.
///
/// The response lists only policy metadata. In particular, policy rules are
/// omitted.
pub async fn list_policies(
&mut self,
request: impl tonic::IntoRequest<super::ListPoliciesRequest>,
) -> std::result::Result<
tonic::Response<super::ListPoliciesResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.iam.v2beta.Policies/ListPolicies",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.iam.v2beta.Policies", "ListPolicies"));
self.inner.unary(req, path, codec).await
}
/// Gets a policy.
pub async fn get_policy(
&mut self,
request: impl tonic::IntoRequest<super::GetPolicyRequest>,
) -> std::result::Result<tonic::Response<super::Policy>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.iam.v2beta.Policies/GetPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.iam.v2beta.Policies", "GetPolicy"));
self.inner.unary(req, path, codec).await
}
/// Creates a policy.
pub async fn create_policy(
&mut self,
request: impl tonic::IntoRequest<super::CreatePolicyRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.iam.v2beta.Policies/CreatePolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.iam.v2beta.Policies", "CreatePolicy"));
self.inner.unary(req, path, codec).await
}
/// Updates the specified policy.
///
/// You can update only the rules and the display name for the policy.
///
/// To update a policy, you should use a read-modify-write loop:
///
/// 1. Use [GetPolicy][google.iam.v2beta.Policies.GetPolicy] to read the current version of the policy.
/// 2. Modify the policy as needed.
/// 3. Use `UpdatePolicy` to write the updated policy.
///
/// This pattern helps prevent conflicts between concurrent updates.
pub async fn update_policy(
&mut self,
request: impl tonic::IntoRequest<super::UpdatePolicyRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.iam.v2beta.Policies/UpdatePolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.iam.v2beta.Policies", "UpdatePolicy"));
self.inner.unary(req, path, codec).await
}
/// Deletes a policy. This action is permanent.
pub async fn delete_policy(
&mut self,
request: impl tonic::IntoRequest<super::DeletePolicyRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.iam.v2beta.Policies/DeletePolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.iam.v2beta.Policies", "DeletePolicy"));
self.inner.unary(req, path, codec).await
}
}
}