Govern Artifact Search #

The artifact search handler is used to search among artifacts.

Search for all the Govern Project artifacts #

import dataikuapi
from dataikuapi.govern.artifact_search import GovernArtifactSearchQuery, GovernArtifactFilterBlueprints

host = "http(s)://GOVERN_HOST:GOVERN_PORT"
apiKey = "Your API key secret"
client = dataikuapi.GovernClient(host, apiKey)

# build a query
govern_projects_query = GovernArtifactSearchQuery(artifact_filters=[GovernArtifactFilterBlueprints(blueprint_ids=['bp.system.govern_project'])])

# build a request
request = client.new_artifact_search_request(govern_projects_query)

# perform the search (first batch)
result_1 = request.fetch_next_batch()

# continue the search (next batch)...
result_2 = request.fetch_next_batch()

Reference documentation #

dataikuapi.govern.artifact_search.GovernArtifactSearchRequest (...)

A search request object.

dataikuapi.govern.artifact_search.GovernArtifactSearchResponse (...)

A search request response for a single batch.

dataikuapi.govern.artifact_search.GovernArtifactSearchResponseHit (...)

A search request response.

dataikuapi.govern.artifact_search.GovernArtifactSearchQuery ([...])

A definition of an artifact query.

dataikuapi.govern.artifact_search.GovernArtifactSearchSource (...)

An abstract class to represent the different search source.

dataikuapi.govern.artifact_search.GovernArtifactSearchSourceAll ()

A generic search source definition.

dataikuapi.govern.artifact_search.GovernArtifactSearchSort (...)

An abstract class to represent the different search sort.

dataikuapi.govern.artifact_search.GovernArtifactSearchSortName ([...])

An artifact sort definition based on their names.

dataikuapi.govern.artifact_search.GovernArtifactSearchSortWorkflow ([...])

An artifact sort defintion based on their workflow.

dataikuapi.govern.artifact_search.GovernArtifactSearchSortField ([...])

An artifact sort definition based on a list of fields.

dataikuapi.govern.artifact_search.GovernArtifactSearchSortFieldDefinition (...)

A field sort definition builder to use in a search query in order to sort on a field of a blueprint.

dataikuapi.govern.artifact_search.GovernArtifactFilter (...)

An abstract class to represent artifact filters.

dataikuapi.govern.artifact_search.GovernArtifactFilterBlueprints ([...])

An artifact filter definition based on a list of specific blueprints.

dataikuapi.govern.artifact_search.GovernArtifactFilterBlueprintVersions ([...])

An artifact filter definition based on a list of specific blueprint versions.

dataikuapi.govern.artifact_search.GovernArtifactFilterArtifacts ([...])

An artifact filter definition based on a list of specific artifacts.

dataikuapi.govern.artifact_search.GovernArtifactFilterFieldValue (...)

An artifact filter definition based on specific fields value.

dataikuapi.govern.artifact_search.GovernArtifactFilterArchivedStatus (...)

An artifact filter definition based on the archived status.