mstrio > object_management > search_enums

enum mstrio.object_management.search_enums.CertifiedStatus(value)

Bases: Enum

Enumeration that represents what can be passed in the certified_status attribute of the IServer quick search command.

Valid values are as follows:

ALL = <CertifiedStatus.ALL: 'ALL'>

CERTIFIED_ONLY = <CertifiedStatus.CERTIFIED_ONLY: 'CERTIFIED_ONLY'>

NOT_CERTIFIED_ONLY = <CertifiedStatus.NOT_CERTIFIED_ONLY: 'NOT_CERTIFIED_ONLY'>

OFF = <CertifiedStatus.OFF: 'OFF'>

enum mstrio.object_management.search_enums.SearchDomain(value)

Bases: IntEnum

Enumeration constants used to specify the search domains. More details can be found in EnumDSSXMLSearchDomain in a browser.

Member Type:

int

Valid values are as follows:

LOCAL = <SearchDomain.LOCAL: 1>

PROJECT = <SearchDomain.PROJECT: 2>

REPOSITORY = <SearchDomain.REPOSITORY: 3>

CONFIGURATION = <SearchDomain.CONFIGURATION: 4>

The Enum and its members also have the following methods:

as_integer_ratio()

Return a pair of integers, whose ratio is equal to the original int.

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

from_bytes(byteorder='big', *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.

signed

Indicates whether two’s complement is used to represent the integer.

is_integer()

Returns True. Exists for duck type compatibility with float.is_integer.

to_bytes(length=1, byteorder='big', *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

denominator

the denominator of a rational number in lowest terms

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

enum mstrio.object_management.search_enums.SearchPattern(value)

Bases: IntEnum

Enumeration constants used to specify searchType used to control BI Search. More details can be found in EnumDSSXMLSearchTypes in a browser.

Member Type:

int

Valid values are as follows:

CONTAINS_ANY_WORD = <SearchPattern.CONTAINS_ANY_WORD: 0>

BEGIN_WITH = <SearchPattern.BEGIN_WITH: 1>

EXACTLY = <SearchPattern.EXACTLY: 2>

BEGIN_WITH_PHRASE = <SearchPattern.BEGIN_WITH_PHRASE: 3>

CONTAINS = <SearchPattern.CONTAINS: 4>

END_WITH = <SearchPattern.END_WITH: 5>

The Enum and its members also have the following methods:

as_integer_ratio()

Return a pair of integers, whose ratio is equal to the original int.

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

from_bytes(byteorder='big', *, signed=False)

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.

signed

Indicates whether two’s complement is used to represent the integer.

is_integer()

Returns True. Exists for duck type compatibility with float.is_integer.

to_bytes(length=1, byteorder='big', *, signed=False)

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

denominator

the denominator of a rational number in lowest terms

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

enum mstrio.object_management.search_enums.SearchResultsFormat(value)

Bases: Enum

Enumeration constants used to specify the format to return from search functions.

Valid values are as follows:

LIST = <SearchResultsFormat.LIST: 'LIST'>

TREE = <SearchResultsFormat.TREE: 'TREE'>

enum mstrio.object_management.search_enums.SearchScope(value)

Bases: AutoUpperName

Enumeration constants used to specify the scope of the search with regard to System Managed Objects.

Valid values are as follows:

ROOTED = <SearchScope.ROOTED: 'ROOTED'>

NOT_MANAGED_ONLY = <SearchScope.NOT_MANAGED_ONLY: 'NOT_MANAGED_ONLY'>

MANAGED_ONLY = <SearchScope.MANAGED_ONLY: 'MANAGED_ONLY'>

ALL = <SearchScope.ALL: 'ALL'>