# frozen_string_literal: true

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Auto-generated by gapic-generator-ruby. DO NOT EDIT!


module Google
  module Cloud
    module Storage
      module Control
        module V2
          # Contains information about a pending rename operation.
          # @!attribute [r] operation
          #   @return [::String]
          #     Output only. The name of the rename operation.
          class PendingRenameInfo
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # A folder resource. This resource can only exist in a hierarchical namespace
          # enabled bucket.
          # @!attribute [rw] name
          #   @return [::String]
          #     Identifier. The name of this folder.
          #     Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
          # @!attribute [r] metageneration
          #   @return [::Integer]
          #     Output only. The version of the metadata for this folder. Used for
          #     preconditions and for detecting changes in metadata.
          # @!attribute [r] create_time
          #   @return [::Google::Protobuf::Timestamp]
          #     Output only. The creation time of the folder.
          # @!attribute [r] update_time
          #   @return [::Google::Protobuf::Timestamp]
          #     Output only. The modification time of the folder.
          # @!attribute [r] pending_rename_info
          #   @return [::Google::Cloud::Storage::Control::V2::PendingRenameInfo]
          #     Output only. Only present if the folder is part of an ongoing RenameFolder
          #     operation. Contains information which can be used to query the operation
          #     status. The presence of this field also indicates all write operations are
          #     blocked for this folder, including folder, managed folder, and object
          #     operations.
          class Folder
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # Request message for GetFolder. This operation is only applicable to a
          # hierarchical namespace enabled bucket.
          # @!attribute [rw] name
          #   @return [::String]
          #     Required. Name of the folder.
          #     Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
          # @!attribute [rw] if_metageneration_match
          #   @return [::Integer]
          #     Makes the operation only succeed conditional on whether the folder's
          #     current metageneration matches the given value.
          # @!attribute [rw] if_metageneration_not_match
          #   @return [::Integer]
          #     Makes the operation only succeed conditional on whether the folder's
          #     current metageneration does not match the given value.
          # @!attribute [rw] request_id
          #   @return [::String]
          #     Optional. A unique identifier for this request. UUID is the recommended
          #     format, but other formats are still accepted.
          class GetFolderRequest
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # Request message for CreateFolder. This operation is only applicable to a
          # hierarchical namespace enabled bucket.
          # @!attribute [rw] parent
          #   @return [::String]
          #     Required. Name of the bucket in which the folder will reside. The bucket
          #     must be a hierarchical namespace enabled bucket.
          # @!attribute [rw] folder
          #   @return [::Google::Cloud::Storage::Control::V2::Folder]
          #     Required. Properties of the new folder being created.
          #     The bucket and name of the folder are specified in the parent and folder_id
          #     fields, respectively. Populating those fields in `folder` will result in an
          #     error.
          # @!attribute [rw] folder_id
          #   @return [::String]
          #     Required. The full name of a folder, including all its parent folders.
          #     Folders use single '/' characters as a delimiter.
          #     The folder_id must end with a slash.
          #     For example, the folder_id of "books/biographies/" would create a new
          #     "biographies/" folder under the "books/" folder.
          # @!attribute [rw] recursive
          #   @return [::Boolean]
          #     Optional. If true, parent folder doesn't have to be present and all missing
          #     ancestor folders will be created atomically.
          # @!attribute [rw] request_id
          #   @return [::String]
          #     Optional. A unique identifier for this request. UUID is the recommended
          #     format, but other formats are still accepted.
          class CreateFolderRequest
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # Request message for DeleteFolder. This operation is only applicable to a
          # hierarchical namespace enabled bucket.
          # @!attribute [rw] name
          #   @return [::String]
          #     Required. Name of the folder.
          #     Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
          # @!attribute [rw] if_metageneration_match
          #   @return [::Integer]
          #     Makes the operation only succeed conditional on whether the folder's
          #     current metageneration matches the given value.
          # @!attribute [rw] if_metageneration_not_match
          #   @return [::Integer]
          #     Makes the operation only succeed conditional on whether the folder's
          #     current metageneration does not match the given value.
          # @!attribute [rw] request_id
          #   @return [::String]
          #     Optional. A unique identifier for this request. UUID is the recommended
          #     format, but other formats are still accepted.
          class DeleteFolderRequest
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # Request message for ListFolders. This operation is only applicable to a
          # hierarchical namespace enabled bucket.
          # @!attribute [rw] parent
          #   @return [::String]
          #     Required. Name of the bucket in which to look for folders. The bucket must
          #     be a hierarchical namespace enabled bucket.
          # @!attribute [rw] page_size
          #   @return [::Integer]
          #     Optional. Maximum number of folders to return in a single response. The
          #     service will use this parameter or 1,000 items, whichever is smaller.
          # @!attribute [rw] page_token
          #   @return [::String]
          #     Optional. A previously-returned page token representing part of the larger
          #     set of results to view.
          # @!attribute [rw] prefix
          #   @return [::String]
          #     Optional. Filter results to folders whose names begin with this prefix.
          #     If set, the value must either be an empty string or end with a '/'.
          # @!attribute [rw] delimiter
          #   @return [::String]
          #     Optional. If set, returns results in a directory-like mode. The results
          #     will only include folders that either exactly match the above prefix, or
          #     are one level below the prefix. The only supported value is '/'.
          # @!attribute [rw] lexicographic_start
          #   @return [::String]
          #     Optional. Filter results to folders whose names are lexicographically equal
          #     to or after lexicographic_start. If lexicographic_end is also set, the
          #     folders listed have names between lexicographic_start (inclusive) and
          #     lexicographic_end (exclusive).
          # @!attribute [rw] lexicographic_end
          #   @return [::String]
          #     Optional. Filter results to folders whose names are lexicographically
          #     before lexicographic_end. If lexicographic_start is also set, the folders
          #     listed have names between lexicographic_start (inclusive) and
          #     lexicographic_end (exclusive).
          # @!attribute [rw] request_id
          #   @return [::String]
          #     Optional. A unique identifier for this request. UUID is the recommended
          #     format, but other formats are still accepted.
          class ListFoldersRequest
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # Response message for ListFolders.
          # @!attribute [rw] folders
          #   @return [::Array<::Google::Cloud::Storage::Control::V2::Folder>]
          #     The list of child folders
          # @!attribute [rw] next_page_token
          #   @return [::String]
          #     The continuation token, used to page through large result sets. Provide
          #     this value in a subsequent request to return the next page of results.
          class ListFoldersResponse
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # Request message for RenameFolder. This operation is only applicable to a
          # hierarchical namespace enabled bucket.
          # @!attribute [rw] name
          #   @return [::String]
          #     Required. Name of the source folder being renamed.
          #     Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
          # @!attribute [rw] destination_folder_id
          #   @return [::String]
          #     Required. The destination folder ID, e.g. `foo/bar/`.
          # @!attribute [rw] if_metageneration_match
          #   @return [::Integer]
          #     Makes the operation only succeed conditional on whether the source
          #     folder's current metageneration matches the given value.
          # @!attribute [rw] if_metageneration_not_match
          #   @return [::Integer]
          #     Makes the operation only succeed conditional on whether the source
          #     folder's current metageneration does not match the given value.
          # @!attribute [rw] request_id
          #   @return [::String]
          #     Optional. A unique identifier for this request. UUID is the recommended
          #     format, but other formats are still accepted. This request is only
          #     idempotent if a `request_id` is provided.
          class RenameFolderRequest
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # The message contains metadata that is common to all Storage Control
          # long-running operations, present in its `google.longrunning.Operation`
          # messages, and accessible via `metadata.common_metadata`.
          # @!attribute [r] create_time
          #   @return [::Google::Protobuf::Timestamp]
          #     Output only. The time the operation was created.
          # @!attribute [r] end_time
          #   @return [::Google::Protobuf::Timestamp]
          #     Output only. The time the operation finished running.
          # @!attribute [r] update_time
          #   @return [::Google::Protobuf::Timestamp]
          #     Output only. The time the operation was last modified.
          # @!attribute [r] type
          #   @return [::String]
          #     Output only. The type of operation invoked.
          # @!attribute [r] requested_cancellation
          #   @return [::Boolean]
          #     Output only. Identifies whether the user has requested cancellation.
          # @!attribute [r] progress_percent
          #   @return [::Integer]
          #     Output only. The estimated progress of the operation in percentage [0,
          #     100]. The value -1 means the progress is unknown.
          class CommonLongRunningOperationMetadata
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # Message returned in the metadata field of the Operation resource for
          # RenameFolder operations.
          # @!attribute [rw] common_metadata
          #   @return [::Google::Cloud::Storage::Control::V2::CommonLongRunningOperationMetadata]
          #     Generic metadata for the long running operation.
          # @!attribute [rw] source_folder_id
          #   @return [::String]
          #     The path of the source folder.
          # @!attribute [rw] destination_folder_id
          #   @return [::String]
          #     The path of the destination folder.
          class RenameFolderMetadata
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # The storage layout configuration of a bucket.
          # @!attribute [r] name
          #   @return [::String]
          #     Output only. The name of the StorageLayout resource.
          #     Format: `projects/{project}/buckets/{bucket}/storageLayout`
          # @!attribute [r] location
          #   @return [::String]
          #     Output only. The location of the bucket.
          # @!attribute [r] location_type
          #   @return [::String]
          #     Output only. The location type of the bucket (region, dual-region,
          #     multi-region, etc).
          # @!attribute [r] custom_placement_config
          #   @return [::Google::Cloud::Storage::Control::V2::StorageLayout::CustomPlacementConfig]
          #     Output only. The data placement configuration for custom dual region. If
          #     there is no configuration, this is not a custom dual region bucket.
          # @!attribute [r] hierarchical_namespace
          #   @return [::Google::Cloud::Storage::Control::V2::StorageLayout::HierarchicalNamespace]
          #     Output only. The bucket's hierarchical namespace configuration. If there is
          #     no configuration, the hierarchical namespace is disabled.
          class StorageLayout
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # Configuration for Custom Dual Regions.  It should specify precisely two
            # eligible regions within the same Multiregion. More information on regions
            # may be found [https://cloud.google.com/storage/docs/locations][here].
            # @!attribute [rw] data_locations
            #   @return [::Array<::String>]
            #     List of locations to use for data placement.
            class CustomPlacementConfig
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end

            # Configuration for a bucket's hierarchical namespace feature.
            # @!attribute [rw] enabled
            #   @return [::Boolean]
            #     Enables the hierarchical namespace feature.
            class HierarchicalNamespace
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end
          end

          # Request message for GetStorageLayout.
          # @!attribute [rw] name
          #   @return [::String]
          #     Required. The name of the StorageLayout resource.
          #     Format: `projects/{project}/buckets/{bucket}/storageLayout`
          # @!attribute [rw] prefix
          #   @return [::String]
          #     An optional prefix used for permission check. It is useful when the caller
          #     only has limited permissions under a specific prefix.
          # @!attribute [rw] request_id
          #   @return [::String]
          #     Optional. A unique identifier for this request. UUID is the recommended
          #     format, but other formats are still accepted.
          class GetStorageLayoutRequest
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # A managed folder.
          # @!attribute [rw] name
          #   @return [::String]
          #     Identifier. The name of this managed folder.
          #     Format:
          #     `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
          # @!attribute [r] metageneration
          #   @return [::Integer]
          #     Output only. The metadata version of this managed folder. It increases
          #     whenever the metadata is updated. Used for preconditions and for detecting
          #     changes in metadata. Managed folders don't have a generation number.
          # @!attribute [r] create_time
          #   @return [::Google::Protobuf::Timestamp]
          #     Output only. The creation time of the managed folder.
          # @!attribute [r] update_time
          #   @return [::Google::Protobuf::Timestamp]
          #     Output only. The modification time of the managed folder.
          class ManagedFolder
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # Request message for GetManagedFolder.
          # @!attribute [rw] name
          #   @return [::String]
          #     Required. Name of the managed folder.
          #     Format:
          #     `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
          # @!attribute [rw] if_metageneration_match
          #   @return [::Integer]
          #     The operation succeeds conditional on the managed folder's current
          #     metageneration matching the value here specified.
          # @!attribute [rw] if_metageneration_not_match
          #   @return [::Integer]
          #     The operation succeeds conditional on the managed folder's current
          #     metageneration NOT matching the value here specified.
          # @!attribute [rw] request_id
          #   @return [::String]
          #     Optional. A unique identifier for this request. UUID is the recommended
          #     format, but other formats are still accepted.
          class GetManagedFolderRequest
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # Request message for CreateManagedFolder.
          # @!attribute [rw] parent
          #   @return [::String]
          #     Required. Name of the bucket this managed folder belongs to.
          # @!attribute [rw] managed_folder
          #   @return [::Google::Cloud::Storage::Control::V2::ManagedFolder]
          #     Required. Properties of the managed folder being created.
          #     The bucket and managed folder names are specified in the `parent` and
          #     `managed_folder_id` fields. Populating these fields in `managed_folder`
          #     will result in an error.
          # @!attribute [rw] managed_folder_id
          #   @return [::String]
          #     Required. The name of the managed folder. It uses a single `/` as delimiter
          #     and leading and trailing `/` are allowed.
          # @!attribute [rw] request_id
          #   @return [::String]
          #     Optional. A unique identifier for this request. UUID is the recommended
          #     format, but other formats are still accepted.
          class CreateManagedFolderRequest
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # DeleteManagedFolder RPC request message.
          # @!attribute [rw] name
          #   @return [::String]
          #     Required. Name of the managed folder.
          #     Format:
          #     `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
          # @!attribute [rw] if_metageneration_match
          #   @return [::Integer]
          #     The operation succeeds conditional on the managed folder's current
          #     metageneration matching the value here specified.
          # @!attribute [rw] if_metageneration_not_match
          #   @return [::Integer]
          #     The operation succeeds conditional on the managed folder's current
          #     metageneration NOT matching the value here specified.
          # @!attribute [rw] allow_non_empty
          #   @return [::Boolean]
          #     Allows deletion of a managed folder even if it is not empty.
          #     A managed folder is empty if it manages no child managed folders or
          #     objects. Caller must have permission for
          #     storage.managedFolders.setIamPolicy.
          # @!attribute [rw] request_id
          #   @return [::String]
          #     Optional. A unique identifier for this request. UUID is the recommended
          #     format, but other formats are still accepted.
          class DeleteManagedFolderRequest
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # Request message for ListManagedFolders.
          # @!attribute [rw] parent
          #   @return [::String]
          #     Required. Name of the bucket this managed folder belongs to.
          # @!attribute [rw] page_size
          #   @return [::Integer]
          #     Optional. Maximum number of managed folders to return in a single response.
          #     The service will use this parameter or 1,000 items, whichever is smaller.
          # @!attribute [rw] page_token
          #   @return [::String]
          #     Optional. A previously-returned page token representing part of the larger
          #     set of results to view.
          # @!attribute [rw] prefix
          #   @return [::String]
          #     Optional. Filter results to match managed folders with name starting with
          #     this prefix.
          # @!attribute [rw] request_id
          #   @return [::String]
          #     Optional. A unique identifier for this request. UUID is the recommended
          #     format, but other formats are still accepted.
          class ListManagedFoldersRequest
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end

          # Response message for ListManagedFolders.
          # @!attribute [rw] managed_folders
          #   @return [::Array<::Google::Cloud::Storage::Control::V2::ManagedFolder>]
          #     The list of matching managed folders
          # @!attribute [rw] next_page_token
          #   @return [::String]
          #     The continuation token, used to page through large result sets. Provide
          #     this value in a subsequent request to return the next page of results.
          class ListManagedFoldersResponse
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods
          end
        end
      end
    end
  end
end