Google Cloud Storage C++ Client  1.32.1
A C++ Client Library for Google Cloud Storage
auto_finalize.h
Go to the documentation of this file.
1 // Copyright 2021 Google LLC
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_AUTO_FINALIZE_H
16 #define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_AUTO_FINALIZE_H
17 
18 #include "google/cloud/storage/internal/complex_option.h"
19 #include "google/cloud/storage/version.h"
20 #include <iosfwd>
21 
22 namespace google {
23 namespace cloud {
24 namespace storage {
25 inline namespace STORAGE_CLIENT_NS {
26 
27 enum class AutoFinalizeConfig {
28  kDisabled,
29  kEnabled,
30 };
31 
32 /**
33  * Control whether upload streams auto-finalize on destruction.
34  *
35  * Some applications need to disable auto-finalization of resumable uploads.
36  * This option (or rather the `AutoFinalizeDisabled()` helper) configures
37  * whether ObjectWriteStream objects finalize an upload when the object is
38  * destructed.
39  */
41  : public internal::ComplexOption<AutoFinalize, AutoFinalizeConfig> {
42  explicit AutoFinalize(AutoFinalizeConfig value) : ComplexOption(value) {}
44 
45  static char const* name() { return "auto-finalize"; }
46 };
47 
48 /// Configure a stream to automatically finalize an upload on destruction.
51 }
52 
53 /// Configure a stream to leave uploads pending (not finalized) on destruction.
56 }
57 
58 std::ostream& operator<<(std::ostream& os, AutoFinalize const& rhs);
59 
60 } // namespace STORAGE_CLIENT_NS
61 } // namespace storage
62 } // namespace cloud
63 } // namespace google
64 
65 #endif // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_AUTO_FINALIZE_H