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 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
// This file is @generated by prost-build.
/// A Folder in an Organization's resource hierarchy, used to
/// organize that Organization's resources.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Folder {
/// Output only. The resource name of the Folder.
/// Its format is `folders/{folder_id}`, for example: "folders/1234".
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The Folder’s parent's resource name.
/// Updates to the folder's parent must be performed via
/// [MoveFolder][google.cloud.resourcemanager.v2.Folders.MoveFolder].
#[prost(string, tag = "2")]
pub parent: ::prost::alloc::string::String,
/// The folder’s display name.
/// A folder’s display name must be unique amongst its siblings, e.g.
/// no two folders with the same parent can share the same display name.
/// The display name must start and end with a letter or digit, may contain
/// letters, digits, spaces, hyphens and underscores and can be no longer
/// than 30 characters. This is captured by the regular expression:
/// [\p{L}\p{N}](\[\p{L}\p{N}_- \]{0,28}\[\p{L}\p{N}\])?.
#[prost(string, tag = "3")]
pub display_name: ::prost::alloc::string::String,
/// Output only. The lifecycle state of the folder.
/// Updates to the lifecycle_state must be performed via
/// [DeleteFolder][google.cloud.resourcemanager.v2.Folders.DeleteFolder] and
/// [UndeleteFolder][google.cloud.resourcemanager.v2.Folders.UndeleteFolder].
#[prost(enumeration = "folder::LifecycleState", tag = "4")]
pub lifecycle_state: i32,
/// Output only. Timestamp when the Folder was created. Assigned by the server.
#[prost(message, optional, tag = "5")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Timestamp when the Folder was last modified.
#[prost(message, optional, tag = "6")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// Nested message and enum types in `Folder`.
pub mod folder {
/// Folder lifecycle states.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum LifecycleState {
/// Unspecified state.
Unspecified = 0,
/// The normal and active state.
Active = 1,
/// The folder has been marked for deletion by the user.
DeleteRequested = 2,
}
impl LifecycleState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
LifecycleState::Unspecified => "LIFECYCLE_STATE_UNSPECIFIED",
LifecycleState::Active => "ACTIVE",
LifecycleState::DeleteRequested => "DELETE_REQUESTED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"LIFECYCLE_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"ACTIVE" => Some(Self::Active),
"DELETE_REQUESTED" => Some(Self::DeleteRequested),
_ => None,
}
}
}
}
/// The ListFolders request message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFoldersRequest {
/// Required. The resource name of the Organization or Folder whose Folders are
/// being listed.
/// Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
/// Access to this method is controlled by checking the
/// `resourcemanager.folders.list` permission on the `parent`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Optional. The maximum number of Folders to return in the response.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Optional. A pagination token returned from a previous call to `ListFolders`
/// that indicates where this listing should continue from.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Optional. Controls whether Folders in the
/// [DELETE_REQUESTED][google.cloud.resourcemanager.v2.Folder.LifecycleState.DELETE_REQUESTED]
/// state should be returned. Defaults to false.
#[prost(bool, tag = "4")]
pub show_deleted: bool,
}
/// The ListFolders response message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFoldersResponse {
/// A possibly paginated list of Folders that are direct descendants of
/// the specified parent resource.
#[prost(message, repeated, tag = "1")]
pub folders: ::prost::alloc::vec::Vec<Folder>,
/// A pagination token returned from a previous call to `ListFolders`
/// that indicates from where listing should continue.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// The request message for searching folders.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchFoldersRequest {
/// Optional. The maximum number of folders to return in the response.
#[prost(int32, tag = "1")]
pub page_size: i32,
/// Optional. A pagination token returned from a previous call to `SearchFolders`
/// that indicates from where search should continue.
#[prost(string, tag = "2")]
pub page_token: ::prost::alloc::string::String,
/// Search criteria used to select the Folders to return.
/// If no search criteria is specified then all accessible folders will be
/// returned.
///
/// Query expressions can be used to restrict results based upon displayName,
/// lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`
/// can be used along with the suffix wildcard symbol `*`.
///
/// The displayName field in a query expression should use escaped quotes
/// for values that include whitespace to prevent unexpected behavior.
///
/// Some example queries are:
///
/// * Query `displayName=Test*` returns Folder resources whose display name
/// starts with "Test".
/// * Query `lifecycleState=ACTIVE` returns Folder resources with
/// `lifecycleState` set to `ACTIVE`.
/// * Query `parent=folders/123` returns Folder resources that have
/// `folders/123` as a parent resource.
/// * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active
/// Folder resources that have `folders/123` as a parent resource.
/// * Query `displayName=\\"Test String\\"` returns Folder resources with
/// display names that include both "Test" and "String".
#[prost(string, tag = "3")]
pub query: ::prost::alloc::string::String,
}
/// The response message for searching folders.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SearchFoldersResponse {
/// A possibly paginated folder search results.
/// the specified parent resource.
#[prost(message, repeated, tag = "1")]
pub folders: ::prost::alloc::vec::Vec<Folder>,
/// A pagination token returned from a previous call to `SearchFolders`
/// that indicates from where searching should continue.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// The GetFolder request message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetFolderRequest {
/// Required. The resource name of the Folder to retrieve.
/// Must be of the form `folders/{folder_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// The CreateFolder request message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateFolderRequest {
/// Required. The resource name of the new Folder's parent.
/// Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The Folder being created, only the display name will be consulted.
/// All other fields will be ignored.
#[prost(message, optional, tag = "2")]
pub folder: ::core::option::Option<Folder>,
}
/// The MoveFolder request message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MoveFolderRequest {
/// Required. The resource name of the Folder to move.
/// Must be of the form folders/{folder_id}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The resource name of the Folder or Organization to reparent
/// the folder under.
/// Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
#[prost(string, tag = "2")]
pub destination_parent: ::prost::alloc::string::String,
}
/// The request message for updating a folder's display name.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFolderRequest {
/// Required. The new definition of the Folder. It must include a
/// a `name` and `display_name` field. The other fields
/// will be ignored.
#[prost(message, optional, tag = "1")]
pub folder: ::core::option::Option<Folder>,
/// Required. Fields to be updated.
/// Only the `display_name` can be updated.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// The DeleteFolder request message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteFolderRequest {
/// Required. The resource name of the Folder to be deleted.
/// Must be of the form `folders/{folder_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Instructs DeleteFolderAction to delete a folder even when the folder is not
/// empty.
#[prost(bool, tag = "2")]
pub recursive_delete: bool,
}
/// The UndeleteFolder request message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UndeleteFolderRequest {
/// Required. The resource name of the Folder to undelete.
/// Must be of the form `folders/{folder_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Metadata describing a long running folder operation
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FolderOperation {
/// The display name of the folder.
#[prost(string, tag = "1")]
pub display_name: ::prost::alloc::string::String,
/// The type of this operation.
#[prost(enumeration = "folder_operation::OperationType", tag = "2")]
pub operation_type: i32,
/// The resource name of the folder's parent.
/// Only applicable when the operation_type is MOVE.
#[prost(string, tag = "3")]
pub source_parent: ::prost::alloc::string::String,
/// The resource name of the folder or organization we are either creating
/// the folder under or moving the folder to.
#[prost(string, tag = "4")]
pub destination_parent: ::prost::alloc::string::String,
}
/// Nested message and enum types in `FolderOperation`.
pub mod folder_operation {
/// The type of operation that failed.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum OperationType {
/// Operation type not specified.
Unspecified = 0,
/// A create folder operation.
Create = 1,
/// A move folder operation.
Move = 2,
}
impl OperationType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
OperationType::Unspecified => "OPERATION_TYPE_UNSPECIFIED",
OperationType::Create => "CREATE",
OperationType::Move => "MOVE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OPERATION_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"CREATE" => Some(Self::Create),
"MOVE" => Some(Self::Move),
_ => None,
}
}
}
}
/// Generated client implementations.
pub mod folders_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Manages Cloud Resource Folders.
/// Cloud Resource Folders can be used to organize the resources under an
/// organization and to control the IAM policies applied to groups of resources.
#[derive(Debug, Clone)]
pub struct FoldersClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> FoldersClient<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,
) -> FoldersClient<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,
{
FoldersClient::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
}
/// Lists the Folders that are direct descendants of supplied parent resource.
/// List provides a strongly consistent view of the Folders underneath
/// the specified parent resource.
/// List returns Folders sorted based upon the (ascending) lexical ordering
/// of their display_name.
/// The caller must have `resourcemanager.folders.list` permission on the
/// identified parent.
pub async fn list_folders(
&mut self,
request: impl tonic::IntoRequest<super::ListFoldersRequest>,
) -> std::result::Result<
tonic::Response<super::ListFoldersResponse>,
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.cloud.resourcemanager.v2.Folders/ListFolders",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.resourcemanager.v2.Folders",
"ListFolders",
),
);
self.inner.unary(req, path, codec).await
}
/// Search for folders that match specific filter criteria.
/// Search provides an eventually consistent view of the folders a user has
/// access to which meet the specified filter criteria.
///
/// This will only return folders on which the caller has the
/// permission `resourcemanager.folders.get`.
pub async fn search_folders(
&mut self,
request: impl tonic::IntoRequest<super::SearchFoldersRequest>,
) -> std::result::Result<
tonic::Response<super::SearchFoldersResponse>,
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.cloud.resourcemanager.v2.Folders/SearchFolders",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.resourcemanager.v2.Folders",
"SearchFolders",
),
);
self.inner.unary(req, path, codec).await
}
/// Retrieves a Folder identified by the supplied resource name.
/// Valid Folder resource names have the format `folders/{folder_id}`
/// (for example, `folders/1234`).
/// The caller must have `resourcemanager.folders.get` permission on the
/// identified folder.
pub async fn get_folder(
&mut self,
request: impl tonic::IntoRequest<super::GetFolderRequest>,
) -> std::result::Result<tonic::Response<super::Folder>, 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.cloud.resourcemanager.v2.Folders/GetFolder",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.resourcemanager.v2.Folders",
"GetFolder",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a Folder in the resource hierarchy.
/// Returns an Operation which can be used to track the progress of the
/// folder creation workflow.
/// Upon success the Operation.response field will be populated with the
/// created Folder.
///
/// In order to succeed, the addition of this new Folder must not violate
/// the Folder naming, height or fanout constraints.
///
/// + The Folder's display_name must be distinct from all other Folder's that
/// share its parent.
/// + The addition of the Folder must not cause the active Folder hierarchy
/// to exceed a height of 4. Note, the full active + deleted Folder hierarchy
/// is allowed to reach a height of 8; this provides additional headroom when
/// moving folders that contain deleted folders.
/// + The addition of the Folder must not cause the total number of Folders
/// under its parent to exceed 100.
///
/// If the operation fails due to a folder constraint violation, some errors
/// may be returned by the CreateFolder request, with status code
/// FAILED_PRECONDITION and an error description. Other folder constraint
/// violations will be communicated in the Operation, with the specific
/// PreconditionFailure returned via the details list in the Operation.error
/// field.
///
/// The caller must have `resourcemanager.folders.create` permission on the
/// identified parent.
pub async fn create_folder(
&mut self,
request: impl tonic::IntoRequest<super::CreateFolderRequest>,
) -> std::result::Result<
tonic::Response<super::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.cloud.resourcemanager.v2.Folders/CreateFolder",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.resourcemanager.v2.Folders",
"CreateFolder",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a Folder, changing its display_name.
/// Changes to the folder display_name will be rejected if they violate either
/// the display_name formatting rules or naming constraints described in
/// the [CreateFolder][google.cloud.resourcemanager.v2.Folders.CreateFolder] documentation.
///
/// The Folder's display name must start and end with a letter or digit,
/// may contain letters, digits, spaces, hyphens and underscores and can be
/// no longer than 30 characters. This is captured by the regular expression:
/// [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
/// The caller must have `resourcemanager.folders.update` permission on the
/// identified folder.
///
/// If the update fails due to the unique name constraint then a
/// PreconditionFailure explaining this violation will be returned
/// in the Status.details field.
pub async fn update_folder(
&mut self,
request: impl tonic::IntoRequest<super::UpdateFolderRequest>,
) -> std::result::Result<tonic::Response<super::Folder>, 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.cloud.resourcemanager.v2.Folders/UpdateFolder",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.resourcemanager.v2.Folders",
"UpdateFolder",
),
);
self.inner.unary(req, path, codec).await
}
/// Moves a Folder under a new resource parent.
/// Returns an Operation which can be used to track the progress of the
/// folder move workflow.
/// Upon success the Operation.response field will be populated with the
/// moved Folder.
/// Upon failure, a FolderOperationError categorizing the failure cause will
/// be returned - if the failure occurs synchronously then the
/// FolderOperationError will be returned via the Status.details field
/// and if it occurs asynchronously then the FolderOperation will be returned
/// via the Operation.error field.
/// In addition, the Operation.metadata field will be populated with a
/// FolderOperation message as an aid to stateless clients.
/// Folder moves will be rejected if they violate either the naming, height
/// or fanout constraints described in the
/// [CreateFolder][google.cloud.resourcemanager.v2.Folders.CreateFolder] documentation.
/// The caller must have `resourcemanager.folders.move` permission on the
/// folder's current and proposed new parent.
pub async fn move_folder(
&mut self,
request: impl tonic::IntoRequest<super::MoveFolderRequest>,
) -> std::result::Result<
tonic::Response<super::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.cloud.resourcemanager.v2.Folders/MoveFolder",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.resourcemanager.v2.Folders",
"MoveFolder",
),
);
self.inner.unary(req, path, codec).await
}
/// Requests deletion of a Folder. The Folder is moved into the
/// [DELETE_REQUESTED][google.cloud.resourcemanager.v2.Folder.LifecycleState.DELETE_REQUESTED] state
/// immediately, and is deleted approximately 30 days later. This method may
/// only be called on an empty Folder in the
/// [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.ACTIVE] state, where a Folder is empty if
/// it doesn't contain any Folders or Projects in the
/// [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.ACTIVE] state.
/// The caller must have `resourcemanager.folders.delete` permission on the
/// identified folder.
pub async fn delete_folder(
&mut self,
request: impl tonic::IntoRequest<super::DeleteFolderRequest>,
) -> std::result::Result<tonic::Response<super::Folder>, 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.cloud.resourcemanager.v2.Folders/DeleteFolder",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.resourcemanager.v2.Folders",
"DeleteFolder",
),
);
self.inner.unary(req, path, codec).await
}
/// Cancels the deletion request for a Folder. This method may only be
/// called on a Folder in the
/// [DELETE_REQUESTED][google.cloud.resourcemanager.v2.Folder.LifecycleState.DELETE_REQUESTED] state.
/// In order to succeed, the Folder's parent must be in the
/// [ACTIVE][google.cloud.resourcemanager.v2.Folder.LifecycleState.ACTIVE] state.
/// In addition, reintroducing the folder into the tree must not violate
/// folder naming, height and fanout constraints described in the
/// [CreateFolder][google.cloud.resourcemanager.v2.Folders.CreateFolder] documentation.
/// The caller must have `resourcemanager.folders.undelete` permission on the
/// identified folder.
pub async fn undelete_folder(
&mut self,
request: impl tonic::IntoRequest<super::UndeleteFolderRequest>,
) -> std::result::Result<tonic::Response<super::Folder>, 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.cloud.resourcemanager.v2.Folders/UndeleteFolder",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.resourcemanager.v2.Folders",
"UndeleteFolder",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets the access control policy for a Folder. The returned policy may be
/// empty if no such policy or resource exists. The `resource` field should
/// be the Folder's resource name, e.g. "folders/1234".
/// The caller must have `resourcemanager.folders.getIamPolicy` permission
/// on the identified folder.
pub async fn get_iam_policy(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::GetIamPolicyRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::iam::v1::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.cloud.resourcemanager.v2.Folders/GetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.resourcemanager.v2.Folders",
"GetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Sets the access control policy on a Folder, replacing any existing policy.
/// The `resource` field should be the Folder's resource name, e.g.
/// "folders/1234".
/// The caller must have `resourcemanager.folders.setIamPolicy` permission
/// on the identified folder.
pub async fn set_iam_policy(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::SetIamPolicyRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::iam::v1::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.cloud.resourcemanager.v2.Folders/SetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.resourcemanager.v2.Folders",
"SetIamPolicy",
),
);
self.inner.unary(req, path, codec).await
}
/// Returns permissions that a caller has on the specified Folder.
/// The `resource` field should be the Folder's resource name,
/// e.g. "folders/1234".
///
/// There are no permissions required for making this API call.
pub async fn test_iam_permissions(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::TestIamPermissionsRequest,
>,
) -> std::result::Result<
tonic::Response<
super::super::super::super::iam::v1::TestIamPermissionsResponse,
>,
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.cloud.resourcemanager.v2.Folders/TestIamPermissions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.resourcemanager.v2.Folders",
"TestIamPermissions",
),
);
self.inner.unary(req, path, codec).await
}
}
}