159 lines
5.2 KiB
Python
159 lines
5.2 KiB
Python
# -*- coding: utf-8 -*- #
|
|
# Copyright 2015 Google LLC. All Rights Reserved.
|
|
#
|
|
# 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
|
|
#
|
|
# http://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.
|
|
"""Base template using which the apis_map.py is generated."""
|
|
|
|
from __future__ import absolute_import
|
|
from __future__ import division
|
|
from __future__ import unicode_literals
|
|
|
|
|
|
class APIDef(object):
|
|
"""Struct for info required to instantiate clients/messages for API versions.
|
|
|
|
Attributes:
|
|
apitools: ApitoolsClientDef for this API version.
|
|
gapic: GapicClientDef for this API version.
|
|
default_version: bool, Whether this API version is the default version for
|
|
the API.
|
|
enable_mtls: bool, Whether this API version supports mTLS.
|
|
mtls_endpoint_override: str, The mTLS endpoint for this API version. If
|
|
empty, the MTLS_BASE_URL in the API client will be used.
|
|
regional_endpoints: dict[str, str], The regional endpoints for this API
|
|
version. Dictionary maps location to endpoint URL.
|
|
"""
|
|
|
|
def __init__(self,
|
|
apitools=None,
|
|
gapic=None,
|
|
default_version=False,
|
|
enable_mtls=True,
|
|
mtls_endpoint_override='',
|
|
regional_endpoints=None):
|
|
self.apitools = apitools
|
|
self.gapic = gapic
|
|
self.default_version = default_version
|
|
self.enable_mtls = enable_mtls
|
|
self.mtls_endpoint_override = mtls_endpoint_override
|
|
self.regional_endpoints = regional_endpoints or {}
|
|
|
|
def __eq__(self, other):
|
|
return (isinstance(other, self.__class__) and
|
|
self.__dict__ == other.__dict__)
|
|
|
|
def __ne__(self, other):
|
|
return not self.__eq__(other)
|
|
|
|
def get_init_source(self):
|
|
src_fmt = 'APIDef({0}, {1}, {2}, {3}, "{4}")'
|
|
return src_fmt.format(self.apitools, self.gapic,
|
|
self.default_version,
|
|
self.enable_mtls, self.mtls_endpoint_override)
|
|
|
|
def __repr__(self):
|
|
return self.get_init_source()
|
|
|
|
|
|
class ApitoolsClientDef(object):
|
|
"""Struct for info required to instantiate clients/messages for API versions.
|
|
|
|
Attributes:
|
|
class_path: str, Path to the package containing api related modules.
|
|
client_classpath: str, Relative path to the client class for an API version.
|
|
client_full_classpath: str, Full path to the client class for an API
|
|
version.
|
|
messages_modulepath: str, Relative path to the messages module for an API
|
|
version.
|
|
messages_full_modulepath: str, Full path to the messages module for an API
|
|
version.
|
|
base_url: str, The base_url used for the default version of the API.
|
|
"""
|
|
|
|
def __init__(self,
|
|
class_path,
|
|
client_classpath,
|
|
messages_modulepath,
|
|
base_url):
|
|
self.class_path = class_path
|
|
self.client_classpath = client_classpath
|
|
self.messages_modulepath = messages_modulepath
|
|
self.base_url = base_url
|
|
|
|
@property
|
|
def client_full_classpath(self):
|
|
return self.class_path + '.' + self.client_classpath
|
|
|
|
@property
|
|
def messages_full_modulepath(self):
|
|
return self.class_path + '.' + self.messages_modulepath
|
|
|
|
def __eq__(self, other):
|
|
return (isinstance(other, self.__class__) and
|
|
self.__dict__ == other.__dict__)
|
|
|
|
def __ne__(self, other):
|
|
return not self.__eq__(other)
|
|
|
|
def get_init_source(self):
|
|
src_fmt = 'ApitoolsClientDef("{0}", "{1}", "{2}", "{3}")'
|
|
return src_fmt.format(self.class_path, self.client_classpath,
|
|
self.messages_modulepath, self.base_url)
|
|
|
|
def __repr__(self):
|
|
return self.get_init_source()
|
|
|
|
|
|
class GapicClientDef(object):
|
|
"""Struct for info required to instantiate clients/messages for API versions.
|
|
|
|
Attributes:
|
|
class_path: str, Path to the package containing api related modules.
|
|
client_full_classpath: str, Full path to the client class for an API
|
|
version.
|
|
async_client_full_classpath: str, Full path to the async client class for an
|
|
API version.
|
|
rest_client_full_classpath: str, Full path to the rest client class for an
|
|
API version.
|
|
"""
|
|
|
|
def __init__(self,
|
|
class_path):
|
|
self.class_path = class_path
|
|
|
|
@property
|
|
def client_full_classpath(self):
|
|
return self.class_path + '.client.GapicWrapperClient'
|
|
|
|
@property
|
|
def async_client_full_classpath(self):
|
|
return self.class_path + '.async_client.GapicWrapperClient'
|
|
|
|
@property
|
|
def rest_client_full_classpath(self):
|
|
return self.class_path + '.rest_client.GapicWrapperClient'
|
|
|
|
def __eq__(self, other):
|
|
return (isinstance(other, self.__class__) and
|
|
self.__dict__ == other.__dict__)
|
|
|
|
def __ne__(self, other):
|
|
return not self.__eq__(other)
|
|
|
|
def get_init_source(self):
|
|
src_fmt = 'GapicClientDef("{0}")'
|
|
return src_fmt.format(self.class_path)
|
|
|
|
def __repr__(self):
|
|
return self.get_init_source()
|