Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,28 @@ again.

All code should follow the [Sample Format Guidelines](SAMPLE_FORMAT.md)

## Documentation-only contributions

If you are contributing documentation such as a README, keep the change small
and reviewable.

For missing product-level READMEs:

- Use an existing product README in the repo as a template, such as
`secretmanager/README.md`, when one exists.
- Do not invent sample entrypoints, class names, or product descriptions that
are not supported by the actual folder contents.
- Prefer to add one product README at a time, or a small set of related ones,
rather than creating READMEs for every missing directory at once.
- When a product folder already has good subdirectory READMEs, decide whether
a top-level README adds value before creating one.

Before opening a pull request:

- Verify the README matches the repo's current style.
- If the repo has a docs or lint check, run it on the affected directories.
- Make sure any links, badges, and exec examples are accurate.

## Code reviews

Change to samples should be reviewed by both a product stakeholder for accuracy as well as a member
Expand Down
7 changes: 3 additions & 4 deletions auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,10 @@ Build your project with:

mvn clean package -DskipTests

You can then run a given `ClassName` via:
You can then run a given class via:

mvn exec:java -Dexec.mainClass=com.example.storage.ClassName \
-DpropertyName=propertyValue \
-Dexec.args="any arguments to the app"
mvn exec:java -Dexec.mainClass=com.google.cloud.auth.samples.ClassName \
-Dexec.args="any arguments to the app"

### Listing buckets with default credentials

Expand Down
50 changes: 50 additions & 0 deletions bigquery/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Google BigQuery

<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=bigquery/README.md">
<img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a>

