1 /* Copyright 2018 The TensorFlow Authors. All Rights Reserved. 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 16 #ifndef TENSORFLOW_CORE_PLATFORM_CLOUD_ZONE_PROVIDER_H_ 17 #define TENSORFLOW_CORE_PLATFORM_CLOUD_ZONE_PROVIDER_H_ 18 19 #include <string> 20 21 #include "tensorflow/core/platform/errors.h" 22 #include "tensorflow/core/platform/status.h" 23 24 namespace tensorflow { 25 26 /// Interface for a provider of cloud instance zone 27 class ZoneProvider { 28 public: ~ZoneProvider()29 virtual ~ZoneProvider() {} 30 31 /// \brief Gets the zone of the Cloud instance and set the result in `zone`. 32 /// Returns OK if success. 33 /// 34 /// Returns an empty string in the case where the zone does not match the 35 /// expected format 36 /// Safe for concurrent use by multiple threads. 37 virtual Status GetZone(string* zone) = 0; 38 GetZone(ZoneProvider * provider,string * zone)39 static Status GetZone(ZoneProvider* provider, string* zone) { 40 if (!provider) { 41 return errors::Internal("Zone provider is required."); 42 } 43 return provider->GetZone(zone); 44 } 45 }; 46 47 } // namespace tensorflow 48 49 #endif // TENSORFLOW_CORE_PLATFORM_CLOUD_ZONE_PROVIDER_H_ 50