README.md

Indexing.Datasources

Overview

Available Operations

• add - Add or update datasource
• retrieveConfig - Get datasource config
• submit - Submit datasource data

add

Add or update a custom datasource and its schema.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.*;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1AdddatasourceResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Exception {

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        CustomDatasourceConfig req = CustomDatasourceConfig.builder()
                .name("<value>")
                .urlRegex("https://example-company.datasource.com/.*")
                .quicklinks(List.of(
                    Quicklink.builder()
                        .iconConfig(IconConfig.builder()
                            .color("#343CED")
                            .key("person_icon")
                            .iconType(IconType.GLYPH)
                            .name("user")
                            .build())
                        .build()))
                .build();

        PostApiIndexV1AdddatasourceResponse res = sdk.indexing().datasources().add()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	CustomDatasourceConfig	✔️	The request object to use for the request.

Response

PostApiIndexV1AdddatasourceResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

retrieveConfig

Fetches the datasource config for the specified custom datasource.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.GetDatasourceConfigRequest;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1GetdatasourceconfigResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        GetDatasourceConfigRequest req = GetDatasourceConfigRequest.builder()
                .datasource("<value>")
                .build();

        PostApiIndexV1GetdatasourceconfigResponse res = sdk.indexing().datasources().retrieveConfig()
                .request(req)
                .call();

        if (res.customDatasourceConfig().isPresent()) {
            System.out.println(res.customDatasourceConfig().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GetDatasourceConfigRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1GetdatasourceconfigResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

submit

Validates and asynchronously processes a datasource-specific submission.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.errors.ErrorInfoResponse;
import com.glean.api_client.glean_api_client.models.operations.PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse;
import java.lang.Exception;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws ErrorInfoResponse, Exception {

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse res = sdk.indexing().datasources().submit()
                .datasourceInstance("<value>")
                .type("<value>")
                .requestBody(Map.ofEntries(
                    Map.entry("key", "<value>"),
                    Map.entry("key1", "<value>"),
                    Map.entry("key2", "<value>")))
                .call();

        if (res.object().isPresent()) {
            System.out.println(res.object().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
datasourceInstance	String	✔️	Datasource instance that should process the submission
type	String	✔️	Submission type registered for the datasource
requestBody	Map<String, Object>	✔️	N/A
serverURL	String	➖	An optional server URL to use.

Response

PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorInfoResponse	400, 401, 404	application/json
models/errors/ErrorInfoResponse	500	application/json
models/errors/APIException	4XX, 5XX	*/*