14670: Add an example page
authorPeter Amstutz <pamstutz@veritasgenetics.com>
Fri, 19 Apr 2019 21:23:48 +0000 (17:23 -0400)
committerPeter Amstutz <pamstutz@veritasgenetics.com>
Fri, 19 Apr 2019 21:23:48 +0000 (17:23 -0400)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <pamstutz@veritasgenetics.com>

doc/_config.yml
doc/sdk/java-v2/example.html.textile.liquid [new file with mode: 0644]

index 98c572b0119f50e7613bbea7f7776f91a5955583..289167b7588abe4c04b7a5cef77d0ce09dfa2303 100644 (file)
@@ -106,6 +106,7 @@ navbar:
       - sdk/ruby/example.html.textile.liquid
     - Java v2:
       - sdk/java-v2/index.html.textile.liquid
+      - sdk/java-v2/example.html.textile.liquid
       - sdk/java-v2/javadoc.html.textile.liquid
     - Java v1:
       - sdk/java/index.html.textile.liquid
diff --git a/doc/sdk/java-v2/example.html.textile.liquid b/doc/sdk/java-v2/example.html.textile.liquid
new file mode 100644 (file)
index 0000000..e73f968
--- /dev/null
@@ -0,0 +1,49 @@
+---
+layout: default
+navsection: sdk
+navmenu: Java SDK v2
+title: Examples
+...
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+
+In these examples, the site prefix is @aaaaa@.
+
+h2.  Initialize SDK
+
+{% codeblock as java %}
+package org.arvados.example;
+
+import java.util.List;
+import org.arvados.client.config.ConfigProvider;
+import org.arvados.client.config.ExternalConfigProvider;
+import org.arvados.client.api.model.CollectionList;
+import org.arvados.client.api.model.Collection;
+import org.arvados.client.api.client.CollectionsApiClient;
+
+public class CollectionExample {
+    public static void main(String[] argv) {
+       ConfigProvider conf = ExternalConfigProvider.builder().
+           apiProtocol("https").
+           apiHost("qr1hi.arvadosapi.com").
+           apiPort(443).
+           apiToken("...").
+           build();
+       CollectionsApiClient collectionsApi = new CollectionsApiClient(conf);
+       /* ... */
+    }
+}
+{% endcodeblock %}
+
+h2. list
+
+{% codeblock as java %}
+       CollectionList cl = collectionsApi.list();
+       List<Collection> items = cl.getItems();
+       for (int i = 0; i < items.size(); i++) {
+           System.out.println(items.get(i));
+       }
+{% endcodeblock %}