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
pub use crate::resources::common::{Entity, ProjectTeam, Role};
/// The BucketAccessControl resource represents the Access Control Lists (ACLs) for buckets within
/// Google Cloud Storage. ACLs let you specify who has access to your data and to what extent.
///
/// ```text,ignore
/// 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.
/// ```
///
/// There are three roles that can be assigned to an entity:
///
/// * READERs can get the bucket, though no acl property will be returned, and list the bucket's
/// objects.
/// * WRITERs are READERs, and they can insert objects into the bucket and delete the bucket's
/// objects.
/// * OWNERs are WRITERs, and they can get the acl property of a bucket, update a bucket, and call
/// all BucketAccessControl methods on the bucket.
#[derive(Debug, PartialEq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct BucketAccessControl {
/// The kind of item this is. For bucket access control entries, this is always
/// `storage#bucketAccessControl`.
pub kind: String,
/// The ID of the access-control entry.
pub id: String,
/// The link to this access-control entry.
pub self_link: String,
/// The name of the bucket.
pub bucket: 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,
}
/// Model that can be used to create a new BucketAccessControl object.
#[derive(Debug, PartialEq, serde::Serialize)]
#[serde(rename_all = "camelCase")]
pub struct NewBucketAccessControl {
/// 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 BucketAccessControl {
/// Create a new `BucketAccessControl` using the provided `NewBucketAccessControl`, related to
/// the `Bucket` provided by the `bucket_name` argument.
///
/// ### 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
/// ```rust,no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::bucket_access_control::{BucketAccessControl, NewBucketAccessControl};
/// use cloud_storage::bucket_access_control::{Role, Entity};
///
/// let new_bucket_access_control = NewBucketAccessControl {
/// entity: Entity::AllUsers,
/// role: Role::Reader,
/// };
/// BucketAccessControl::create("mybucket", &new_bucket_access_control).await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn create(
bucket: &str,
new_bucket_access_control: &NewBucketAccessControl,
) -> crate::Result<Self> {
crate::CLOUD_CLIENT
.bucket_access_control()
.create(bucket, new_bucket_access_control)
.await
}
/// The synchronous equivalent of `BucketAccessControl::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_bucket_access_control: &NewBucketAccessControl,
) -> crate::Result<Self> {
crate::runtime()?.block_on(Self::create(bucket, new_bucket_access_control))
}
/// Returns all `BucketAccessControl`s related to this 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
/// ```rust,no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::bucket_access_control::BucketAccessControl;
///
/// let acls = BucketAccessControl::list("mybucket").await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn list(bucket: &str) -> crate::Result<Vec<Self>> {
crate::CLOUD_CLIENT
.bucket_access_control()
.list(bucket)
.await
}
/// The synchronous equivalent of `BucketAccessControl::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))
}
/// Returns the ACL entry for the specified entity 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
/// ```rust,no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::bucket_access_control::{BucketAccessControl, Entity};
///
/// let controls = BucketAccessControl::read("mybucket", &Entity::AllUsers).await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn read(bucket: &str, entity: &Entity) -> crate::Result<Self> {
crate::CLOUD_CLIENT
.bucket_access_control()
.read(bucket, entity)
.await
}
/// The synchronous equivalent of `BucketAccessControl::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 this `BucketAccessControl`.
///
/// ### 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
/// ```rust,no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::bucket_access_control::{BucketAccessControl, Entity};
///
/// let mut acl = BucketAccessControl::read("mybucket", &Entity::AllUsers).await?;
/// acl.entity = Entity::AllAuthenticatedUsers;
/// acl.update().await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn update(&self) -> crate::Result<Self> {
crate::CLOUD_CLIENT
.bucket_access_control()
.update(self)
.await
}
/// The synchronous equivalent of `BucketAccessControl::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())
}
/// Permanently deletes the ACL entry for the specified entity 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
/// ```rust,no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::bucket_access_control::{BucketAccessControl, Entity};
///
/// let controls = BucketAccessControl::read("mybucket", &Entity::AllUsers).await?;
/// controls.delete().await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "global-client")]
pub async fn delete(self) -> crate::Result<()> {
crate::CLOUD_CLIENT
.bucket_access_control()
.delete(self)
.await
}
/// The synchronous equivalent of `BucketAccessControl::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) -> crate::Result<()> {
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_bucket_access_control = NewBucketAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
BucketAccessControl::create(&bucket.name, &new_bucket_access_control)
.await
.unwrap();
Ok(())
}
#[tokio::test]
async fn list() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket().await;
BucketAccessControl::list(&bucket.name).await?;
Ok(())
}
#[tokio::test]
async fn read() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket().await;
BucketAccessControl::read(&bucket.name, &Entity::AllUsers).await?;
Ok(())
}
#[tokio::test]
async fn update() -> Result<(), Box<dyn std::error::Error>> {
// use a seperate bucket to prevent synchronization issues
let bucket = crate::create_test_bucket("test-update-bucket-access-controls").await;
let new_bucket_access_control = NewBucketAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
BucketAccessControl::create(&bucket.name, &new_bucket_access_control).await?;
let mut acl = BucketAccessControl::read(&bucket.name, &Entity::AllUsers).await?;
acl.entity = Entity::AllAuthenticatedUsers;
acl.update().await?;
bucket.delete().await?;
Ok(())
}
#[tokio::test]
async fn delete() -> Result<(), Box<dyn std::error::Error>> {
// use a seperate bucket to prevent synchronization issues
let bucket = crate::create_test_bucket("test-delete-bucket-access-controls").await;
let new_bucket_access_control = NewBucketAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
BucketAccessControl::create(&bucket.name, &new_bucket_access_control).await?;
let acl = BucketAccessControl::read(&bucket.name, &Entity::AllUsers).await?;
acl.delete().await?;
bucket.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_bucket_access_control = NewBucketAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
BucketAccessControl::create_sync(&bucket.name, &new_bucket_access_control)?;
Ok(())
}
#[test]
fn list() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket_sync();
BucketAccessControl::list_sync(&bucket.name)?;
Ok(())
}
#[test]
fn read() -> Result<(), Box<dyn std::error::Error>> {
let bucket = crate::read_test_bucket_sync();
BucketAccessControl::read_sync(&bucket.name, &Entity::AllUsers)?;
Ok(())
}
#[test]
fn update() -> Result<(), Box<dyn std::error::Error>> {
// use a seperate bucket to prevent synchronization issues
let bucket = crate::create_test_bucket_sync("test-update-bucket-access-controls");
let new_bucket_access_control = NewBucketAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
BucketAccessControl::create_sync(&bucket.name, &new_bucket_access_control)?;
let mut acl = BucketAccessControl::read_sync(&bucket.name, &Entity::AllUsers)?;
acl.entity = Entity::AllAuthenticatedUsers;
acl.update_sync()?;
bucket.delete_sync()?;
Ok(())
}
#[test]
fn delete() -> Result<(), Box<dyn std::error::Error>> {
// use a seperate bucket to prevent synchronization issues
let bucket = crate::create_test_bucket_sync("test-delete-bucket-access-controls");
let new_bucket_access_control = NewBucketAccessControl {
entity: Entity::AllUsers,
role: Role::Reader,
};
BucketAccessControl::create_sync(&bucket.name, &new_bucket_access_control)?;
let acl = BucketAccessControl::read_sync(&bucket.name, &Entity::AllUsers)?;
acl.delete_sync()?;
bucket.delete_sync()?;
Ok(())
}
}
}