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
#![allow(unused_imports)]
pub use crate::resources::common::{Entity, ProjectTeam, Role};
use crate::{error::GoogleResponse, resources::common::ListResponse};
/// The DefaultObjectAccessControls resources represent the Access Control Lists (ACLs) applied to a
/// new object within Google Cloud Storage when no ACL was provided for that object. ACLs let you
/// specify who has access to your data and to what extent.
#[derive(Debug, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DefaultObjectAccessControl {
/// The kind of item this is. For object access control entries, this is always
/// storage#objectAccessControl.
pub kind: String,
/// The entity holding the permission, in one of the following forms:
///
/// * `user-userId`
/// * `user-email`
/// * `group-groupId`
/// * `group-email`
/// * `domain-domain`
/// * `project-team-projectId`
/// * `allUsers`
/// * `allAuthenticatedUsers`
///
/// Examples:
///
/// * The user liz@example.com would be user-liz@example.com.
/// * The group example@googlegroups.com would be group-example@googlegroups.com.
/// * To refer to all members of the G Suite for Business domain example.com, the entity would
/// be domain-example.com.
pub entity: Entity,
/// The access permission for the entity.
pub role: Role,
/// The email address associated with the entity, if any.
pub email: Option<String>,
/// The ID for the entity, if any.
pub entity_id: Option<String>,
/// The domain associated with the entity, if any.
pub domain: Option<String>,
/// The project team associated with the entity, if any.
pub project_team: Option<ProjectTeam>,
/// HTTP 1.1 Entity tag for the access-control entry.
pub etag: String,
/// The bucket this resource belongs to.
#[serde(default)]
pub bucket: String, // this field is not returned by Google, but we populate it manually for the
// convenience of the end user.
}
/// Model that can be used to create a new DefaultObjectAccessControl object.
#[derive(Debug, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct NewDefaultObjectAccessControl {
/// The entity holding the permission, in one of the following forms:
///
/// * `user-userId`
/// * `user-email`
/// * `group-groupId`
/// * `group-email`
/// * `domain-domain`
/// * `project-team-projectId`
/// * `allUsers`
/// * `allAuthenticatedUsers`
///
/// Examples:
///
/// * The user liz@example.com would be user-liz@example.com.
/// * The group example@googlegroups.com would be group-example@googlegroups.com.
/// * To refer to all members of the G Suite for Business domain example.com, the entity would
/// be domain-example.com.
pub entity: Entity,
/// The access permission for the entity.
pub role: Role,
}
impl DefaultObjectAccessControl {
/// Create a new `DefaultObjectAccessControl` entry on the specified bucket.
/// ### Important
/// Important: This method fails with a `400 Bad Request` response for buckets with uniform
/// bucket-level access enabled. Use `Bucket::get_iam_policy` and `Bucket::set_iam_policy` to
/// control access instead.
/// ### Example
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::default_object_access_control::{
/// DefaultObjectAccessControl, NewDefaultObjectAccessControl, Role, Entity,
/// };
///
/// let new_acl = NewDefaultObjectAccessControl {
/// entity: Entity::AllAuthenticatedUsers,
/// role: Role::Reader,
/// };
/// let default_acl = DefaultObjectAccessControl::create("mybucket", &new_acl).await?;
/// # default_acl.delete().await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn create(
bucket: &str,
new_acl: &NewDefaultObjectAccessControl,
) -> crate::Result<Self> {
crate::CLOUD_CLIENT
.default_object_access_control()
.create(bucket, new_acl)
.await
}
/// The synchronous equivalent of `DefautObjectAccessControl::create`.
///
/// ### Features
/// This function requires that the feature flag `sync` is enabled in `Cargo.toml`.
#[cfg(all(feature = "global-client", feature = "sync"))]
pub fn create_sync(
bucket: &str,
new_acl: &NewDefaultObjectAccessControl,
) -> crate::Result<Self> {
crate::runtime()?.block_on(Self::create(bucket, new_acl))
}
/// Retrieves default object ACL entries on the specified bucket.
/// ### Important
/// Important: This method fails with a `400 Bad Request` response for buckets with uniform
/// bucket-level access enabled. Use `Bucket::get_iam_policy` and `Bucket::set_iam_policy` to
/// control access instead.
/// ### Example
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::default_object_access_control::DefaultObjectAccessControl;
///
/// let default_acls = DefaultObjectAccessControl::list("mybucket").await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn list(bucket: &str) -> crate::Result<Vec<Self>> {
crate::CLOUD_CLIENT
.default_object_access_control()
.list(bucket)
.await
}
/// The synchronous equivalent of `DefautObjectAccessControl::list`.
///
/// ### Features
/// This function requires that the feature flag `sync` is enabled in `Cargo.toml`.
#[cfg(all(feature = "global-client", feature = "sync"))]
pub fn list_sync(bucket: &str) -> crate::Result<Vec<Self>> {
crate::runtime()?.block_on(Self::list(bucket))
}
/// Read a single `DefaultObjectAccessControl`.
/// The `bucket` argument is the name of the bucket whose `DefaultObjectAccessControl` is to be
/// read, and the `entity` argument is the entity holding the permission. Options are
/// Can be "user-`userId`", "user-`email_address`", "group-`group_id`", "group-`email_address`",
/// "allUsers", or "allAuthenticatedUsers".
/// ### Important
/// Important: This method fails with a `400 Bad Request` response for buckets with uniform
/// bucket-level access enabled. Use `Bucket::get_iam_policy` and `Bucket::set_iam_policy` to
/// control access instead.
/// ### Example
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::default_object_access_control::{DefaultObjectAccessControl, Entity};
///
/// let default_acl = DefaultObjectAccessControl::read("mybucket", &Entity::AllUsers).await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn read(bucket: &str, entity: &Entity) -> crate::Result<Self> {
crate::CLOUD_CLIENT
.default_object_access_control()
.read(bucket, entity)
.await
}
/// The synchronous equivalent of `DefautObjectAccessControl::read`.
///
/// ### Features
/// This function requires that the feature flag `sync` is enabled in `Cargo.toml`.
#[cfg(all(feature = "global-client", feature = "sync"))]
pub fn read_sync(bucket: &str, entity: &Entity) -> crate::Result<Self> {
crate::runtime()?.block_on(Self::read(bucket, entity))
}
/// Update the current `DefaultObjectAccessControl`.
/// ### Important
/// Important: This method fails with a `400 Bad Request` response for buckets with uniform
/// bucket-level access enabled. Use `Bucket::get_iam_policy` and `Bucket::set_iam_policy` to
/// control access instead.
/// ### Example
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::default_object_access_control::{DefaultObjectAccessControl, Entity};
///
/// let mut default_acl = DefaultObjectAccessControl::read("my_bucket", &Entity::AllUsers).await?;
/// default_acl.entity = Entity::AllAuthenticatedUsers;
/// default_acl.update().await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn update(&self) -> crate::Result<Self> {
crate::CLOUD_CLIENT
.default_object_access_control()
.update(self)
.await
}
/// The synchronous equivalent of `DefautObjectAccessControl::update`.
///
/// ### Features
/// This function requires that the feature flag `sync` is enabled in `Cargo.toml`.
#[cfg(all(feature = "global-client", feature = "sync"))]
pub fn update_sync(&self) -> crate::Result<Self> {
crate::runtime()?.block_on(self.update())
}
/// Delete this 'DefaultObjectAccessControl`.
/// ### Important
/// Important: This method fails with a `400 Bad Request` response for buckets with uniform
/// bucket-level access enabled. Use `Bucket::get_iam_policy` and `Bucket::set_iam_policy` to
/// control access instead.
/// ### Example
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::default_object_access_control::{DefaultObjectAccessControl, Entity};
///
/// let mut default_acl = DefaultObjectAccessControl::read("my_bucket", &Entity::AllUsers).await?;
/// default_acl.delete().await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn delete(self) -> Result<(), crate::Error> {
crate::CLOUD_CLIENT
.default_object_access_control()
.delete(self)
.await
}
/// The synchronous equivalent of `DefautObjectAccessControl::delete`.
///
/// ### Features
/// This function requires that the feature flag `sync` is enabled in `Cargo.toml`.
#[cfg(all(feature = "global-client", feature = "sync"))]
pub fn delete_sync(self) -> Result<(), crate::Error> {
crate::runtime()?.block_on(self.delete())
}
}
#[cfg(all(test, feature = "global-client"))]
mod tests {
use super::*;
#[tokio::test]
async fn create() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket().await;
let new_acl = NewDefaultObjectAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
DefaultObjectAccessControl::create(&bucket.name, &new_acl).await?;
Ok(())
}
#[tokio::test]
async fn read() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket().await;
NewDefaultObjectAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
DefaultObjectAccessControl::read(&bucket.name, &Entity::AllUsers).await?;
Ok(())
}
#[tokio::test]
async fn list() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket().await;
DefaultObjectAccessControl::list(&bucket.name).await?;
Ok(())
}
#[tokio::test]
async fn update() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket().await;
let new_acl = NewDefaultObjectAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
let mut default_acl = DefaultObjectAccessControl::create(&bucket.name, &new_acl).await?;
default_acl.entity = Entity::AllAuthenticatedUsers;
default_acl.update().await?;
Ok(())
}
#[tokio::test]
async fn delete() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket().await;
let default_acl =
DefaultObjectAccessControl::read(&bucket.name, &Entity::AllAuthenticatedUsers).await?;
default_acl.delete().await?;
Ok(())
}
#[cfg(all(feature = "global-client", feature = "sync"))]
mod sync {
use super::*;
#[test]
fn create() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket_sync();
let new_acl = NewDefaultObjectAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
DefaultObjectAccessControl::create_sync(&bucket.name, &new_acl)?;
Ok(())
}
#[test]
fn read() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket_sync();
let new_acl = NewDefaultObjectAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
DefaultObjectAccessControl::create_sync(&bucket.name, &new_acl)?;
DefaultObjectAccessControl::read_sync(&bucket.name, &Entity::AllUsers)?;
Ok(())
}
#[test]
fn list() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket_sync();
DefaultObjectAccessControl::list_sync(&bucket.name)?;
Ok(())
}
#[test]
fn update() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket_sync();
let new_acl = NewDefaultObjectAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
let mut default_acl = DefaultObjectAccessControl::create_sync(&bucket.name, &new_acl)?;
default_acl.entity = Entity::AllAuthenticatedUsers;
default_acl.update_sync()?;
Ok(())
}
#[test]
fn delete() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket_sync();
let new_acl = NewDefaultObjectAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
let acl = DefaultObjectAccessControl::create_sync(&bucket.name, &new_acl)?;
acl.delete_sync()?;
Ok(())
}
}
}