-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Set scope to provided * Add readme * Update docs * Fix format * Update docs (cherry picked from commit de8adb2)
- Loading branch information
1 parent
5f175db
commit 1506f9d
Showing
24 changed files
with
204 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# AFS adapter for AWS | ||
|
||
> **_NOTE:_** | ||
> | ||
> This module makes use of external libraries, which have to be provided by the user: | ||
> - `software.amazon.awssdk:auth` | ||
> - `software.amazon.awssdk:aws-core` | ||
> | ||
> Please refer to the [pom](../pom.xml) file for the used versions. | ||
> | ||
> This is done because they might bring licenses potentially incompatible with the EPL. It is the responsibility of the adaptor to acquire them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# AFS adapter for AWS DynamoDB | ||
|
||
> **_NOTE:_** | ||
> | ||
> This module makes use of external libraries, which have to be provided by the user: | ||
> - `software.amazon.awssdk:dynamodb` | ||
> | ||
> Please refer to the [pom](../pom.xml) file for the used versions. | ||
> | ||
> This is done because they might bring licenses potentially incompatible with the EPL. It is the responsibility of the adaptor to acquire them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# AFS adapter for AWS S3 | ||
|
||
> **_NOTE:_** | ||
> | ||
> This module makes use of external libraries, which have to be provided by the user: | ||
> - `software.amazon.awssdk:s3` | ||
> | ||
> Please refer to the [pom](../pom.xml) file for the used versions. | ||
> | ||
> This is done because they might bring licenses potentially incompatible with the EPL. It is the responsibility of the adaptor to acquire them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# AFS adapter for Azure Storage | ||
|
||
> **_NOTE:_** | ||
> | ||
> This module makes use of external libraries, which have to be provided by the user: | ||
> - `com.azure:azure-storage-blob` | ||
> | ||
> Please refer to the [pom](../pom.xml) file for the used versions. | ||
> | ||
> This is done because they might bring licenses potentially incompatible with the EPL. It is the responsibility of the adaptor to acquire them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# AFS adapter for Google Cloud FireStore | ||
|
||
> **_NOTE:_** | ||
> | ||
> This module makes use of external libraries, which have to be provided by the user: | ||
> - `com.google.cloud:google-cloud-firestore` | ||
> | ||
> Please refer to the [pom](../pom.xml) file for the used versions. | ||
> | ||
> This is done because they might bring licenses potentially incompatible with the EPL. It is the responsibility of the adaptor to acquire them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# AFS adapter for Apache Kafka | ||
|
||
> **_NOTE:_** | ||
> | ||
> This module makes use of external libraries, which have to be provided by the user: | ||
> - `org.apache.kafka:kafka-clients` | ||
> | ||
> Please refer to the [pom](./pom.xml) file for the used versions. | ||
> | ||
> This is done because they might bring licenses potentially incompatible with the EPL. It is the responsibility of the adaptor to acquire them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# AFS adapter for Oracle Cloud Object Storage | ||
|
||
> **_NOTE:_** | ||
> | ||
> This module makes use of external libraries, which have to be provided by the user: | ||
> - `com.oracle.oci.sdk:oci-java-sdk-objectstorage` | ||
> | ||
> Please refer to the [pom](../pom.xml) file for the used versions. | ||
> | ||
> This is done because they might bring licenses potentially incompatible with the EPL. It is the responsibility of the adaptor to acquire them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# AFS adapter for Redis | ||
|
||
> **_NOTE:_** | ||
> | ||
> This module makes use of external libraries, which have to be provided by the user: | ||
> - `io.lettuce:lettuce-core` | ||
> | ||
> Please refer to the [pom](./pom.xml) file for the used versions. | ||
> | ||
> This is done because they might bring licenses potentially incompatible with the EPL. It is the responsibility of the adaptor to acquire them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
docs/modules/storage/pages/storage-targets/blob-stores/google-cloud-firestore.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
= Google Cloud Firestore | ||
|
||
[source, xml, subs=attributes+] | ||
---- | ||
<dependency> | ||
<groupId>org.eclipse.store</groupId> | ||
<artifactId>afs-googlecloud-firestore</artifactId> | ||
<version>{maven-version}</version> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>google-cloud-firestore</artifactId> | ||
<version>25.0.0</version> | ||
</dependency> | ||
---- | ||
|
||
[source, java] | ||
---- | ||
Firestore firestore = ... | ||
BlobStoreFileSystem fileSystem = BlobStoreFileSystem.New( | ||
GoogleCloudFirestoreConnector.Caching(client) | ||
); | ||
EmbeddedStorage.start(fileSystem.ensureDirectoryPath("storage")); | ||
---- | ||
|
||
== Configuration | ||
|
||
When using xref:configuration/index.adoc#external-configuration[external configuration] Google Cloud Firestore can be set as follows. | ||
|
||
[source, text, title="eclipsestore.properties"] | ||
---- | ||
storage-filesystem.googlecloud.firestore.credentials.type=default | ||
storage-filesystem.googlecloud.firestore.database-id=my-database-id | ||
storage-filesystem.googlecloud.firestore.project-id=my-project-id | ||
---- | ||
|
||
== Supported properties | ||
[options="header", cols="1,2a"] | ||
|=== | ||
|Property | ||
|Description | ||
//------------- | ||
|database-id | ||
|The database ID to use with this Firestore client. | ||
|emulator-host | ||
|The emulator host to use with this Firestore client. | ||
|host | ||
|The service host. | ||
|project-id | ||
|The project ID. If no project ID is set, the project ID from the environment will be used. | ||
|quota-project-id | ||
|The project ID that specifies the project used for quota and billing purposes. | ||
|credentials.type | ||
|The type of the credentials provider. Supported values are: | ||
* "none" + | ||
No credentials are used. | ||
* "input-stream" + | ||
Path of a JSON file stream. The stream can contain a Service Account key file in JSON format from the Google DevelopersConsole or a stored user credential using the format supported by the Cloud SDK. | ||
* "default" + | ||
Returns the Application Default Credentials which are used to identify and authorize thewhole application. The following are searched (in order) to find the Application DefaultCredentials: | ||
. Credentials file pointed to by the GOOGLE_APPLICATION_CREDENTIALS environment variable | ||
. Credentials provided by the Google Cloud SDK. | ||
.. gcloud auth application-default login for user account credentials. | ||
.. gcloud auth application-default login --impersonate-service-account forimpersonated service account credentials. | ||
. Google App Engine built-in credentials | ||
. Google Cloud Shell built-in credentials | ||
. Google Compute Engine built-in credentials | ||
|=== | ||
CAUTION: Depending on the amount of data and transactions, charges may apply depending on service usage. Please check with your service provider for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters