The updateFederationOfView() GraphQL mutation is used to update federated connections for a view in LogScale.

For information related to Federation connctions, see the Active Directory Federation Services documentation page.

Syntax

Below is the syntax for the updateFederationOfView() mutation field: 

updateFederationOfView(viewName: string!, federated: [FederatedQueryConnectionInput!]!): View!

Given Datatypes

For the given datatype, FederatedQueryConnectionInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: FederatedQueryConnectionInput

ParameterTypeRequired[a]DefaultDescription
remotePublicUrlstringyes The URL of remote cluster.
repositoryNamestringyes The name of the connected repository.
filterstringyes The filter applied to all results from the repository.
remoteTokenstring  Token allowing the query to run in the remote cluster.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


Returned Datatypes

The returned datatype View has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: View

ParameterTypeRequired[a]DefaultDescription
action(id: string): Actionyes A saved action. The id is the action to get.
actions[Action]yes A list of saved actions.
aggregateAlert(id: string): AggregateAlertyes A saved aggregate alert (see AggregateAlert Table).
aggregateAlerts[AggregateAlert]yes Saved aggregate alerts (see AggregateAlert Table).
alert(id: string): Alertyes A saved alert.
alerts[Alert]yes Saved alerts.
allowedViewActions[ViewAction]yes Returns the all actions the user is allowed to perform on the view (see ViewAction Table).
automaticSearchbooleanyes Whether the search is executed automatically.
availablePackagesfilter: string, tags: [PackageTag], categories: [string]  Returns a list of available packages that can be installed. Filter input is given to limit the returned packages. Packages input is used with any of these tags will be included, but no filtering on tags. Categories is used to list categories that will be included.
clusterConnection(id: string!): ClusterConnection!yes The unique identifier of the connection to get (see ClusterConnection Table).
connections[ViewConnection]yes The connections for the view (see ViewConnection Table).
crossOrgConnections[CrossOrgViewConnection]yes The connections for the cross organization connections (see CrossOrgViewConnection Table).
dashboard(id: string): Dashboardyes A saved dashboard.
dashboards[Dashboard]yes Saved dashboards.
descriptionstringyes A description of the view.
defaultQuerySavedQuery  The default saved query (see SavedQuery Table).
deletedDatelongyes The point in time the search domain was marked for deletion.
federated[FederatedQueryConnection]yes The connection between a view and a repository in a remote cluster (see FederatedQueryConnection Table).
files[File]yes A list of files used.
fileFieldSearchfileName: string, fieldName: string, prefixFilter: string, valueFilters: [FileFieldFilterType], fieldsToInclude: [string]maxEntries: integer): [[DictionaryEntryType]]yes The fields to search in a given file. The fileName is the name of the csv or json file from which to retrieve the field entries. The fieldName is the name of the field in the file from which to return entries. The prefixFilter is the text on which to filter values by prefix. The valueFilters is the exact values that given fields should have for an entry to be part of the result. The fieldsToInclude contains the names of the fields to include in the result. The maxEntries is the maximum number of values to retrieve from the file.
filterAlert(id: string): FilterAlertyes A saved filter alert.
filterAlerts[FilterAlert]yes Saved filter alerts.
groups[Group]yes Groups with assigned roles (see Group Table).
hasPackageInstalled(packageId: VersionedPackageSpecifier): booleanyes See VersionedPackageSpecifier table.
idstringyes The unique identifier of the view.
installedPackages[PackageInstallation]yes List packages installed on a specific view or repository (see PackageInstallation Table).
interactions[ViewInteraction]yes All interactions defined on the view.
isActionAllowed(action: ViewAction): booleanyes Check if the current user is allowed to perform the given action on the view. ViewAction is the action to check if a user is allowed to perform it on a view.
isStarredbooleanyes Whether the view should be marked with a star.
nameRepoOrViewNameyes The name of the repository or view.
packageV2(packageId: VersionedPackageSpecifier)yes The identifier of the package to get.
permanentlyDeletedAtstringyes The point in time the search domain will not be restorable anymore.
recentQueriesV2[RecentQuery]yes List of recent queries (see RecentQuery Table).
reposExcludedInSearchLimit[string]yes Repositories not part of the search limitation.
savedQuery(id: string): SavedQueryyes A saved query (see SavedQuery Table).
savedQueries[SavedQuery]yes A list of saved queries (see SavedQuery Table).
scheduledReport(id: string): ScheduledReportyes Saved scheduled report (see ScheduledReport Table). The id is the unique identifier of the scheduled report to get.
scheduledReports[ScheduledReport]yes Saved scheduled reports (see ScheduledReport Table).
scheduledSearch(id: string): ScheduledSearchyes A saved scheduled search (see ScheduledSearch Table).
scheduledSearches[ScheduledSearch]yes Saved scheduled searches (see ScheduledSearch Table).
searchLimitedMslong  Search limit in milliseconds, by which searches are limited.
starredFields[string]yes Fields marked with a star.
tags[string]yes All tags from all datasources.
users[User]yes Users who has access.
usersAndGroups(search: String, skip: Int = 0, limit: Int = 50): UsersAndGroupsSearchResultSetyes Users or groups who has access. Skip is the number of results to skip or the offset to use. For instance if implementing pagination, set skip = limit * (page - 1). Limit is the amount of results to return.
viewerQueryPrefixstringyes The query prefix prepended to each search in this domain.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.