fmewebservices.FMENamedConnection

Inheritance diagram of fmewebservices.FMENamedConnection

FMENamedConnection.getId()

Gets the database generated id for this connection.

FMENamedConnection.getName()

Retrieves the name of this named connection, which is unique for the given authorized users.

FMENamedConnection.getOwnerName()

Gets the owner (user) of this named connection.

FMENamedConnection.getServiceName()

Gets the owner (user) of this named connection.

FMENamedConnection.getType()

Retrieves the type of the named connection.

FMENamedConnection.setId(name)

Sets the database generated id for this connection.

FMENamedConnection.setName(name)

Sets the name of this named connection, which is not committed to the DB until this named connection is passed back to the manager.

FMENamedConnection.setOwnerName(name)

Sets the owner (user) of this named connection.

class FMENamedConnection

FMENamedConnection class.

init()

FMENamedConnection is an abstract class. It cannot be created directly.

__init__(*args, **kwargs)
getId()

Gets the database generated id for this connection.

Return type:

str

Returns:

The database generated id for the named connection.

getName()

Retrieves the name of this named connection, which is unique for the given authorized users. This is the name given to the connection by the user.

Return type:

str

Returns:

The name of the named connection.

getOwnerName()

Gets the owner (user) of this named connection.

Return type:

str

Returns:

The owner of the named connection.

getServiceName()

Gets the owner (user) of this named connection.

Return type:

str

Returns:

The owner of the named connection.

getType()

Retrieves the type of the named connection.

Returns one of FME_NAMEDCONNECTION_DATABASE, FME_NAMEDCONNECTION_BASIC, FME_NAMEDCONNECTION_OAUTH, FME_NAMEDCONNECTION_TOKEN, or FME_NAMEDCONNECTION_WEBSERVICE.

Return type:

int

Returns:

The type of the named connection.

setId(name)

Sets the database generated id for this connection.

Parameters:

name (str) – The database generated id to set for the named connection.

Return type:

None

setName(name)

Sets the name of this named connection, which is not committed to the DB until this named connection is passed back to the manager.

Parameters:

name (str) – The name to set on the named connection.

Return type:

None

setOwnerName(name)

Sets the owner (user) of this named connection.

Parameters:

name (str) – The name to set as the owner of the named connection.

Return type:

None