Skip to main content

Input objects

ActorFilterInput

Input required when creating or updating an Access Policies Determines which actors the Policy applies to

Arguments

NameDescription
users
[String!]

A disjunctive set of users to apply the policy to

groups
[String!]

A disjunctive set of groups to apply the policy to

resourceOwners
Boolean!

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

allUsers
Boolean!

Whether the filter should apply to all users

allGroups
Boolean!

Whether the filter should apply to all groups

AddGroupMembersInput

Input required to add members to a DataHub group

Arguments

NameDescription
groupUrn
String!

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

NameDescription
linkUrl
String!

The url of the link to add or remove

label
String!

A label to attach to the link

resourceUrn
String!

The urn of the resource or entity to attach the link to, for example a dataset urn

AddOwnerInput

Input provided when adding the association between a Metadata Entity and an user or group owner

Arguments

NameDescription
ownerUrn
String!

The primary key of the Owner to add or remove

ownerEntityType
OwnerEntityType!

The owner type, either a user or group

resourceUrn
String!

The urn of the resource or entity to attach or remove the owner from, for example a dataset urn

AutoCompleteInput

Input for performing an auto completion query against a single Metadata Entity

Arguments

NameDescription
type
EntityType

Entity type to be autocompleted against

query
String!

The raw query string

field
String

An optional entity field name to autocomplete on

limit
Int

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

NameDescription
types
[EntityType!]

Entity types to be autocompleted against Optional, if none supplied, all searchable types will be autocompleted against

query
String!

The raw query string

field
String

An optional field to autocomplete against

limit
Int

The maximum number of autocomplete results

filters
[FacetFilterInput!]

Faceted filters applied to autocomplete results

BrowseInput

Input required for browse queries

Arguments

NameDescription
type
EntityType!

The browse entity type

path
[String!]

The browse path

start
Int

The starting point of paginated results

count
Int

The number of elements included in the results

filters
[FacetFilterInput!]

Faceted filters applied to browse results

BrowsePathsInput

Inputs for fetching the browse paths for a Metadata Entity

Arguments

NameDescription
type
EntityType!

The browse entity type

urn
String!

The entity urn

ChartEditablePropertiesUpdate

Update to writable Chart fields

Arguments

NameDescription
description
String!

Writable description aka documentation for a Chart

ChartUpdateInput

Arguments provided to update a Chart Entity

Arguments

NameDescription
ownership
OwnershipUpdate

Update to ownership

globalTags
GlobalTagsUpdate

Deprecated, use tags field instead Update to global tags

tags
GlobalTagsUpdate

Update to tags

editableProperties
ChartEditablePropertiesUpdate

Update to editable properties

CreateGroupInput

Input for creating a new group

Arguments

NameDescription
name
String!

The display name of the group

description
String

The description of the group

DashboardEditablePropertiesUpdate

Update to writable Dashboard fields

Arguments

NameDescription
description
String!

Writable description aka documentation for a Dashboard

DashboardUpdateInput

Arguments provided to update a Chart Entity

Arguments

NameDescription
ownership
OwnershipUpdate

Update to ownership

globalTags
GlobalTagsUpdate

Deprecated, use tags field instead Update to global tags

tags
GlobalTagsUpdate

Update to tags

editableProperties
DashboardEditablePropertiesUpdate

Update to editable properties

DataFlowEditablePropertiesUpdate

Update to writable Data Flow fields

Arguments

NameDescription
description
String!

Writable description aka documentation for a Data Flow

DataFlowUpdateInput

Arguments provided to update a Data Flow aka Pipeline Entity

Arguments

NameDescription
ownership
OwnershipUpdate

Update to ownership

globalTags
GlobalTagsUpdate

Deprecated, use tags field instead Update to global tags

tags
GlobalTagsUpdate

Update to tags

editableProperties
DataFlowEditablePropertiesUpdate

Update to editable properties

DataJobEditablePropertiesUpdate

Update to writable Data Job fields

Arguments

NameDescription
description
String!

Writable description aka documentation for a Data Job

DataJobUpdateInput

Arguments provided to update a Data Job aka Task Entity

Arguments

NameDescription
ownership
OwnershipUpdate

Update to ownership

globalTags
GlobalTagsUpdate

Deprecated, use tags field instead Update to global tags

tags
GlobalTagsUpdate

Update to tags

editableProperties
DataJobEditablePropertiesUpdate

Update to editable properties

DatasetDeprecationUpdate

An update for the deprecation information for a Metadata Entity

Arguments

NameDescription
deprecated
Boolean!

Whether the dataset is deprecated

decommissionTime
Long

The time user plan to decommission this dataset

note
String!

Additional information about the dataset deprecation plan

DatasetEditablePropertiesUpdate

Update to writable Dataset fields

Arguments

NameDescription
description
String!

Writable description aka documentation for a Dataset

DatasetUpdateInput

Arguments provided to update a Dataset Entity

Arguments

NameDescription
ownership
OwnershipUpdate

Update to ownership

deprecation
DatasetDeprecationUpdate

Update to deprecation status

institutionalMemory
InstitutionalMemoryUpdate

Update to institutional memory, ie documentation

globalTags
GlobalTagsUpdate

Deprecated, use tags field instead Update to global tags

tags
GlobalTagsUpdate

Update to tags

editableSchemaMetadata
EditableSchemaMetadataUpdate

Update to editable schema metadata of the dataset

editableProperties
DatasetEditablePropertiesUpdate

Update to editable properties

DescriptionUpdateInput

Incubating. Updates the description of a resource. Currently supports DatasetField descriptions only

