Skip to content

Commit a509c7d

Browse files
heremaps-botheremaps-bot
heremaps-bot
authored and
heremaps-bot
committed
HERE Data SDK for Java & Scala Release 2.21.0
1 parent 0a07079 commit a509c7d

File tree

80 files changed

+416
-420
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+416
-420
lines changed

data-archive/java/avro-example/README.md

+35-35
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@ To run this example, you need two sets of credentials:
2424
* **Platform credentials:** To get access to the platform data and resources, including HERE Map Content data for your pipeline input.
2525
* **Repository credentials:** To download HERE Data SDK for Java & Scala libraries and Maven archetypes to your environment.
2626

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).
2828

2929
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.
3030

3131
## Configure a Project
3232

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
3434
(catalogs, pipelines, and schemas) with controlled access. You can create a project through the
3535
**HERE platform portal**.
36-
36+
3737
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:
3838

3939
```bash
@@ -45,7 +45,7 @@ The command returns the [HERE Resource Name (HRN)](https://developer.here.com/do
4545
> Note:
4646
> You don't have to provide a `--scope` parameter if your app has a default scope.
4747
> 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).
4949
5050
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.
5151

@@ -59,10 +59,10 @@ Use the **HERE platform portal** to [create the input catalog](https://developer
5959
|------------------------|------------|--------------------------|------------------|---------------
6060
| stream | Stream | application/octet-stream | uncompressed | -
6161

62-
- 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).
6666

6767
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:
6868

@@ -96,10 +96,10 @@ Use the **HERE platform portal** to [create the output catalog](https://develope
9696
|------------------------|------------|------------|----------------------------|------------|--------------------------|------------------|---------------
9797
| index | Index | 7 days | ingestionTime | 60 | application/x-avro-binary| uncompressed | -
9898

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).
103103

104104
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:
105105

@@ -200,7 +200,7 @@ navigate to your pipeline to see its status.
200200
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).
201201

202202
> #### 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.
204204
205205
## Verify the Output
206206

@@ -214,7 +214,7 @@ After the pipeline is running, you can ingest your data into the `stream` layer
214214

215215
> #### Note
216216
> 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).
218218
```
219219
olp catalog permission grant $CATALOG_HRN --app $APP_ID --read --write --scope $PROJECT_HRN
220220
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
226226
- **Partitions** in [Command Line Interface Developer Guide](#command-line-interface-developer-guide)
227227
> #### Note
228228
> 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).
230230
```
231231
olp catalog permission grant $CATALOG_HRN --app $APP_ID --read --write --scope $PROJECT_HRN
232232
olp catalog layer partition list $CATALOG_HRN index --filter <query> --scope $PROJECT_HRN # E.g: <query>="tileId==92259"
233233
olp catalog layer partition get $CATALOG_HRN index --filter <query> --scope $PROJECT_HRN
234234
```
235235

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).
237237

238238
## Run Example Locally
239239

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).
241241
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.
243243
> #### 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.
245245
> When running this example from your IDE, ensure you have this profile enabled in the Maven Toolbar.
246246
> 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).
247247
248248
## Troubleshooting
249249

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).
251251

252252
## References
253253

@@ -256,29 +256,29 @@ If you have any trouble about accessing logs, monitoring, investigating failures
256256
* China: https://platform.hereolp.cn
257257

258258
- ##### Data Archiving Library Developer Guide
259-
* RoW: https://developer.here.com/olp/documentation/data-archiving-library/dev_guide/index.html
260-
* China: https://developer.here.com/olp/cn/documentation/data-archiving-library/dev_guide/index.html
259+
* RoW: https://developer.here.com/documentation/data-archiving-library/dev_guide/index.html
260+
* China: https://developer.here.com/cn/documentation/data-archiving-library/dev_guide/index.html
261261

262262
- ##### Command Line Interface Developer Guide
263-
* RoW: https://developer.here.com/olp/documentation/open-location-platform-cli/user_guide/index.html
264-
* China: https://developer.here.com/olp/cn/documentation/open-location-platform-cli/user_guide/index.html
263+
* RoW: https://developer.here.com/documentation/open-location-platform-cli/user_guide/index.html
264+
* China: https://developer.here.com/cn/documentation/open-location-platform-cli/user_guide/index.html
265265

266266
- ##### Data API Developer Guide
267-
* RoW: https://developer.here.com/olp/documentation/data-api/data_dev_guide/index.html
268-
* China: https://developer.here.com/olp/cn/documentation/data-api/data_dev_guide/index.html
267+
* RoW: https://developer.here.com/documentation/data-api/data_dev_guide/index.html
268+
* China: https://developer.here.com/cn/documentation/data-api/data_dev_guide/index.html
269269

270270
- ##### Data Client Library Developer Guide
271-
* RoW: https://developer.here.com/olp/documentation/data-client-library/dev_guide/index.html
272-
* China: https://developer.here.com/olp/cn/documentation/data-client-library/dev_guide/index.html
271+
* RoW: https://developer.here.com/documentation/data-client-library/dev_guide/index.html
272+
* China: https://developer.here.com/cn/documentation/data-client-library/dev_guide/index.html
273273

274274
- ##### Data User Guide
275-
* RoW: https://developer.here.com/olp/documentation/data-user-guide/index.html
276-
* China: https://developer.here.com/olp/cn/documentation/data-user-guide/index.html
275+
* RoW: https://developer.here.com/documentation/data-user-guide/index.html
276+
* China: https://developer.here.com/documentation/data-user-guide/index.html
277277

278278
- ##### Pipelines Developer Guide
279-
* RoW: https://developer.here.com/olp/documentation/pipeline/index.html
280-
* China: https://developer.here.com/olp/cn/documentation/pipeline/index.html
279+
* RoW: https://developer.here.com/documentation/pipeline/index.html
280+
* China: https://developer.here.com/cn/documentation/pipeline/index.html
281281

282-
- ##### Teams and Permissions User Guide
283-
* RoW: https://developer.here.com/olp/documentation/access-control/user-guide/index.html
284-
* China: https://developer.here.com/olp/cn/documentation/access-control/user-guide/index.html
282+
- ##### Identity & Access Management Developer Guide
283+
* RoW: https://developer.here.com/documentation/identity-access-management/dev_guide/index.html
284+
* China: https://developer.here.com/documentation/identity-access-management/dev_guide/index.html

data-archive/java/avro-example/pom.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
<groupId>com.here.platform.data.archive</groupId>
55
<artifactId>data-archive-avro-example</artifactId>
6-
<version>0.0.582</version>
6+
<version>0.0.589</version>
77
<packaging>jar</packaging>
88

99
<!-- Meta information section start -->
@@ -23,7 +23,7 @@
2323
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
2424
<java.version>1.8</java.version>
2525

26-
<sdk-bom.version>2.20.11</sdk-bom.version>
26+
<sdk-bom.version>2.21.6</sdk-bom.version>
2727
<scala.compat.version>2.11</scala.compat.version>
2828

2929
<avro.version>1.10.0</avro.version>

0 commit comments

Comments
 (0)