Input objects
AcceptRoleInput
Input provided when accepting a DataHub role using an invite token
Arguments
Name | Description |
---|---|
inviteTokenString! | The token needed to accept the role |
ActorFilterInput
Input required when creating or updating an Access Policies Determines which actors the Policy applies to
Arguments
Name | Description |
---|---|
users[String!] | A disjunctive set of users to apply the policy to |
groups[String!] | A disjunctive set of groups to apply the policy to |
resourceOwnersBoolean! | Whether the filter should return TRUE for owners of a particular resource Only applies to policies of type METADATA, which have a resource associated with them |
allUsersBoolean! | Whether the filter should apply to all users |
allGroupsBoolean! | Whether the filter should apply to all groups |
AddGroupMembersInput
Input required to add members to an external DataHub group
Arguments
Name | Description |
---|---|
groupUrnString! | The group to add members to |
userUrns[String!]! | The members to add to the group |
AddLinkInput
Input provided when adding the association between a Metadata Entity and a Link
Arguments
Name | Description |
---|---|
linkUrlString! | The url of the link to add or remove |
labelString! | A label to attach to the link |
resourceUrnString! | The urn of the resource or entity to attach the link to, for example a dataset urn |
AddNativeGroupMembersInput
Input required to add members to a native DataHub group
Arguments
Name | Description |
---|---|
groupUrnString! | The group to add members to |
userUrns[String!]! | The members to add to the group |
AddOwnerInput
Input provided when adding the association between a Metadata Entity and an user or group owner
Arguments
Name | Description |
---|---|
ownerUrnString! | The primary key of the Owner to add or remove |
ownerEntityTypeOwnerEntityType! | The owner type, either a user or group |
typeOwnershipType | The ownership type for the new owner. If none is provided, then a new NONE will be added. |
resourceUrnString! | The urn of the resource or entity to attach or remove the owner from, for example a dataset urn |
AddOwnersInput
Input provided when adding multiple associations between a Metadata Entity and an user or group owner
Arguments
Name | Description |
---|---|
owners[OwnerInput!]! | The primary key of the Owner to add or remove |
resourceUrnString! | The urn of the resource or entity to attach or remove the owner from, for example a dataset urn |
AddTagsInput
Input provided when adding tags to an asset
Arguments
Name | Description |
---|---|
tagUrns[String!]! | The primary key of the Tags |
resourceUrnString! | The target Metadata Entity to add or remove the Tag to |
subResourceTypeSubResourceType | An optional type of a sub resource to attach the Tag to |
subResourceString | An optional sub resource identifier to attach the Tag to |
AddTermsInput
Input provided when adding Terms to an asset
Arguments
Name | Description |
---|---|
termUrns[String!]! | The primary key of the Glossary Term to add or remove |
resourceUrnString! | The target Metadata Entity to add or remove the Glossary Term from |
subResourceTypeSubResourceType | An optional type of a sub resource to attach the Glossary Term to |
subResourceString | An optional sub resource identifier to attach the Glossary Term to |
AndFilterInput
A list of disjunctive criterion for the filter. (or operation to combine filters)
Arguments
Name | Description |
---|---|
and[FacetFilterInput!] | A list of and criteria the filter applies to the query |
AspectParams
Params to configure what list of aspects should be fetched by the aspects property
Arguments
Name | Description |
---|---|
autoRenderOnlyBoolean | Only fetch auto render aspects |
AutoCompleteInput
Input for performing an auto completion query against a single Metadata Entity
Arguments
Name | Description |
---|---|
typeEntityType | Entity type to be autocompleted against |
queryString! | The raw query string |
fieldString | An optional entity field name to autocomplete on |
limitInt | The maximum number of autocomplete results to be returned |
filters[FacetFilterInput!] | Faceted filters applied to autocomplete results |
AutoCompleteMultipleInput
Input for performing an auto completion query against a a set of Metadata Entities
Arguments
Name | Description |
---|---|
types[EntityType!] | Entity types to be autocompleted against Optional, if none supplied, all searchable types will be autocompleted against |
queryString! | The raw query string |
fieldString | An optional field to autocomplete against |
limitInt | The maximum number of autocomplete results |
filters[FacetFilterInput!] | Faceted filters applied to autocomplete results |
BatchAddOwnersInput
Input provided when adding owners to a batch of assets
Arguments
Name | Description |
---|---|
owners[OwnerInput!]! | The primary key of the owners |
resources[ResourceRefInput]! | The target assets to attach the owners to |
BatchAddTagsInput
Input provided when adding tags to a batch of assets
Arguments
Name | Description |
---|---|
tagUrns[String!]! | The primary key of the Tags |
resources[ResourceRefInput!]! | The target assets to attach the tags to |
BatchAddTermsInput
Input provided when adding glossary terms to a batch of assets
Arguments
Name | Description |
---|---|
termUrns[String!]! | The primary key of the Glossary Terms |
resources[ResourceRefInput]! | The target assets to attach the glossary terms to |
BatchAssignRoleInput
Input provided when batch assigning a role to a list of users
Arguments
Name | Description |
---|---|
roleUrnString | The urn of the role to assign to the actors. If undefined, will remove the role. |
actors[String!]! | The urns of the actors to assign the role to |
BatchDatasetUpdateInput
Arguments provided to batch update Dataset entities
Arguments
Name | Description |
---|---|
urnString! | Primary key of the Dataset to which the update will be applied |
updateDatasetUpdateInput! | Arguments provided to update the Dataset |
BatchGetStepStatesInput
Input arguments required for fetching step states
Arguments
Name | Description |
---|---|
ids[String!]! | The unique ids for the steps to retrieve |
BatchRemoveOwnersInput
Input provided when removing owners from a batch of assets
Arguments
Name | Description |
---|---|
ownerUrns[String!]! | The primary key of the owners |
resources[ResourceRefInput]! | The target assets to remove the owners from |
BatchRemoveTagsInput
Input provided when removing tags from a batch of assets
Arguments
Name | Description |
---|---|
tagUrns[String!]! | The primary key of the Tags |
resources[ResourceRefInput]! | The target assets to remove the tags from |
BatchRemoveTermsInput
Input provided when removing glossary terms from a batch of assets
Arguments
Name | Description |
---|---|
termUrns[String!]! | The primary key of the Glossary Terms |
resources[ResourceRefInput]! | The target assets to remove the glossary terms from |
BatchSetDomainInput
Input provided when adding tags to a batch of assets
Arguments
Name | Description |
---|---|
domainUrnString | The primary key of the Domain, or null if the domain will be unset |
resources[ResourceRefInput!]! | The target assets to attach the Domain |
BatchUpdateDeprecationInput
Input provided when updating the deprecation status for a batch of assets.
Arguments
Name | Description |
---|---|
deprecatedBoolean! | Whether the Entity is marked as deprecated. |
decommissionTimeLong | Optional - The time user plan to decommission this entity |
noteString | Optional - Additional information about the entity deprecation plan |
resources[ResourceRefInput]! | The target assets to attach the tags to |
BatchUpdateSoftDeletedInput
Input provided when updating the soft-deleted status for a batch of assets
Arguments
Name | Description |
---|---|
urns[String!]! | The urns of the assets to soft delete |
deletedBoolean! | Whether to mark the asset as soft-deleted (hidden) |
BatchUpdateStepStatesInput
Input arguments required for updating step states
Arguments
Name | Description |
---|---|
states[StepStateInput!]! | Set of step states. If the id does not exist, it will be created. |
BrowseInput
Input required for browse queries
Arguments
Name | Description |
---|---|
typeEntityType! | The browse entity type |
path[String!] | The browse path |
startInt | The starting point of paginated results |
countInt | The number of elements included in the results |
filters[FacetFilterInput!] | Deprecated: Use `orFilters`- they are more expressive Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together. |
orFilters[AndFilterInput!] | A list of disjunctive criterion for the filter. (or operation to combine filters) |
BrowsePathsInput
Inputs for fetching the browse paths for a Metadata Entity
Arguments
Name | Description |
---|---|
typeEntityType! | The browse entity type |
urnString! | The entity urn |
CancelIngestionExecutionRequestInput
Input for cancelling an execution request input
Arguments
Name | Description |
---|---|
ingestionSourceUrnString! | Urn of the ingestion source |
executionRequestUrnString! | Urn of the specific execution request to cancel |
ChartEditablePropertiesUpdate
Update to writable Chart fields
Arguments
Name | Description |
---|---|
descriptionString! | Writable description aka documentation for a Chart |
ChartUpdateInput
Arguments provided to update a Chart Entity
Arguments
Name | Description |
---|---|
ownershipOwnershipUpdate | Update to ownership |
globalTagsGlobalTagsUpdate | Deprecated, use tags field instead Update to global tags |
tagsGlobalTagsUpdate | Update to tags |
editablePropertiesChartEditablePropertiesUpdate | Update to editable properties |
ContainerEntitiesInput
Input required to fetch the entities inside of a container.
Arguments
Name | Description |
---|---|
queryString | Optional query filter for particular entities inside the container |
startInt | The offset of the result set |
countInt | The number of entities to include in result set |
filters[FacetFilterInput!] | Optional Facet filters to apply to the result set |
CorpGroupUpdateInput
Arguments provided to update a CorpGroup Entity
Arguments
Name | Description |
---|---|
descriptionString | DataHub description of the group |
slackString | Slack handle for the group |
emailString | Email address for the group |
CorpUserUpdateInput
Arguments provided to update a CorpUser Entity
Arguments
Name | Description |
---|---|
displayNameString | Display name to show on DataHub |
titleString | Title to show on DataHub |
aboutMeString | About me section of the user |
teams[String!] | Teams that the user belongs to |
skills[String!] | Skills that the user possesses |
pictureLinkString | A URL which points to a picture which user wants to set as a profile photo |
slackString | The slack handle of the user |
phoneString | Phone number for the user |
emailString | Email address for the user |
CreateAccessTokenInput
Arguments
Name | Description |
---|---|
typeAccessTokenType! | The type of the Access Token. |
actorUrnString! | The actor associated with the Access Token. |
durationAccessTokenDuration! | The duration for which the Access Token is valid. |
nameString! | The name of the token to be generated. |
descriptionString | Description of the token if defined. |
CreateDomainInput
Input required to create a new Domain.
Arguments
Name | Description |
---|---|
idString | Optional! A custom id to use as the primary key identifier for the domain. If not provided, a random UUID will be generated as the id. |
nameString! | Display name for the Domain |
descriptionString | Optional description for the Domain |
CreateGlossaryEntityInput
Input required to create a new Glossary Entity - a Node or a Term.
Arguments
Name | Description |
---|---|
idString | Optional! A custom id to use as the primary key identifier for the domain. If not provided, a random UUID will be generated as the id. |
nameString! | Display name for the Node or Term |
descriptionString | Description for the Node or Term |
parentNodeString | Optional parent node urn for the Glossary Node or Term |
CreateGroupInput
Input for creating a new group
Arguments
Name | Description |
---|---|
idString | Optional! A custom id to use as the primary key identifier for the group. If not provided, a random UUID will be generated as the id. |
nameString! | The display name of the group |
descriptionString | The description of the group |
CreateIngestionExecutionRequestInput
Input for creating an execution request input
Arguments
Name | Description |
---|---|
ingestionSourceUrnString! | Urn of the ingestion source to execute |
CreateInviteTokenInput
Input provided when creating an invite token
Arguments
Name | Description |
---|---|
roleUrnString | The urn of the role to create the invite token for |
CreateNativeUserResetTokenInput
Input required to generate a password reset token for a native user.
Arguments
Name | Description |
---|---|
userUrnString! | The urn of the user to reset the password of |
CreatePostInput
Input provided when creating a Post
Arguments
Name | Description |
---|---|
postTypePostType! | The type of post |
contentUpdatePostContentInput! | The content of the post |
CreateQueryInput
Input required for creating a Query. Requires the 'Edit Queries' privilege for all query subjects.
Arguments
Name | Description |
---|---|
propertiesCreateQueryPropertiesInput! | Properties about the Query |
subjects[CreateQuerySubjectInput!]! | Subjects for the query |
CreateQueryPropertiesInput
Input properties required for creating a Query
Arguments
Name | Description |
---|---|
nameString | An optional display name for the Query |
descriptionString | An optional description for the Query |
statementQueryStatementInput! | The Query contents |
CreateQuerySubjectInput
Input required for creating a Query. For now, only datasets are supported.
Arguments
Name | Description |
---|---|
datasetUrnString! | The urn of the dataset that is the subject of the query |
CreateSecretInput
Input arguments for creating a new Secret
Arguments
Name | Description |
---|---|
nameString! | The name of the secret for reference in ingestion recipes |
valueString! | The value of the secret, to be encrypted and stored |
descriptionString | An optional description for the secret |
CreateTagInput
Input required to create a new Tag
Arguments
Name | Description |
---|---|
idString | Optional! A custom id to use as the primary key identifier for the Tag. If not provided, a random UUID will be generated as the id. |
nameString! | Display name for the Tag |
descriptionString | Optional description for the Tag |
CreateTestConnectionRequestInput
Input for creating a test connection request
Arguments
Name | Description |
---|---|
recipeString! | A JSON-encoded recipe |
versionString | Advanced: The version of the ingestion framework to use |
CreateTestInput
Arguments
Name | Description |
---|---|
idString | Advanced: a custom id for the test. |
nameString! | The name of the Test |
categoryString! | The category of the Test (user defined) |
descriptionString | Description of the test |
definitionTestDefinitionInput! | The test definition |
CreateViewInput
Input provided when creating a DataHub View
Arguments
Name | Description |
---|---|
viewTypeDataHubViewType! | The type of View |
nameString! | The name of the View |
descriptionString | An optional description of the View |
definitionDataHubViewDefinitionInput! | The view definition itself |
DashboardEditablePropertiesUpdate
Update to writable Dashboard fields
Arguments
Name | Description |
---|---|
descriptionString! | Writable description aka documentation for a Dashboard |
DashboardUpdateInput
Arguments provided to update a Dashboard Entity
Arguments
Name | Description |
---|---|
ownershipOwnershipUpdate | Update to ownership |
globalTagsGlobalTagsUpdate | Deprecated, use tags field instead Update to global tags |
tagsGlobalTagsUpdate | Update to tags |
editablePropertiesDashboardEditablePropertiesUpdate | Update to editable properties |
DataFlowEditablePropertiesUpdate
Update to writable Data Flow fields
Arguments
Name | Description |
---|---|
descriptionString! | Writable description aka documentation for a Data Flow |
DataFlowUpdateInput
Arguments provided to update a Data Flow aka Pipeline Entity
Arguments
Name | Description |
---|---|
ownershipOwnershipUpdate | Update to ownership |
globalTagsGlobalTagsUpdate | Deprecated, use tags field instead Update to global tags |
tagsGlobalTagsUpdate | Update to tags |
editablePropertiesDataFlowEditablePropertiesUpdate | Update to editable properties |
DataHubViewDefinitionInput
Input required for creating a DataHub View Definition
Arguments
Name | Description |
---|---|
entityTypes[EntityType!]! | A set of entity types that the view applies for. If left empty, then ALL entities will be in scope. |
filterDataHubViewFilterInput! | A set of filters to apply. |
DataHubViewFilterInput
Input required for creating a DataHub View Definition
Arguments
Name | Description |
---|---|
operatorLogicalOperator! | The operator used to combine the filters. |
filters[FacetFilterInput!]! | A set of filters combined via an operator. If left empty, then no filters will be applied. |
DataJobEditablePropertiesUpdate
Update to writable Data Job fields
Arguments
Name | Description |
---|---|
descriptionString! | Writable description aka documentation for a Data Job |
DataJobUpdateInput
Arguments provided to update a Data Job aka Task Entity
Arguments
Name | Description |
---|---|
ownershipOwnershipUpdate | Update to ownership |
globalTagsGlobalTagsUpdate | Deprecated, use tags field instead Update to global tags |
tagsGlobalTagsUpdate | Update to tags |
editablePropertiesDataJobEditablePropertiesUpdate | Update to editable properties |
DatasetDeprecationUpdate
An update for the deprecation information for a Metadata Entity
Arguments
Name | Description |
---|---|
deprecatedBoolean! | Whether the dataset is deprecated |
decommissionTimeLong | The time user plan to decommission this dataset |
noteString! | Additional information about the dataset deprecation plan |
DatasetEditablePropertiesUpdate
Update to writable Dataset fields
Arguments
Name | Description |
---|---|
descriptionString! | Writable description aka documentation for a Dataset |
DatasetUpdateInput
Arguments provided to update a Dataset Entity
Arguments
Name | Description |
---|---|
ownershipOwnershipUpdate | Update to ownership |
deprecationDatasetDeprecationUpdate | Update to deprecation status |
institutionalMemoryInstitutionalMemoryUpdate | Update to institutional memory, ie documentation |
globalTagsGlobalTagsUpdate | Deprecated, use tags field instead Update to global tags |
tagsGlobalTagsUpdate | Update to tags |
editableSchemaMetadataEditableSchemaMetadataUpdate | Update to editable schema metadata of the dataset |
editablePropertiesDatasetEditablePropertiesUpdate | Update to editable properties |
DescriptionUpdateInput
Incubating. Updates the description of a resource. Currently supports DatasetField descriptions only
Arguments
Name | Description |
---|---|
descriptionString! | The new description |
resourceUrnString! | The primary key of the resource to attach the description to, eg dataset urn |
subResourceTypeSubResourceType | An optional sub resource type |
subResourceString | A sub resource identifier, eg dataset field path |
DomainEntitiesInput
Input required to fetch the entities inside of a Domain.
Arguments
Name | Description |
---|---|
queryString | Optional query filter for particular entities inside the domain |
startInt | The offset of the result set |
countInt | The number of entities to include in result set |
filters[FacetFilterInput!] | Optional Facet filters to apply to the result set |
EditableSchemaFieldInfoUpdate
Update to writable schema field metadata
Arguments
Name | Description |
---|---|
fieldPathString! | Flattened name of a field identifying the field the editable info is applied to |
descriptionString | Edited description of the field |
globalTagsGlobalTagsUpdate | Tags associated with the field |
EditableSchemaMetadataUpdate
Update to editable schema metadata of the dataset
Arguments
Name | Description |
---|---|
editableSchemaFieldInfo[EditableSchemaFieldInfoUpdate!]! | Update to writable schema field metadata |
EntityCountInput
Input for the get entity counts endpoint
Arguments
Name | Description |
---|---|
types[EntityType!] |
EntityRequestContext
Context that defines an entity page requesting recommendations
Arguments
Name | Description |
---|---|
typeEntityType! | Type of the enity being displayed |
urnString! | Urn of the entity being displayed |
FacetFilterInput
Facet filters to apply to search results
Arguments
Name | Description |
---|---|
fieldString! | Name of field to filter by |
valueString | Deprecated: Prefer `values` for single elements Value of the field to filter by. Deprecated in favor of |
values[String!] | Values, one of which the intended field should match. |
negatedBoolean | If the filter should or should not be matched |
conditionFilterOperator | Condition for the values. How to If unset, assumed to be equality |
FilterInput
A set of filter criteria
Arguments
Name | Description |
---|---|
and[FacetFilterInput!]! | A list of conjunctive filters |
GetAccessTokenInput
Input required to fetch a new Access Token.
Arguments
Name | Description |
---|---|
typeAccessTokenType! | The type of the Access Token. |
actorUrnString! | The actor associated with the Access Token. |
durationAccessTokenDuration! | The duration for which the Access Token is valid. |
GetGrantedPrivilegesInput
Input for getting granted privileges
Arguments
Name | Description |
---|---|
actorUrnString! | Urn of the actor |
resourceSpecResourceSpec | Spec to identify resource. If empty, gets privileges granted to the actor |
GetInviteTokenInput
Input provided when getting an invite token
Arguments
Name | Description |
---|---|
roleUrnString | The urn of the role to get the invite token for |
GetRootGlossaryEntitiesInput
Input required when getting Business Glossary entities
Arguments
Name | Description |
---|---|
startInt! | The starting offset of the result set returned |
countInt! | The number of Glossary Entities in the returned result set |
GetSchemaBlameInput
Input for getting schema changes computed at a specific version.
Arguments
Name | Description |
---|---|
datasetUrnString! | The dataset urn |
versionString | Changes after this version are not shown. If not provided, this is the latestVersion. |
GetSchemaVersionListInput
Input for getting list of schema versions.
Arguments
Name | Description |
---|---|
datasetUrnString! | The dataset urn |
GetSecretValuesInput
Input arguments for retrieving the plaintext values of a set of secrets
Arguments
Name | Description |
---|---|
secrets[String!]! | A list of secret names |
GlobalTagsUpdate
Deprecated, use addTag or removeTag mutation instead Update to the Tags associated with a Metadata Entity
Arguments
Name | Description |
---|---|
tags[TagAssociationUpdate!] | The new set of tags |
InstitutionalMemoryMetadataUpdate
An institutional memory to add to a Metadata Entity TODO Add a USER or GROUP actor enum
Arguments
Name | Description |
---|---|
urlString! | Link to a document or wiki page or another internal resource |
descriptionString | Description of the resource |
authorString! | The corp user urn of the author of the metadata |
createdAtLong | The time at which this metadata was created |
InstitutionalMemoryUpdate
An update for the institutional memory information for a Metadata Entity
Arguments
Name | Description |
---|---|
elements[InstitutionalMemoryMetadataUpdate!]! | The individual references in the institutional memory |
LineageEdge
Arguments
Name | Description |
---|---|
downstreamUrnString! | Urn of the source entity. This urn is downstream of the destinationUrn. |
upstreamUrnString! | Urn of the destination entity. This urn is upstream of the destinationUrn |
LineageInput
Input for the list lineage property of an Entity
Arguments
Name | Description |
---|---|
directionLineageDirection! | The direction of the relationship, either incoming or outgoing from the source entity |
startInt | The starting offset of the result set |
countInt | The number of results to be returned |
separateSiblingsBoolean | Optional flag to not merge siblings in the response. They are merged by default. |
startTimeMillisLong | An optional starting time to filter on |
endTimeMillisLong | An optional ending time to filter on |
ListAccessTokenInput
Input arguments for listing access tokens
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set |
countInt | The number of results to be returned |
filters[FacetFilterInput!] | Facet filters to apply to search results |
ListDomainsInput
Input required when listing DataHub Domains
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set returned |
countInt | The maximum number of Domains to be returned in the result set |
queryString | Optional search query |
ListGlobalViewsInput
Input provided when listing DataHub Global Views
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set returned |
countInt | The maximum number of Views to be returned in the result set |
queryString | Optional search query |
ListGroupsInput
Input required when listing DataHub Groups
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set returned |
countInt | The maximum number of Policies to be returned in the result set |
queryString | Optional search query |
ListIngestionSourcesInput
Input arguments for listing Ingestion Sources
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set |
countInt | The number of results to be returned |
queryString | An optional search query |
ListMyViewsInput
Input provided when listing DataHub Views
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set returned |
countInt | The maximum number of Views to be returned in the result set |
queryString | Optional search query |
viewTypeDataHubViewType | Optional - List the type of View to filter for. |
ListPoliciesInput
Input required when listing DataHub Access Policies
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set returned |
countInt | The maximum number of Policies to be returned in the result set |
queryString | Optional search query |
ListPostsInput
Input provided when listing existing posts
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set returned |
countInt | The maximum number of Roles to be returned in the result set |
queryString | Optional search query |
ListQueriesInput
Input required for listing query entities
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set returned |
countInt | The maximum number of Queries to be returned in the result set |
queryString | A raw search query |
sourceQuerySource | An optional source for the query |
datasetUrnString | An optional Urn for the parent dataset that the query is associated with. |
ListRecommendationsInput
Input arguments for fetching UI recommendations
Arguments
Name | Description |
---|---|
userUrnString! | Urn of the actor requesting recommendations |
requestContextRecommendationRequestContext | Context provider by the caller requesting recommendations |
limitInt | Max number of modules to return |
ListRolesInput
Input provided when listing existing roles
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set returned |
countInt | The maximum number of Roles to be returned in the result set |
queryString | Optional search query |
ListSecretsInput
Input for listing DataHub Secrets
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set |
countInt | The number of results to be returned |
queryString | An optional search query |
ListTestsInput
Input required when listing DataHub Tests
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set returned |
countInt | The maximum number of Domains to be returned in the result set |
queryString | Optional query string to match on |
ListUsersInput
Input required when listing DataHub Users
Arguments
Name | Description |
---|---|
startInt | The starting offset of the result set returned |
countInt | The maximum number of Policies to be returned in the result set |
queryString | Optional search query |
MetadataAnalyticsInput
Input to fetch metadata analytics charts
Arguments
Name | Description |
---|---|
entityTypeEntityType | Entity type to fetch analytics for (If empty, queries across all entities) |
domainString | Urn of the domain to fetch analytics for (If empty or GLOBAL, queries across all domains) |
queryString | Search query to filter down result (If empty, does not apply any search query) |
NotebookEditablePropertiesUpdate
Update to writable Notebook fields
Arguments
Name | Description |
---|---|
descriptionString! | Writable description aka documentation for a Notebook |
NotebookUpdateInput
Arguments provided to update a Notebook Entity
Arguments
Name | Description |
---|---|
ownershipOwnershipUpdate | Update to ownership |
tagsGlobalTagsUpdate | Update to tags |
editablePropertiesNotebookEditablePropertiesUpdate | Update to editable properties |
OwnerInput
Input provided when adding an owner to an asset
Arguments
Name | Description |
---|---|
ownerUrnString! | The primary key of the Owner to add or remove |
ownerEntityTypeOwnerEntityType! | The owner type, either a user or group |
typeOwnershipType | The ownership type for the new owner. If none is provided, then a new NONE will be added. |
OwnershipUpdate
An update for the ownership information for a Metadata Entity
Arguments
Name | Description |
---|---|
owners[OwnerUpdate!]! | The updated list of owners |
OwnerUpdate
An owner to add to a Metadata Entity TODO Add a USER or GROUP actor enum
Arguments
Name | Description |
---|---|
ownerString! | The owner URN, either a corpGroup or corpuser |
typeOwnershipType! | The owner type |
PolicyMatchCriterionInput
Criterion to define relationship between field and values
Arguments
Name | Description |
---|---|
fieldString! | The name of the field that the criterion refers to e.g. entity_type, entity_urn, domain |
values[String!]! | Values. Matches criterion if any one of the values matches condition (OR-relationship) |
conditionPolicyMatchCondition! | The name of the field that the criterion refers to |
PolicyMatchFilterInput
Filter object that encodes a complex filter logic with OR + AND
Arguments
Name | Description |
---|---|
criteria[PolicyMatchCriterionInput!] | List of criteria to apply |
PolicyUpdateInput
Input provided when creating or updating an Access Policy
Arguments
Name | Description |
---|---|
typePolicyType! | The Policy Type |
nameString! | The Policy name |
statePolicyState! | The Policy state |
descriptionString | A Policy description |
resourcesResourceFilterInput | The set of resources that the Policy privileges apply to |
privileges[String!]! | The set of privileges that the Policy grants |
actorsActorFilterInput! | The set of actors that the Policy privileges are granted to |
QueryStatementInput
Input required for creating a Query Statement
Arguments
Name | Description |
---|---|
valueString! | The query text |
languageQueryLanguage! | The query language |
RecommendationRequestContext
Context that defines the page requesting recommendations i.e. for search pages, the query/filters. for entity pages, the entity urn and tab
Arguments
Name | Description |
---|---|
scenarioScenarioType! | Scenario in which the recommendations will be displayed |
searchRequestContextSearchRequestContext | Additional context for defining the search page requesting recommendations |
entityRequestContextEntityRequestContext | Additional context for defining the entity page requesting recommendations |
RelatedTermsInput
Input provided when adding Terms to an asset
Arguments
Name | Description |
---|---|
urnString! | The Glossary Term urn to add or remove this relationship to/from |
termUrns[String!]! | The primary key of the Glossary Term to add or remove |
relationshipTypeTermRelationshipType! | The type of relationship we're adding or removing to/from for a Glossary Term |
RelationshipsInput
Input for the list relationships field of an Entity
Arguments
Name | Description |
---|---|
types[String!]! | The types of relationships to query, representing an OR |
directionRelationshipDirection! | The direction of the relationship, either incoming or outgoing from the source entity |
startInt | The starting offset of the result set |
countInt | The number of results to be returned |
RemoveGroupMembersInput
Input required to remove members from an external DataHub group
Arguments
Name | Description |
---|---|
groupUrnString! | The group to remove members from |
userUrns[String!]! | The members to remove from the group |
RemoveLinkInput
Input provided when removing the association between a Metadata Entity and a Link
Arguments
Name | Description |
---|---|
linkUrlString! | The url of the link to add or remove, which uniquely identifies the Link |
resourceUrnString! | The urn of the resource or entity to attach the link to, for example a dataset urn |
RemoveNativeGroupMembersInput
Input required to remove members from a native DataHub group
Arguments
Name | Description |
---|---|
groupUrnString! | The group to remove members from |
userUrns[String!]! | The members to remove from the group |
RemoveOwnerInput
Input provided when removing the association between a Metadata Entity and an user or group owner
Arguments
Name | Description |
---|---|
ownerUrnString! | The primary key of the Owner to add or remove |
resourceUrnString! | The urn of the resource or entity to attach or remove the owner from, for example a dataset urn |
ReportOperationInput
Input provided to report an asset operation
Arguments
Name | Description |
---|---|
urnString! | The urn of the asset (e.g. dataset) to report the operation for |
operationTypeOperationType! | The type of operation that was performed. Required |
customOperationTypeString | A custom type of operation. Required if operation type is CUSTOM. |
sourceTypeOperationSourceType! | The source or reporter of the operation |
customProperties[StringMapEntryInput!] | A list of key-value parameters to include |
partitionString | An optional partition identifier |
numAffectedRowsLong | Optional: The number of affected rows |
timestampMillisLong | Optional: Provide a timestamp associated with the operation. If not provided, one will be generated for you based on the current time. |
ResourceFilterInput
Input required when creating or updating an Access Policies Determines which resources the Policy applies to
Arguments
Name | Description |
---|---|
typeString | The type of the resource the policy should apply to Not required because in the future we want to support filtering by type OR by domain |
resources[String!] | A list of specific resource urns to apply the filter to |
allResourcesBoolean | Whether of not to apply the filter to all resources of the type |
filterPolicyMatchFilterInput | Whether of not to apply the filter to all resources of the type |
ResourceRefInput
Reference to a resource to apply an action to
Arguments
Name | Description |
---|---|
resourceUrnString! | The urn of the resource being referenced |
subResourceTypeSubResourceType | An optional type of a sub resource to attach the Tag to |
subResourceString | An optional sub resource identifier to attach the Tag to |
ResourceSpec
Spec to identify resource
Arguments
Name | Description |
---|---|
resourceTypeEntityType! | Resource type |
resourceUrnString! | Resource urn |
RollbackIngestionInput
Input for rolling back an ingestion execution
Arguments
Name | Description |
---|---|
runIdString! | An ingestion run ID |
ScrollAcrossEntitiesInput
Input arguments for a full text search query across entities, specifying a starting pointer. Allows paging beyond 10k results
Arguments
Name | Description |
---|---|
types[EntityType!] | Entity types to be searched. If this is not provided, all entities will be searched. |
queryString! | The query string |
scrollIdString | The starting point of paginated results, an opaque ID the backend understands as a pointer |
keepAliveString | The amount of time to keep the point in time snapshot alive, takes a time unit based string ex: 5m or 30s |
countInt | The number of elements included in the results |
orFilters[AndFilterInput!] | A list of disjunctive criterion for the filter. (or operation to combine filters) |
viewUrnString | Optional - A View to apply when generating results |
searchFlagsSearchFlags | Flags controlling search options |
ScrollAcrossLineageInput
Input arguments for a search query over the results of a multi-hop graph query, uses scroll API
Arguments
Name | Description |
---|---|
urnString | Urn of the source node |
directionLineageDirection! | The direction of the relationship, either incoming or outgoing from the source entity |
types[EntityType!] | Entity types to be searched. If this is not provided, all entities will be searched. |
queryString | The query string |
scrollIdString | The starting point of paginated results, an opaque ID the backend understands as a pointer |
keepAliveString | The amount of time to keep the point in time snapshot alive, takes a time unit based string ex: 5m or 30s |
countInt | The number of elements included in the results |
orFilters[AndFilterInput!] | A list of disjunctive criterion for the filter. (or operation to combine filters) |
startTimeMillisLong | An optional starting time to filter on |
endTimeMillisLong | An optional ending time to filter on |
searchFlagsSearchFlags | Flags controlling search options |
SearchAcrossEntitiesInput
Input arguments for a full text search query across entities
Arguments
Name | Description |
---|---|
types[EntityType!] | Entity types to be searched. If this is not provided, all entities will be searched. |
queryString! | The query string |
startInt | The starting point of paginated results |
countInt | The number of elements included in the results |
filters[FacetFilterInput!] | Deprecated: Use `orFilters`- they are more expressive Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together. |
orFilters[AndFilterInput!] | A list of disjunctive criterion for the filter. (or operation to combine filters) |
viewUrnString | Optional - A View to apply when generating results |
searchFlagsSearchFlags | Flags controlling search options |
SearchAcrossLineageInput
Input arguments for a search query over the results of a multi-hop graph query
Arguments
Name | Description |
---|---|
urnString | Urn of the source node |
directionLineageDirection! | The direction of the relationship, either incoming or outgoing from the source entity |
types[EntityType!] | Entity types to be searched. If this is not provided, all entities will be searched. |
queryString | The query string |
startInt | The starting point of paginated results |
countInt | The number of elements included in the results |
filters[FacetFilterInput!] | Deprecated: Use `orFilters`- they are more expressive Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together. |
orFilters[AndFilterInput!] | A list of disjunctive criterion for the filter. (or operation to combine filters) |
startTimeMillisLong | An optional starting time to filter on |
endTimeMillisLong | An optional ending time to filter on |
searchFlagsSearchFlags | Flags controlling search options |
SearchFlags
Set of flags to control search behavior
Arguments
Name | Description |
---|---|
skipCacheBoolean | Whether to skip cache |
maxAggValuesInt | The maximum number of values in an facet aggregation |
fulltextBoolean | Structured or unstructured fulltext query |
skipHighlightingBoolean | Whether to skip highlighting |
skipAggregatesBoolean | Whether to skip aggregates/facets |
SearchInput
Input arguments for a full text search query
Arguments
Name | Description |
---|---|
typeEntityType! | The Metadata Entity type to be searched against |
queryString! | The raw query string |
startInt | The offset of the result set |
countInt | The number of entities to include in result set |
filters[FacetFilterInput!] | Deprecated: Use `orFilters`- they are more expressive Deprecated in favor of the more expressive orFilters field Facet filters to apply to search results. These will be 'AND'-ed together. |
orFilters[AndFilterInput!] | A list of disjunctive criterion for the filter. (or operation to combine filters) |
searchFlagsSearchFlags | Flags controlling search options |
SearchRequestContext
Context that defines a search page requesting recommendatinos
Arguments
Name | Description |
---|---|
queryString! | Search query |
filters[FacetFilterInput!] | Faceted filters applied to search results |
StepStateInput
The input required to update the state of a step
Arguments
Name | Description |
---|---|
idString! | The globally unique id for the step |
properties[StringMapEntryInput]! | The new properties for the step |
StringMapEntryInput
String map entry input
Arguments
Name | Description |
---|---|
keyString! | The key of the map entry |
valueString | The value fo the map entry |
TagAssociationInput
Input provided when updating the association between a Metadata Entity and a Tag
Arguments
Name | Description |
---|---|
tagUrnString! | The primary key of the Tag to add or remove |
resourceUrnString! | The target Metadata Entity to add or remove the Tag to |
subResourceTypeSubResourceType | An optional type of a sub resource to attach the Tag to |
subResourceString | An optional sub resource identifier to attach the Tag to |
TagAssociationUpdate
Deprecated, use addTag or removeTag mutation instead A tag update to be applied
Arguments
Name | Description |
---|---|
tagTagUpdateInput! | The tag being applied |
TagUpdateInput
Deprecated, use addTag or removeTag mutations instead An update for a particular Tag entity
Arguments
Name | Description |
---|---|
urnString! | The primary key of the Tag |
nameString! | The display name of a Tag |
descriptionString | Description of the tag |
ownershipOwnershipUpdate | Ownership metadata of the tag |
TermAssociationInput
Input provided when updating the association between a Metadata Entity and a Glossary Term
Arguments
Name | Description |
---|---|
termUrnString! | The primary key of the Glossary Term to add or remove |
resourceUrnString! | The target Metadata Entity to add or remove the Glossary Term from |
subResourceTypeSubResourceType | An optional type of a sub resource to attach the Glossary Term to |
subResourceString | An optional sub resource identifier to attach the Glossary Term to |
TestDefinitionInput
Arguments
Name | Description |
---|---|
jsonString | The string representation of the Test |
UpdateCorpUserViewsSettingsInput
Input required to update a users settings.
Arguments
Name | Description |
---|---|
defaultViewString | The URN of the View that serves as this user's personal default. If not provided, any existing default view will be removed. |
UpdateDeprecationInput
Input provided when setting the Deprecation status for an Entity.
Arguments
Name | Description |
---|---|
urnString! | The urn of the Entity to set deprecation for. |
deprecatedBoolean! | Whether the Entity is marked as deprecated. |
decommissionTimeLong | Optional - The time user plan to decommission this entity |
noteString | Optional - Additional information about the entity deprecation plan |
UpdateEmbedInput
Input required to set or clear information related to rendering a Data Asset inside of DataHub.
Arguments
Name | Description |
---|---|
urnString! | The URN associated with the Data Asset to update. Only dataset, dashboard, and chart urns are currently supported. |
renderUrlString | Set or clear a URL used to render an embedded asset. |
UpdateGlobalViewsSettingsInput
Input required to update Global View Settings.
Arguments
Name | Description |
---|---|
defaultViewString | The URN of the View that serves as the Global, or organization-wide, default. If this field is not provided, the existing Global Default will be cleared. |
UpdateIngestionSourceConfigInput
Input parameters for creating / updating an Ingestion Source
Arguments
Name | Description |
---|---|
recipeString! | A JSON-encoded recipe |
versionString | The version of DataHub Ingestion Framework to use when executing the recipe. |
executorIdString! | The id of the executor to use for executing the recipe |
debugModeBoolean | Whether or not to run ingestion in debug mode |
UpdateIngestionSourceInput
Input arguments for creating / updating an Ingestion Source
Arguments
Name | Description |
---|---|
nameString! | A name associated with the ingestion source |
typeString! | The type of the source itself, e.g. mysql, bigquery, bigquery-usage. Should match the recipe. |
descriptionString | An optional description associated with the ingestion source |
scheduleUpdateIngestionSourceScheduleInput | An optional schedule for the ingestion source. If not provided, the source is only available for run on-demand. |
configUpdateIngestionSourceConfigInput! | A set of type-specific ingestion source configurations |
UpdateIngestionSourceScheduleInput
Input arguments for creating / updating the schedule of an Ingestion Source
Arguments
Name | Description |
---|---|
intervalString! | The cron-formatted interval describing when the job should be executed |
timezoneString! | The name of the timezone in which the cron interval should be scheduled (e.g. America/Los Angeles) |
UpdateLineageInput
Input required in order to upsert lineage edges
Arguments
Name | Description |
---|---|
edgesToAdd[LineageEdge]! | New lineage edges to upsert |
edgesToRemove[LineageEdge]! | Lineage edges to remove. Takes precedence over edgesToAdd - so edges existing both edgesToAdd and edgesToRemove will be removed. |
UpdateMediaInput
Input provided for filling in a post content
Arguments
Name | Description |
---|---|
typeMediaType! | The type of media |
locationString! | The location of the media (a URL) |
UpdateNameInput
Input for updating the name of an entity
Arguments
Name | Description |
---|---|
nameString! | The new name |
urnString! | The primary key of the resource to update the name for |
UpdateParentNodeInput
Input for updating the parent node of a resource. Currently only GlossaryNodes and GlossaryTerms have parentNodes.
Arguments
Name | Description |
---|---|
parentNodeString | The new parent node urn. If parentNode is null, this will remove the parent from this entity |
resourceUrnString! | The primary key of the resource to update the parent node for |
UpdatePostContentInput
Input provided for filling in a post content
Arguments
Name | Description |
---|---|
contentTypePostContentType! | The type of post content |
titleString! | The title of the post |
descriptionString | Optional content of the post |
linkString | Optional link that the post is associated with |
mediaUpdateMediaInput | Optional media contained in the post |
UpdateQueryInput
Input required for updating an existing Query. Requires the 'Edit Queries' privilege for all query subjects.
Arguments
Name | Description |
---|---|
propertiesUpdateQueryPropertiesInput | Properties about the Query |
subjects[UpdateQuerySubjectInput!] | Subjects for the query |
UpdateQueryPropertiesInput
Input properties required for creating a Query. Any non-null fields will be updated if provided.
Arguments
Name | Description |
---|---|
nameString | An optional display name for the Query |
descriptionString | An optional description for the Query |
statementQueryStatementInput | The Query contents |
UpdateQuerySubjectInput
Input required for creating a Query. For now, only datasets are supported.
Arguments
Name | Description |
---|---|
datasetUrnString! | The urn of the dataset that is the subject of the query |
UpdateTestInput
Arguments
Name | Description |
---|---|
nameString! | The name of the Test |
categoryString! | The category of the Test (user defined) |
descriptionString | Description of the test |
definitionTestDefinitionInput! | The test definition |
UpdateUserSettingInput
Input for updating a user setting
Arguments
Name | Description |
---|---|
nameUserSetting! | The name of the setting |
valueBoolean! | The new value of the setting |
UpdateViewInput
Input provided when updating a DataHub View
Arguments
Name | Description |
---|---|
nameString | The name of the View |
descriptionString | An optional description of the View |
definitionDataHubViewDefinitionInput | The view definition itself |