{% set group_id = metadata['repo']['distribution_name'].split(':')|first -%} {% set artifact_id = metadata['repo']['distribution_name'].split(':')|last -%} {% set repo_short = metadata['repo']['repo'].split('/')|last -%}

Google {{ metadata['repo']['name_pretty'] }} Client for Java

Java idiomatic client for {{metadata['repo']['name_pretty']}}.

[![Maven][maven-version-image]][maven-version-link] ![Stability][stability-image]

Product Documentation
Client Library Documentation {% if 'partials' in metadata and metadata['partials']['deprecation_warning'] -%} {{ metadata['partials']['deprecation_warning'] }} {% elif metadata['repo']['release_level'] in ['preview'] %}

Note: This client is a work-in-progress, and may occasionally make backwards-incompatible changes. {% endif %} {% if migrated_split_repo %} :bus: In October 2022, this library has moved to [google-cloud-java/{{ metadata['repo']['repo_short'] }}]( https://github.com/googleapis/google-cloud-java/tree/main/{{ metadata['repo']['repo_short'] }}). This repository will be archived in the future. Future releases will appear in the new repository (https://github.com/googleapis/google-cloud-java/releases). The Maven artifact coordinates ({{ group_id }}:{{ artifact_id }}) remain the same. {% endif %}

Quickstart

{% if 'snippets' in metadata and metadata['snippets'][metadata['repo']['api_shortname'] + '_install_with_bom'] -%} If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:

{{ metadata['snippets'][metadata['repo']['api_shortname'] + '_install_with_bom'] }}

If you are using Maven without the BOM, add this to your dependencies: {% elif monorepo %} If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>{{ metadata['latest_bom_version'] }}</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>{{ group_id }}</groupId>
    <artifactId>{{ artifact_id }}</artifactId>
  </dependency>

If you are using Maven without the BOM, add this to your dependencies: {% else %} If you are using Maven, add this to your pom.xml file: {% endif %}

{% if 'snippets' in metadata and metadata['snippets'][metadata['repo']['api_shortname'] + '_install_without_bom'] -%}
{{ metadata['snippets'][metadata['repo']['api_shortname'] + '_install_without_bom'] }}
{% else -%}
<dependency>
  <groupId>{{ group_id }}</groupId>
  <artifactId>{{ artifact_id }}</artifactId>
  <version>{{ metadata['latest_version'] }}</version>
</dependency>
{% endif -%}

{% if 'snippets' in metadata and metadata['snippets'][metadata['repo']['api_shortname'] + '_install_with_bom'] -%} If you are using Gradle 5.x or later, add this to your dependencies:

implementation platform('com.google.cloud:libraries-bom:{{metadata['latest_bom_version']}}')

implementation '{{ group_id }}:{{ artifact_id }}'

{% endif -%}

If you are using Gradle without BOM, add this to your dependencies:

implementation '{{ group_id }}:{{ artifact_id }}:{{ metadata['latest_version'] }}'

If you are using SBT, add this to your dependencies:

libraryDependencies += "{{ group_id }}" % "{{ artifact_id }}" % "{{ metadata['latest_version'] }}"

Authentication

See the [Authentication][authentication] section in the base directory's README.

Authorization

The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired {{metadata['repo']['name_pretty']}} APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the {{metadata['repo']['name_pretty']}} API calls.

Getting Started

Prerequisites

You will need a [Google Cloud Platform Console][developer-console] project with the {{metadata['repo']['name_pretty']}} [API enabled][enable-api]. {% if metadata['repo']['requires_billing'] %}You will need to [enable billing][enable-billing] to use Google {{metadata['repo']['name_pretty']}}.{% endif %} [Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud Command Line Interface][cloud-cli] and running the following commands in command line: gcloud auth login and gcloud config set project [YOUR PROJECT ID].

Installation and setup

You'll need to obtain the {{ artifact_id }} library. See the Quickstart section to add {{ artifact_id }} as a dependency in your code.

About {{metadata['repo']['name_pretty']}}

{% if 'partials' in metadata and metadata['partials']['about'] -%} {{ metadata['partials']['about'] }} {% else %} {{ metadata['repo']['name_pretty'] }} {{ metadata['repo']['api_description'] }}

See the {{metadata['repo']['name_pretty']}} client library docs to learn how to use this {{metadata['repo']['name_pretty']}} Client Library. {% endif %}

{% if 'partials' in metadata and metadata['partials']['custom_content'] -%} {{ metadata['partials']['custom_content'] }} {% endif %}

{% if metadata['samples']|length %}

Samples

Samples are in the [samples/](https://github.com/{{ metadata['repo']['repo'] }}/tree/main/samples) directory.

Sample	Source Code	Try it
{% for sample in metadata['samples'] %}	{{ sample.title }}	[source code](https://github.com/{{ metadata['repo']['repo'] }}/blob/main/{{ sample.file }})
{% endfor %}
{% endif %}

Troubleshooting

To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].

{% if metadata['repo']['transport'] -%}

Transport

{% if metadata['repo']['transport'] == 'grpc' -%} {{metadata['repo']['name_pretty']}} uses gRPC for the transport layer. {% elif metadata['repo']['transport'] == 'http' -%} {{metadata['repo']['name_pretty']}} uses HTTP/JSON for the transport layer. {% elif metadata['repo']['transport'] == 'both' -%} {{metadata['repo']['name_pretty']}} uses both gRPC and HTTP/JSON for the transport layer. {% endif %} {% endif -%}

Supported Java Versions

Java {{ metadata['min_java_version'] }} or above is required for using this client.

Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).

For new development

In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.

Java 11 and (in September 2021) Java 17 are the best choices for new development.

Keeping production systems current

Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).

Legacy support

Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.

Where to find specific information

The latest versions and the supported Java versions are identified on the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME and on google-cloud-java.

Versioning

{% if 'partials' in metadata and metadata['partials']['versioning'] -%} {{ metadata['partials']['versioning'] }} {% else %} This library follows Semantic Versioning.

{% if metadata['repo']['release_level'] in ['preview'] %} It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable. {% endif %}{% endif %}

Contributing

{% if 'partials' in metadata and metadata['partials']['contributing'] -%} {{ metadata['partials']['contributing'] }} {% else %} Contributions to this library are always welcome and highly encouraged.

See [CONTRIBUTING][contributing] for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more information. {% endif %}

License

Apache 2.0 - See [LICENSE][license] for more information.

CI Status

Java Version | Status ------------ | ------{% if metadata['min_java_version'] <= 7 %} Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]{% endif %} Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2] Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3] Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4] Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]

Java is a registered trademark of Oracle and/or its affiliates.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Google {{ metadata['repo']['name_pretty'] }} Client for Java

Quickstart

Authentication

Authorization

Getting Started

Prerequisites

Installation and setup

About {{metadata['repo']['name_pretty']}}

Samples

Troubleshooting

Transport

Supported Java Versions

For new development

Keeping production systems current

Legacy support

Where to find specific information

Versioning

Contributing

License

CI Status

Files

README.md

Latest commit

History

README.md

File metadata and controls

Google {{ metadata['repo']['name_pretty'] }} Client for Java

Quickstart

Authentication

Authorization

Getting Started

Prerequisites

Installation and setup

About {{metadata['repo']['name_pretty']}}

Samples

Troubleshooting

Transport

Supported Java Versions

For new development

Keeping production systems current

Legacy support

Where to find specific information

Versioning

Contributing

License

CI Status