Arguments

NameDescription
description
String!

The new description

resourceUrn
String!

The primary key of the resource to attach the description to, eg dataset urn

subResourceType
SubResourceType

An optional sub resource type

subResource
String

A sub resource identitifer, eg dataset field path

EditableSchemaFieldInfoUpdate

Update to writable schema field metadata

Arguments

NameDescription
fieldPath
String!

Flattened name of a field identifying the field the editable info is applied to

description
String

Edited description of the field

globalTags
GlobalTagsUpdate

Tags associated with the field

EditableSchemaMetadataUpdate

Update to editable schema metadata of the dataset

Arguments

NameDescription
editableSchemaFieldInfo
[EditableSchemaFieldInfoUpdate!]!

Update to writable schema field metadata

EntityCountInput

Input for the get entity counts endpoint

Arguments

NameDescription
types
[EntityType!]

FacetFilterInput

Facet filters to apply to search results

Arguments

NameDescription
field
String!

Name of field to filter by

value
String!

Value of the field to filter by

GlobalTagsUpdate

Deprecated, use addTag or removeTag mutation instead Update to the Tags associated with a Metadata Entity

Arguments

NameDescription
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

NameDescription
url
String!

Link to a document or wiki page or another internal resource

description
String

Description of the resource

author
String!

The corp user urn of the author of the metadata

createdAt
Long

The time at which this metadata was created

InstitutionalMemoryUpdate

An update for the institutional memory information for a Metadata Entity

Arguments

NameDescription
elements
[InstitutionalMemoryMetadataUpdate!]!

The individual references in the institutional memory

ListGroupsInput

Input required when listing DataHub Groups

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Policies to be returned in the result set

ListPoliciesInput

Input required when listing DataHub Access Policies

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Policies to be returned in the result set

ListUsersInput

Input required when listing DataHub Users

Arguments

NameDescription
start
Int

The starting offset of the result set returned

count
Int

The maximum number of Policies to be returned in the result set

OwnershipUpdate

An update for the ownership information for a Metadata Entity

Arguments

NameDescription
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

NameDescription
owner
String!

The owner URN, either a corpGroup or corpuser

type
OwnershipType!

The owner type

PolicyUpdateInput

Input provided when creating or updating an Access Policy

Arguments

NameDescription
type
PolicyType!

The Policy Type

name
String!

The Policy name

state
PolicyState!

The Policy state

description
String

A Policy description

resources
ResourceFilterInput

The set of resources that the Policy privileges apply to

privileges
[String!]!

The set of privileges that the Policy grants

actors
ActorFilterInput!

The set of actors that the Policy privileges are granted to

RelationshipsInput

Input for the list relationships field of an Entity

Arguments

NameDescription
types
[String!]!

The types of relationships to query, representing an OR

direction
RelationshipDirection!

The direction of the relationship, either incoming or outgoing from the source entity

start
Int

The starting offset of the result set

count
Int

The number of results to be returned

RemoveGroupMembersInput

Input required to remove members from a DataHub group

Arguments

NameDescription
groupUrn
String!

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

NameDescription
linkUrl
String!

The url of the link to add or remove, which uniquely identifies the Link

resourceUrn
String!

The urn of the resource or entity to attach the link to, for example a dataset urn

RemoveOwnerInput

Input provided when removing the association between a Metadata Entity and an user or group owner

Arguments

NameDescription
ownerUrn
String!

The primary key of the Owner to add or remove

resourceUrn
String!

The urn of the resource or entity to attach or remove the owner from, for example a dataset urn

ResourceFilterInput

Input required when creating or updating an Access Policies Determines which resources the Policy applies to

Arguments

NameDescription
type
String!

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

allResources
Boolean!

Whether of not to apply the filter to all resources of the type

SearchAcrossEntitiesInput

Input arguments for a full text search query across entities

Arguments

NameDescription
types
[EntityType!]

Entity types to be searched. If this is not provided, all entities will be searched.

query
String!

The query string

start
Int

The starting point of paginated results

count
Int

The number of elements included in the results

filters
[FacetFilterInput!]

Faceted filters applied to search results

SearchInput

Input arguments for a full text search query

Arguments

NameDescription
type
EntityType!

The Metadata Entity type to be searched against

query
String!

The raw query string

start
Int

The offset of the result set

count
Int

The number of entities to include in result set

filters
[FacetFilterInput!]

Facet filters to apply to search results

TagAssociationInput

Input provided when updating the association between a Metadata Entity and a Tag

Arguments

NameDescription
tagUrn
String!

The primary key of the Tag to add or remove

resourceUrn
String!

The target Metadata Entity to add or remove the Tag to

subResourceType
SubResourceType

An optional type of a sub resource to attach the Tag to

subResource
String

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

NameDescription
tag
TagUpdateInput!

The tag being applied

TagUpdateInput

Deprecated, use addTag or removeTag mutations instead An update for a particular Tag entity

Arguments

NameDescription
urn
String!

The primary key of the Tag

name
String!

The display name of a Tag

description
String

Description of the tag

ownership
OwnershipUpdate

Ownership metadata of the tag

TermAssociationInput

Input provided when updating the association between a Metadata Entity and a Glossary Term

Arguments

NameDescription
termUrn
String!

The primary key of the Glossary Term to add or remove

resourceUrn
String!

The target Metadata Entity to add or remove the Glossary Term from

subResourceType
SubResourceType

An optional type of a sub resource to attach the Glossary Term to

subResource
String

An optional sub resource identifier to attach the Glossary Term to