Google [BigQuery](https://cloud.google.com/bigquery/) is a serverless data warehouse
for analytics over massive datasets. These sample Java applications demonstrate how to
access the BigQuery API using the Google Java client libraries and REST-based samples.

## Prerequisites

### Enable the API

You must [enable the BigQuery API](https://console.cloud.google.com/flows/enableapi?apiid=bigquery.googleapis.com)
for your project in order to use these samples.

### Set Environment Variables

You must set your project ID in order to run the samples.

```text
$ export GOOGLE_CLOUD_PROJECT=<your-project-id-here>
```

### Authentication

See the [authentication documentation](https://cloud.google.com/docs/authentication/production)
for more information about authenticating for Google Cloud APIs.

## Samples

Samples are organized by client library and usage pattern:

- [Cloud Client samples](cloud-client/)
- [REST samples](rest/)
- [BigQuery Storage samples](bigquerystorage/)

Additional BigQuery-related samples may be located in nested subdirectories.

## Tests

Run all tests in a sample directory with Maven:

```
mvn clean verify
```

## Contributing

See the [contributor guide](../CONTRIBUTING.md) for this repository.
55 changes: 55 additions & 0 deletions bigtable/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Google Cloud Bigtable

<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=bigtable/README.md">
<img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a>

Google [Bigtable](https://cloud.google.com/bigtable/) is a scalable NoSQL
wide-column database for large analytical and operational workloads. These sample
Java applications demonstrate how to access the Bigtable API using the Google Java
client libraries and related integration patterns.

## Prerequisites

### Enable the API

You must [enable the Cloud Bigtable API](https://console.cloud.google.com/flows/enableapi?apiid=bigtable.googleapis.com)
for your project in order to use these samples.

### Set Environment Variables

You must set your project ID in order to run the samples.

```text
$ export GOOGLE_CLOUD_PROJECT=<your-project-id-here>
```

### Authentication

See the [authentication documentation](https://cloud.google.com/docs/authentication/production)
for more information about authenticating for Google Cloud APIs.

## Samples

Samples are organized by client library, framework, and usage pattern:

- [Apache Beam samples](beam/)
- [Spark samples](spark/)
- [HBase migration samples](hbase/)
- [Bigtable Proxy samples](bigtable-proxy/)
- [Scheduled backup samples](scheduled-backups/)
- [Memorystore samples](memorystore/)
- [Use case samples](use-cases/)

Additional samples may be located in nested subdirectories.

## Tests

Run all tests in a sample directory with Maven:

```
mvn clean verify
```

## Contributing

See the [contributor guide](../CONTRIBUTING.md) for this repository.
45 changes: 45 additions & 0 deletions dialogflow-cx/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Dialogflow CX

<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=dialogflow-cx/README.md">
<img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a>

[Dialogflow CX](https://cloud.google.com/dialogflow/cx/docs) is a conversational
AI platform for building advanced virtual agents with flows and pages. These sample
Java applications demonstrate how to access the Dialogflow CX API using the Google
Java client libraries.

## Prerequisites

### Enable the API

You must [enable the Dialogflow CX API](https://console.cloud.google.com/flows/enableapi?apiid=dialogflow.googleapis.com)
for your project in order to use these samples.

### Set Environment Variables

You must set your project ID in order to run the samples.

```text
$ export GOOGLE_CLOUD_PROJECT=<your-project-id-here>
```

### Authentication

See the [authentication documentation](https://cloud.google.com/docs/authentication/production)
for more information about authenticating for Google Cloud APIs.

## Samples

Samples in this directory use the Dialogflow CX Java client library.

## Tests

Run all tests in a sample directory with Maven:

```
mvn clean verify
```

## Contributing

See the [contributor guide](../CONTRIBUTING.md) for this repository.
40 changes: 40 additions & 0 deletions dialogflow/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Dialogflow

<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=dialogflow/README.md">
<img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a>

[Dialogflow](https://cloud.google.com/dialogflow/) helps you build conversational
interfaces for websites, mobile applications, and other platforms. These sample
Java applications demonstrate how to access the Dialogflow API using the Google
Java client libraries.

## Prerequisites

### Enable the API

You must [enable the Dialogflow API](https://console.cloud.google.com/flows/enableapi?apiid=dialogflow.googleapis.com)
for your project in order to use these samples.

### Authentication

See the [authentication documentation](https://cloud.google.com/docs/authentication/production)
for more information about authenticating for Google Cloud APIs.

## Samples

Samples are organized by usage pattern:

- [Snippet samples](snippets/)
- [Basic webhook samples](basic-webhook/)

## Tests

Run all tests in a sample directory with Maven:

```
mvn clean verify
```

## Contributing

See the [contributor guide](../CONTRIBUTING.md) for this repository.
45 changes: 45 additions & 0 deletions firestore/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Cloud Firestore

<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=firestore/README.md">
<img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a>

[Cloud Firestore](https://cloud.google.com/firestore/) is a flexible, scalable
NoSQL document database for mobile, web, and server development. These sample
Java applications demonstrate how to access the Firestore API using the Google
Java client libraries.

## Prerequisites

### Enable the API

You must [enable the Cloud Firestore API](https://console.cloud.google.com/flows/enableapi?apiid=firestore.googleapis.com)
for your project in order to use these samples.

### Set Environment Variables

You must set your project ID in order to run the samples.

```text
$ export GOOGLE_CLOUD_PROJECT=<your-project-id-here>
```

### Authentication

See the [authentication documentation](https://cloud.google.com/docs/authentication/production)
for more information about authenticating for Google Cloud APIs.

## Samples

Samples are organized in the [samples](samples/) subdirectory.

## Tests

Run all tests in a sample directory with Maven:

```
mvn clean verify
```

## Contributing

See the [contributor guide](../CONTRIBUTING.md) for this repository.
41 changes: 41 additions & 0 deletions pubsub/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Google Cloud Pub/Sub

<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=pubsub/README.md">
<img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a>

Google [Cloud Pub/Sub](https://cloud.google.com/pubsub/) is a messaging and
event-streaming service for asynchronous communication between independent
applications. These sample Java applications demonstrate how to access the
Pub/Sub API using the Google Java client libraries and related integration patterns.

## Prerequisites

### Enable the API

You must [enable the Cloud Pub/Sub API](https://console.cloud.google.com/flows/enableapi?apiid=pubsub.googleapis.com)
for your project in order to use these samples.

### Authentication

See the [authentication documentation](https://cloud.google.com/docs/authentication/production)
for more information about authenticating for Google Cloud APIs.

## Samples

Samples are organized by client library and integration pattern:

- [Cloud Client samples](cloud-client/)
- [Spring integration samples](spring/)
- [Streaming analytics samples](streaming-analytics/)

## Tests

Run all tests in a sample directory with Maven:

```
mvn clean verify
```

## Contributing

See the [contributor guide](../CONTRIBUTING.md) for this repository.
2 changes: 1 addition & 1 deletion run/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Open in Cloud Shell][shell_img]][shell_link]

[shell_img]: http://gstatic.com/cloudssh/images/open-btn.png
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=blog/README.md
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=run/README.md

This directory contains samples for [Google Cloud Run](https://cloud.run). [Cloud Run][run_docs] runs stateless [containers](https://cloud.google.com/containers/) on a fully managed environment or in your own GKE cluster.

Expand Down
48 changes: 48 additions & 0 deletions storage/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Google Cloud Storage

<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=storage/README.md">
<img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a>

Google [Cloud Storage](https://cloud.google.com/storage/) is unified object storage
for developers and enterprises, from live data serving to data analytics and archival.
These sample Java applications demonstrate how to access the Cloud Storage API using
the Google Cloud Java client libraries and related SDK samples.

## Prerequisites

### Enable the API

You must [enable the Cloud Storage API](https://console.cloud.google.com/flows/enableapi?apiid=storage.googleapis.com)
for your project in order to use these samples.

### Set Environment Variables

You must set your project ID in order to run the samples.

```text
$ export GOOGLE_CLOUD_PROJECT=<your-project-id-here>
```

### Authentication

See the [authentication documentation](https://cloud.google.com/docs/authentication/production)
for more information about authenticating for Google Cloud APIs.

## Samples

Samples are organized by client library and SDK usage:

- [Cloud Client samples](cloud-client/)
- [AWS S3 compatibility SDK samples](s3-sdk/)

## Tests

Run all tests in a sample directory with Maven:

```
mvn clean verify
```

## Contributing

See the [contributor guide](../CONTRIBUTING.md) for this repository.
Loading