You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: data-archive/java/avro-example/README.md
+35-35
Original file line number
Diff line number
Diff line change
@@ -24,16 +24,16 @@ To run this example, you need two sets of credentials:
24
24
***Platform credentials:** To get access to the platform data and resources, including HERE Map Content data for your pipeline input.
25
25
***Repository credentials:** To download HERE Data SDK for Java & Scala libraries and Maven archetypes to your environment.
26
26
27
-
For more details on how to set up your credentials, see [Get Your Credentials](https://developer.here.com/documentation/java-scala-dev/dev_guide/topics/get-credentials.html).
27
+
For more details on how to set up your credentials, see the [Identity & Access Management Developer Guide](#identity-&-access-management-developer-guide).
28
28
29
29
For more details on how to verify that your platform credentials are configured correctly, see the [Verify Your Credentials](https://developer.here.com/documentation/java-scala-dev/dev_guide/verify-credentials/index.html) tutorial.
30
30
31
31
## Configure a Project
32
32
33
-
To follow this example, you'll need a [project](https://developer.here.com/documentation/access-control/user_guide/topics/manage-projects.html). A project is a collection of platform resources
33
+
To follow this example, you'll need a [project](#identity-&-access-management-developer-guide). A project is a collection of platform resources
34
34
(catalogs, pipelines, and schemas) with controlled access. You can create a project through the
35
35
**HERE platform portal**.
36
-
36
+
37
37
Alternatively, use the OLP CLI [`olp project create`](https://developer.here.com/documentation/open-location-platform-cli/user_guide/topics/project/project-commands.html#create-project) command to create the project:
38
38
39
39
```bash
@@ -45,7 +45,7 @@ The command returns the [HERE Resource Name (HRN)](https://developer.here.com/do
45
45
> Note:
46
46
> You don't have to provide a `--scope` parameter if your app has a default scope.
47
47
> For details on how to set a default project scope for an app, see the _Specify a
48
-
> default Project_ for Apps chapter of the [Teams and Permissions Guide](https://developer.here.com/documentation/access-control/user_guide/topics/manage-projects.html).
48
+
> default Project_ for Apps chapter of the [Identity & Access Management Developer Guide](#identity-&-access-management-developer-guide).
49
49
50
50
For more information on how to work with projects, see the [Organize your work in projects](https://developer.here.com/documentation/java-scala-dev/dev_guide/organize-work-in-projects/index.html) tutorial.
51
51
@@ -59,10 +59,10 @@ Use the **HERE platform portal** to [create the input catalog](https://developer
- For instructions on how to create a catalog, refer to**Create a Catalog** in [Data User Guide](#data-user-guide).
63
-
- For instructions on how to create a layer, refer to**Create a Layer** in [Data User Guide](#data-user-guide).
64
-
- For instructions on how to link a resource to a project, refer to**Project Resources Link** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide).
65
-
- For instructions on how to share your project, refer to **Manage Projects** in [Teams and Permissions User Guide](#teams-and-permissions-user-guide).
62
+
- For instructions on how to create a catalog, see**Create a Catalog** in [Data User Guide](#data-user-guide).
63
+
- For instructions on how to create a layer, see**Create a Layer** in [Data User Guide](#data-user-guide).
64
+
- For instructions on how to link a resource to a project, see**Project Resources Link** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide).
65
+
- For instructions on how to share your project, see **Manage Projects** in the [Identity & Access Management Developer Guide](#identity-&-access-management-developer-guide).
66
66
67
67
Alternatively, you can use the **OLP CLI Commands** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide) instead of the platform portal to create a new catalog with a `stream` layer:
68
68
@@ -96,10 +96,10 @@ Use the **HERE platform portal** to [create the output catalog](https://develope
| index | Index | 7 days | ingestionTime | 60 | application/x-avro-binary| uncompressed | -
98
98
99
-
- For instructions on how to create a catalog, refer to**Create a Catalog** in [Data User Guide](#data-user-guide).
100
-
- For instructions on how to create a layer, refer to**Create a Layer** in [Data User Guide](#data-user-guide).
101
-
- For instructions on how to link a resource to a project, refer to**Project Resources Link** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide).
102
-
- For instructions on how to share your project, refer to **Manage Projects** in [Teams and Permissions User Guide](#teams-and-permissions-user-guide).
99
+
- For instructions on how to create a catalog, see**Create a Catalog** in [Data User Guide](#data-user-guide).
100
+
- For instructions on how to create a layer, see**Create a Layer** in [Data User Guide](#data-user-guide).
101
+
- For instructions on how to link a resource to a project, see**Project Resources Link** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide).
102
+
- For instructions on how to share your project, see **Manage Projects** in the [Identity & Access Management Developer Guide](#identity-&-access-management-developer-guide).
103
103
104
104
Alternatively, you can use the **OLP CLI Commands** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide) instead of the platform portal to create a new catalog with an `index` layer:
105
105
@@ -200,7 +200,7 @@ navigate to your pipeline to see its status.
200
200
For more information on using the **OLP CLI** to configure and run a pipeline, see **Pipeline Commands** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide).
201
201
202
202
> #### Note
203
-
> The selection of input and output catalog values using the portal when creating pipeline version or the values added to `pipeline.config` when using command line interface must be valid. These values represent a placeholder which will not be used by the the Data Archiving Library. Instead, values will be taken from the `application.conf` file. If you want to change or update the input/output catlogs, modify the `application.conf` file and rebuild.
203
+
> The selection of input and output catalog values using the portal when creating pipeline version or the values added to `pipeline.config` when using command line interface must be valid. These values represent a placeholder that the Data Archiving Library will not use. Instead, values will be taken from the `application.conf` file. If you want to change or update the input/output catlogs, modify the `application.conf` file and rebuild.
204
204
205
205
## Verify the Output
206
206
@@ -214,7 +214,7 @@ After the pipeline is running, you can ingest your data into the `stream` layer
214
214
215
215
> #### Note
216
216
> For ingesting data, make sure your app has `read` and `write` permission to your `stream` layer.
217
-
> For instructions on how to manage app, refer to `Manage Apps` in [Teams and Permissions User Guide](#teams-and-permissions-user-guide).
217
+
> For instructions on how to manage your app, see `Manage Apps` in the [Identity & Access Management Developer Guide](#identity-&-access-management-developer-guide).
olp catalog layer stream put $CATALOG_HRN stream --input /path/to/directory --scope $PROJECT_HRN # There are sdii example messages in the folder: src/test/resources/sampleData
@@ -226,28 +226,28 @@ After your data is archived in `index` layer, you can query/retrieve data using
226
226
-**Partitions** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide)
227
227
> #### Note
228
228
> For querying metadata or retrieving data, make sure your app has `read` permission to your `index` layer.
229
-
> For instructions on how to manage app, refer to **Manage Apps** in [Teams and Permissions User Guide](#teams-and-permissions-user-guide).
229
+
> For instructions on how to manage your app, see **Manage Apps** in the [Identity & Access Management Developer Guide](#identity-&-access-management-developer-guide).
olp catalog layer partition list $CATALOG_HRN index --filter <query> --scope $PROJECT_HRN # E.g: <query>="tileId==92259"
233
233
olp catalog layer partition get $CATALOG_HRN index --filter <query> --scope $PROJECT_HRN
234
234
```
235
235
236
-
To parse the data retrieved from `index` layer, refer to "How to parse the output content" in **FAQ** in [Data Archiving Library Developer Guide](#data-archiving-library-developer-guide).
236
+
To parse the data retrieved from `index` layer, see "How to parse the output content" in **FAQ** in the[Data Archiving Library Developer Guide](#data-archiving-library-developer-guide).
237
237
238
238
## Run Example Locally
239
239
240
-
Besides running this example in a pipeline, you can also **Run an Archiving Application Locally**, refer to[Data Archiving Library Developer Guide](#data-archiving-library-developer-guide).
240
+
Besides running this example in a pipeline, you can also **Run an Archiving Application Locally**, see[Data Archiving Library Developer Guide](#data-archiving-library-developer-guide).
241
241
Running locally in your IDE or Flink cluster will use the configuration from file `application.conf` in the src/test/resource/ directory, ensure these values are updated before compiling and uploading your jar.
242
-
Refer to **Manage Apps** in [Teams and Permissions User Guide](#teams-and-permissions-user-guide) to create a new application and get `credentials.properties`. You will share read/write permissions with this app when you create your `stream` and `index` layers.
242
+
To create a new application and get `credentials.properties`, see **Manage Apps** in the [Identity & Access Management Developer Guide](#identity-&-access-management-developer-guide). You will share read/write permissions with this app when you create your `stream` and `index` layers.
243
243
> #### Note
244
-
> This example provides the maven profile `add-dependencies-for-IDEA`, which compiles the necessary dependencies in order to run an application locally from your IDE.
244
+
> This example provides the Maven profile `add-dependencies-for-IDEA`, which compiles the necessary dependencies in order to run an application locally from your IDE.
245
245
> When running this example from your IDE, ensure you have this profile enabled in the Maven Toolbar.
246
246
> Alternatively, you can select the checkbox for `Include dependencies with "Provided" scope` in `Edit Configurations` for [AvroExampleRunner.java](src/test/java/com/here/platform/data/archive/example/AvroExampleRunner.java).
247
247
248
248
## Troubleshooting
249
249
250
-
If you have any trouble about accessing logs, monitoring, investigating failures and so on, refer to `FAQ` in [Data Archiving Library Developer Guide](#data-archiving-library-developer-guide).
250
+
If you have any trouble about accessing logs, monitoring, investigating failures and so on, see `FAQ` in the[Data Archiving Library Developer Guide](#data-archiving-library-developer-guide).
251
251
252
252
## References
253
253
@@ -256,29 +256,29 @@ If you have any trouble about accessing logs, monitoring, investigating failures
0 commit comments