models_v2.search_indexed_objects_request_params module

class models_v2.search_indexed_objects_request_params.SearchIndexedObjectsRequestParams(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, email_params=None, file_params=None, cassandra_params=None, couchbase_params=None, hbase_params=None, hive_params=None, mongodb_params=None, hdfs_params=None, public_folder_params=None)

Bases: object

Implementation of the ‘Search indexed objects request params.’ model.

Specifies the request parameters 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.

email_params (SearchEmailsRequestParams): Specifies the request

parameters to search for emails and email folders.

file_params (SearchFilesRequestParams): Specifies the request

parameters to search for files and file folders.

cassandra_params (CassandraParams): Specifies the parameters which are

specific for searching Cassandra objects.

couchbase_params (CouchbaseParams): Specifies the parameters which are

specific for searching Couchbase objects.

hbase_params (HbaseParams): Specifies the parameters which are

specific for searching Hbase objects.

hive_params (HiveParams): Specifies the parameters which are specific

for searching Hive objects.

mongodb_params (MongodbParams): Specifies the parameters which are

specific for searching MongoDB objects.

hdfs_params (HdfsParams): Specifies the parameters for searching HDFS

Folders and Files.

public_folder_params (SearchPublicFolderRequestParams): Specifies the

request parameters to search for Public Folder items.

classmethod from_dictionary(dictionary)

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.