Skip to content

README.md

Latest commit

 

History

History
145 lines (108 loc) · 7.02 KB

README.md

File metadata and controls

145 lines (108 loc) · 7.02 KB

Indexing.Shortcuts

Overview

Available Operations

bulkIndex

Replaces all the currently indexed shortcuts using paginated batch API calls. Note that this endpoint is used for indexing shortcuts not hosted by Glean. If you want to upload shortcuts that would be hosted by Glean, please use the /uploadshortcuts endpoint. For information on what you can do with Golinks, which are Glean-hosted shortcuts, please refer to this page.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.BulkIndexShortcutsRequest;
import com.glean.api_client.glean_api_client.models.components.ExternalShortcut;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1BulkindexshortcutsResponse;
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();

        BulkIndexShortcutsRequest req = BulkIndexShortcutsRequest.builder()
                .uploadId("<id>")
                .shortcuts(List.of(
                    ExternalShortcut.builder()
                        .inputAlias("<value>")
                        .destinationUrl("https://plump-tune-up.biz/")
                        .createdBy("<value>")
                        .intermediateUrl("https://lean-sightseeing.net")
                        .build(),
                    ExternalShortcut.builder()
                        .inputAlias("<value>")
                        .destinationUrl("https://plump-tune-up.biz/")
                        .createdBy("<value>")
                        .intermediateUrl("https://lean-sightseeing.net")
                        .build()))
                .build();

        PostApiIndexV1BulkindexshortcutsResponse res = sdk.indexing().shortcuts().bulkIndex()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

PostApiIndexV1BulkindexshortcutsResponse

Errors

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

upload

Creates glean shortcuts for uploaded shortcuts info. Glean would host the shortcuts, and they can be managed in the knowledge tab once uploaded.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.IndexingShortcut;
import com.glean.api_client.glean_api_client.models.components.UploadShortcutsRequest;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1UploadshortcutsResponse;
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();

        UploadShortcutsRequest req = UploadShortcutsRequest.builder()
                .uploadId("<id>")
                .shortcuts(List.of(
                    IndexingShortcut.builder()
                        .inputAlias("<value>")
                        .destinationUrl("https://majestic-pharmacopoeia.info/")
                        .createdBy("<value>")
                        .build(),
                    IndexingShortcut.builder()
                        .inputAlias("<value>")
                        .destinationUrl("https://majestic-pharmacopoeia.info/")
                        .createdBy("<value>")
                        .build(),
                    IndexingShortcut.builder()
                        .inputAlias("<value>")
                        .destinationUrl("https://majestic-pharmacopoeia.info/")
                        .createdBy("<value>")
                        .build()))
                .build();

        PostApiIndexV1UploadshortcutsResponse res = sdk.indexing().shortcuts().upload()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

PostApiIndexV1UploadshortcutsResponse

Errors

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