Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: [common-protos,common-protos] set packed = false on field_behavior extension #2436

Merged
merged 2 commits into from
Feb 13, 2024
Merged
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
184 changes: 157 additions & 27 deletions java-common-protos/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,138 @@
# Google Common Protos
# Google Common Protos Client for Java

Java protobuf classes for Google's common protos.
Java idiomatic client for [Common Protos][product-docs].

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

- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]

## Java Versions

Java 7 or above is required for using this client.
## Quickstart


If you are using Maven, add this to your pom.xml file:


```xml
<dependency>
<groupId>com.google.api.grpc</groupId>
<artifactId>proto-google-common-protos</artifactId>
<version>2.33.0</version>
</dependency>
```

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

```Groovy
implementation 'com.google.api.grpc:proto-google-common-protos:2.33.0'
```

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

```Scala
libraryDependencies += "com.google.api.grpc" % "proto-google-common-protos" % "2.33.0"
```

## 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 Common Protos APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Common Protos API calls.

## Getting Started

### Prerequisites

You will need a [Google Cloud Platform Console][developer-console] project with the Common Protos [API enabled][enable-api].
You will need to [enable billing][enable-billing] to use Google Common Protos.
[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 SDK][cloud-sdk] 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 `proto-google-common-protos` library. See the [Quickstart](#quickstart) section
to add `proto-google-common-protos` as a dependency in your code.

## About Common Protos


[Common Protos][product-docs] Protobuf classes for Google's common protos.

See the [Common Protos client library docs][javadocs] to learn how to
use this Common Protos Client Library.






## Troubleshooting

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

## Transport

Common Protos uses gRPC for the transport layer.

## Supported Java Versions

Java 8 or above is required for using this client.

Google's Java client libraries,
[Google Cloud Client Libraries][cloudlibs]
and
[Google Cloud API Libraries][apilibs],
follow the
[Oracle Java SE support roadmap][oracle]
(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][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][g-c-j].

## Versioning


This library follows [Semantic Versioning](http://semver.org/).



## Contributing


Contributions to this library are always welcome and highly encouraged.

See [CONTRIBUTING][contributing] for more information how to get started.
Expand All @@ -25,41 +141,55 @@ Please note that this project is released with a Contributor Code of Conduct. By
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
information.


## License

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

## CI Status

| Java Version | Status |
| -------------- | --------------------------------------------------------- |
| Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1] |
| 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] |

[javadocs]: https://cloud.google.com/java/docs/reference/proto-google-common-protos/latest/overview
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-common-protos/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-common-protos/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-common-protos/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-common-protos/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-common-protos/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-common-protos/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-common-protos/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-common-protos/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-common-protos/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-common-protos/java11.html
[stability-image]: https://img.shields.io/badge/stability-ga-green
Java Version | Status
------------ | ------
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.

[product-docs]: https://github.com/googleapis/api-common-protos
[javadocs]: https://cloud.google.com/java/docs/reference/proto-google-common-protos/latest/history
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/sdk-platform-java/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/sdk-platform-java/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/sdk-platform-java/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/sdk-platform-java/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/sdk-platform-java/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/sdk-platform-java/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/sdk-platform-java/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/sdk-platform-java/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/sdk-platform-java/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/sdk-platform-java/java11.html
[stability-image]: https://img.shields.io/badge/stability-stable-green
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.api.grpc/proto-google-common-protos.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.api.grpc%20AND%20a:proto-google-common-protos&core=gav
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
[developer-console]: https://console.developers.google.com/
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-sdk]: https://cloud.google.com/sdk/
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/main/troubleshooting/readme.md#troubleshooting
[contributing]: https://github.com/googleapis/java-common-protos/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-common-protos/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-common-protos/blob/main/LICENSE
[contributing]: https://github.com/googleapis/sdk-platform-java/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/sdk-platform-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/sdk-platform-java/blob/main/LICENSE
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing

[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png

[semver]: https://semver.org/
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
[g-c-j]: http://github.com/googleapis/google-cloud-java
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/config_change.proto

// Protobuf Java Version: 3.25.2
package com.google.api;

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/config_change.proto

// Protobuf Java Version: 3.25.2
package com.google.api;

public interface AdviceOrBuilder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/annotations.proto

// Protobuf Java Version: 3.25.2
package com.google.api;

public final class AnnotationsProto {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/auth.proto

// Protobuf Java Version: 3.25.2
package com.google.api;

public final class AuthProto {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/auth.proto

// Protobuf Java Version: 3.25.2
package com.google.api;

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/auth.proto

// Protobuf Java Version: 3.25.2
package com.google.api;

public interface AuthProviderOrBuilder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/auth.proto

// Protobuf Java Version: 3.25.2
package com.google.api;

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/auth.proto

// Protobuf Java Version: 3.25.2
package com.google.api;

public interface AuthRequirementOrBuilder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/auth.proto

// Protobuf Java Version: 3.25.2
package com.google.api;

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/auth.proto

// Protobuf Java Version: 3.25.2
package com.google.api;

public interface AuthenticationOrBuilder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/auth.proto

// Protobuf Java Version: 3.25.2
package com.google.api;

/**
Expand Down Expand Up @@ -69,6 +70,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
com.google.api.AuthenticationRule.Builder.class);
}

private int bitField0_;
public static final int SELECTOR_FIELD_NUMBER = 1;

@SuppressWarnings("serial")
Expand Down Expand Up @@ -141,7 +143,7 @@ public com.google.protobuf.ByteString getSelectorBytes() {
*/
@java.lang.Override
public boolean hasOauth() {
return oauth_ != null;
return ((bitField0_ & 0x00000001) != 0);
}
/**
*
Expand Down Expand Up @@ -279,7 +281,7 @@ public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io
if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(selector_)) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 1, selector_);
}
if (oauth_ != null) {
if (((bitField0_ & 0x00000001) != 0)) {
output.writeMessage(2, getOauth());
}
if (allowWithoutCredential_ != false) {
Expand All @@ -300,7 +302,7 @@ public int getSerializedSize() {
if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(selector_)) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(1, selector_);
}
if (oauth_ != null) {
if (((bitField0_ & 0x00000001) != 0)) {
size += com.google.protobuf.CodedOutputStream.computeMessageSize(2, getOauth());
}
if (allowWithoutCredential_ != false) {
Expand Down Expand Up @@ -489,10 +491,20 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
}

// Construct using com.google.api.AuthenticationRule.newBuilder()
private Builder() {}
private Builder() {
maybeForceBuilderInitialization();
}

private Builder(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}

private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3.alwaysUseFieldBuilders) {
getOauthFieldBuilder();
getRequirementsFieldBuilder();
}
}

@java.lang.Override
Expand Down Expand Up @@ -563,12 +575,15 @@ private void buildPartial0(com.google.api.AuthenticationRule result) {
if (((from_bitField0_ & 0x00000001) != 0)) {
result.selector_ = selector_;
}
int to_bitField0_ = 0;
if (((from_bitField0_ & 0x00000002) != 0)) {
result.oauth_ = oauthBuilder_ == null ? oauth_ : oauthBuilder_.build();
to_bitField0_ |= 0x00000001;
}
if (((from_bitField0_ & 0x00000004) != 0)) {
result.allowWithoutCredential_ = allowWithoutCredential_;
}
result.bitField0_ |= to_bitField0_;
}

@java.lang.Override
Expand Down Expand Up @@ -950,8 +965,10 @@ public Builder mergeOauth(com.google.api.OAuthRequirements value) {
} else {
oauthBuilder_.mergeFrom(value);
}
bitField0_ |= 0x00000002;
onChanged();
if (oauth_ != null) {
bitField0_ |= 0x00000002;
onChanged();
}
return this;
}
/**
Expand Down
Loading
Loading