Version API

Describes the current version of this client API. Current release is 3.0.0 Build(30) Revision(4659) Enterprise Edition.

  • Copyright 2019 Cloud Software Group, Inc. 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.

  • A copy of the License is included in the distribution package with this file.

  • You also 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.

  • File name : version.tag

  • Created on: 11/01/2019

  • Created by: Derek

  • SVN Id: $Id$

  • Determines version information.

  • This file is processed by GCC-Processor using -E and options.

  • Use C/C++ Style comments, both multiline and single line

  • This file is passed through C-Preprocesor, and Python comments are interpreted as C-Processor commands.

class tgdb.version.TGBuildEdition(value)

Represents the type of edition which determines what the usage for this API and server are.

class tgdb.version.TGBuildType(value)

The type of build. This determines how feature complete and thoroughly tested this particular release.

class tgdb.version.TGVersion(edition: tgdb.version.TGBuildEdition = None, typ: tgdb.version.TGBuildType = None)

Represents the over-all version of this API and server. This determines whether the server and client can communicate and what features are supported and how thoroughly tested this release is.

property buildNo

The build number for this release.

Returns

The build number.

Return type

int

property buildRev

The content repository revision for this build.

Returns

The repository revision.

Return type

int

property buildType

The type of this build.

Returns

The build edition.

Return type

TGBuildType

property edition

The edition for this build.

Returns

The build edition.

Return type

TGBuildEdition

classmethod getVersion(edition: Optional[tgdb.version.TGBuildEdition] = None, typ: Optional[tgdb.version.TGBuildType] = None)

Gets the current version.

Parameters

  • edition (TGBuildEdition) – The edition to set for the returned version.

  • typ (TGBuildType) – The type to set for the returned version.

Returns

The version.

Return type

TGVersion

getVersionStr()

Gets an acceptable build version that includes the major, minor, update, and build number.

Returns

A string with the build version.

Return type

str

property major

This is the major version number. This indicates what major features are introduced and that compatability is not necessarily guaranteed.

Returns

The major version number.

Return type

int

property minor

This is the minor version number. This indicates what minor features are introduced.

Returns

The minor version number.

Return type

int

classmethod readExternal(instream, reverse: bool = False)

Only intended for use within the Python API.

Parameters

  • instream – The in stream.

  • reverse – Whether to reverse the version bit-string.

Returns

Nothing

toUInt64() → int

Converts this version to a bit string.

Returns

The bit string representation of this version.

Return type

int

property update

This is the update version number. This indicates what incremental changes are introduced.

Returns

The update version number.

Return type

int

writeExternal(ostream)

Only intended for use within the Python API.

Parameters

ostream – The out stream.

Returns

Nothing