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
connections[ViewConnection]yes The connections for the view (see ViewConnection Table).
federated[FederatedQueryConnection]yes The connection between a view and a repository in a remote cluster. (see FederatedQueryConnection Table).
idstringyes The unique identifier of the view.
nameRepoOrViewNameyes The name of the repository or view.
descriptionstringyes A description of the view.
deletedDatelongyes The point in time the search domain was marked for deletion.
permanentlyDeletedAtstringyes The point in time the search domain will not be restorable anymore.
isStarredbooleanyes Whether the view should be marked with a star.

[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.