models_v2.common_search_indexed_objects_params module¶
-
class
models_v2.common_search_indexed_objects_params.
CommonSearchIndexedObjectsParams
(object_type=None, protection_group_ids=None, storage_domain_ids=None, tenant_id=None, include_tenants=False, tags=None, snapshot_tags=None, pagination_cookie=None, count=None)[source]¶ Bases:
object
Implementation of the ‘Common Search Indexed Objects Params’ model.
Specifies the common params to search for indexed objects.
- Attributes:
- protection_group_ids (list of string): Specifies a list of Protection
Group ids to filter the indexed objects. If specified, the objects indexed by specified Protection Group ids will be returned.
- storage_domain_ids (list of long|int): Specifies the Storage Domain
ids to filter indexed objects for which Protection Groups are writing data to Cohesity Views on the specified Storage Domains.
- tenant_id (string): TenantId contains id of the tenant for which
objects are to be returned.
- include_tenants (bool): If true, the response will include objects
which belongs to all tenants which the current user has permission to see. Default value is false.
- tags (list of string): Specifies a list of tags. Only files containing
specified tags will be returned.
- snapshot_tags (list of string): Specifies a list of snapshot tags.
Only files containing specified snapshot tags will be returned.
- pagination_cookie (string): Specifies the pagination cookie with which
subsequent parts of the response can be fetched.
- count (int): Specifies the number of indexed obejcts to be fetched for
the specified pagination cookie.
- object_type (ObjectType1Enum): Specifies the object type to be
searched for.
-
classmethod
from_dictionary
(dictionary)[source]¶ Creates an instance of this model from a dictionary
- Args:
dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.
- Returns:
object: An instance of this structure class.