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

feat: [shopping-merchant-quota] new module for shopping-merchant-quota #10575

Merged
merged 4 commits into from
Mar 19, 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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 28 additions & 5 deletions generation_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,8 @@ libraries:
- api_shortname: apphub
name_pretty: App Hub API
product_documentation: https://cloud.google.com/app-hub/docs/overview
api_description: App Hub simplifies the process of building, running, and managing applications on Google Cloud.
api_description: App Hub simplifies the process of building, running, and managing
Copy link
Contributor

@blakeli0 blakeli0 Mar 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we know what triggers this format change?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it's the default behavior of ruamel.yaml, the library used to add a new entry to the config yaml.
ruaml.yaml inherits from PyYaml. The docs explain we can use the width argument when dumping the yaml to prevent long lines from being split

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had enabled automerge for this PR and it got merged before I answered. I can follow up by adding a fix to prevent string formatting.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm good with it as long as this format change does not mess up @JoeWang1127 's comparator.

applications on Google Cloud.
rpc_documentation: https://cloud.google.com/app-hub/docs/reference/rpc
GAPICs:
- proto_path: google/cloud/apphub/v1
Expand Down Expand Up @@ -446,7 +447,9 @@ libraries:
- api_shortname: chat
name_pretty: Google Chat API
product_documentation: https://developers.google.com/chat/concepts
api_description: The Google Chat API lets you build Chat apps to integrate your services with Google Chat and manage Chat resources such as spaces, members, and messages.
api_description: The Google Chat API lets you build Chat apps to integrate your
services with Google Chat and manage Chat resources such as spaces, members, and
messages.
rest_documentation: https://developers.google.com/chat/api/reference/rest
GAPICs:
- proto_path: google/chat/v1
Expand Down Expand Up @@ -479,7 +482,8 @@ libraries:
- api_shortname: cloudcontrolspartner
name_pretty: Cloud Controls Partner API
product_documentation: https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners
api_description: Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering.
api_description: Provides insights about your customers and their Assured Workloads
based on your Sovereign Controls by Partners offering.
GAPICs:
- proto_path: google/cloud/cloudcontrolspartner/v1
- proto_path: google/cloud/cloudcontrolspartner/v1beta
Expand Down Expand Up @@ -1600,7 +1604,10 @@ libraries:
- api_shortname: securityposture
name_pretty: Security Posture API
product_documentation: https://cloud.google.com/security-command-center/docs/security-posture-overview
api_description: Security Posture is a comprehensive framework of policy sets that empowers organizations to define, assess early, deploy, and monitor their security measures in a unified way and helps simplify governance and reduces administrative toil.
api_description: Security Posture is a comprehensive framework of policy sets that
empowers organizations to define, assess early, deploy, and monitor their security
measures in a unified way and helps simplify governance and reduces administrative
toil.
GAPICs:
- proto_path: google/cloud/securityposture/v1

Expand Down Expand Up @@ -1698,6 +1705,21 @@ libraries:
GAPICs:
- proto_path: google/shopping/merchant/inventories/v1beta

- api_shortname: shopping-merchant-quota
name_pretty: Merchant Quota API
product_documentation: https://developers.google.com/merchant/api
api_description: Programmatically manage your Merchant Center accounts.
client_documentation:
https://cloud.google.com/java/docs/reference/google-shopping-merchant-quota/latest/overview
release_level: preview
distribution_name: com.google.shopping:google-shopping-merchant-quota
api_id: shopping-merchant-quota.googleapis.com
library_type: GAPIC_AUTO
group_id: com.google.shopping
cloud_api: false
GAPICs:
- proto_path: google/shopping/merchant/quota/v1beta
requires_billing: true
- api_shortname: merchantapi
name_pretty: Merchant API
product_documentation: https://developers.google.com/merchant/api
Expand Down Expand Up @@ -2001,7 +2023,8 @@ libraries:
- api_shortname: workspaceevents
name_pretty: Google Workspace Events API
product_documentation: https://developers.google.com/workspace/events
api_description: The Google Workspace Events API lets you subscribe to events and manage change notifications across Google Workspace applications.
api_description: The Google Workspace Events API lets you subscribe to events and
manage change notifications across Google Workspace applications.
rest_documentation: https://developers.google.com/workspace/events/reference/rest
GAPICs:
- proto_path: google/apps/events/subscriptions/v1
Expand Down
35 changes: 35 additions & 0 deletions java-shopping-merchant-quota/.OwlBot.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


deep-remove-regex:
- "/java-shopping-merchant-quota/grpc-google-.*/src"
- "/java-shopping-merchant-quota/proto-google-.*/src"
- "/java-shopping-merchant-quota/google-.*/src"
- "/java-shopping-merchant-quota/samples/snippets/generated"

deep-preserve-regex:
- "/java-shopping-merchant-quota/google-.*/src/test/java/com/google/cloud/.*/v.*/it/IT.*Test.java"

deep-copy-regex:
- source: "/google/shopping/merchant/quota/(v.*)/.*-java/proto-google-.*/src"
dest: "/owl-bot-staging/java-shopping-merchant-quota/$1/proto-google-shopping-merchant-quota-$1/src"
- source: "/google/shopping/merchant/quota/(v.*)/.*-java/grpc-google-.*/src"
dest: "/owl-bot-staging/java-shopping-merchant-quota/$1/grpc-google-shopping-merchant-quota-$1/src"
- source: "/google/shopping/merchant/quota/(v.*)/.*-java/gapic-google-.*/src"
dest: "/owl-bot-staging/java-shopping-merchant-quota/$1/google-shopping-merchant-quota/src"
- source: "/google/shopping/merchant/quota/(v.*)/.*-java/samples/snippets/generated"
dest: "/owl-bot-staging/java-shopping-merchant-quota/$1/samples/snippets/generated"

api-name: shopping-merchant-quota
16 changes: 16 additions & 0 deletions java-shopping-merchant-quota/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"api_shortname": "shopping-merchant-quota",
"name_pretty": "Merchant Quota API",
"product_documentation": "https://developers.google.com/merchant/api",
"api_description": "Programmatically manage your Merchant Center accounts.",
"client_documentation": "https://cloud.google.com/java/docs/reference/google-shopping-merchant-quota/latest/overview",
"release_level": "preview",
"transport": "both",
"language": "java",
"repo": "googleapis/google-cloud-java",
"repo_short": "java-shopping-merchant-quota",
"distribution_name": "com.google.shopping:google-shopping-merchant-quota",
"api_id": "shopping-merchant-quota.googleapis.com",
"library_type": "GAPIC_AUTO",
"requires_billing": true
}
225 changes: 225 additions & 0 deletions java-shopping-merchant-quota/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
# Google Merchant Quota API Client for Java

Java idiomatic client for [Merchant Quota API][product-docs].

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

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

> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.


## Quickstart


If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:

```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>26.34.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<dependency>
<groupId>com.google.shopping</groupId>
<artifactId>google-shopping-merchant-quota</artifactId>
</dependency>
```

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

<!-- {x-version-update-start:google-shopping-merchant-quota:released} -->

```xml
<dependency>
<groupId>com.google.shopping</groupId>
<artifactId>google-shopping-merchant-quota</artifactId>
<version>0.0.0</version>
</dependency>
```

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

```Groovy
implementation 'com.google.shopping:google-shopping-merchant-quota:0.0.0'
```

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

```Scala
libraryDependencies += "com.google.shopping" % "google-shopping-merchant-quota" % "0.0.0"
```
<!-- {x-version-update-end} -->

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

## Getting Started

### Prerequisites

You will need a [Google Cloud Platform Console][developer-console] project with the Merchant Quota API [API enabled][enable-api].
You will need to [enable billing][enable-billing] to use Google Merchant Quota API.
[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 `google-shopping-merchant-quota` library. See the [Quickstart](#quickstart) section
to add `google-shopping-merchant-quota` as a dependency in your code.

## About Merchant Quota API


[Merchant Quota API][product-docs] Programmatically manage your Merchant Center accounts.

See the [Merchant Quota API client library docs][javadocs] to learn how to
use this Merchant Quota API Client Library.






## Troubleshooting

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

## Transport

Merchant Quota API uses both gRPC and HTTP/JSON 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/).


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.


## Contributing


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.


## License

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

## CI Status

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://developers.google.com/merchant/api
[javadocs]: https://cloud.google.com/java/docs/reference/google-shopping-merchant-quota/latest/overview
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.shopping/google-shopping-merchant-quota.svg
[maven-version-link]: https://central.sonatype.com/artifact/com.google.shopping/google-shopping-merchant-quota/0.0.0
[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-cli]: https://cloud.google.com/cli
[troubleshooting]: https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md
[contributing]: https://github.com/googleapis/google-cloud-java/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/google-cloud-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/google-cloud-java/blob/main/LICENSE
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=shopping-merchant-quota.googleapis.com
[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
@@ -0,0 +1,43 @@
<?xml version='1.0' encoding='UTF-8'?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.google.shopping</groupId>
<artifactId>google-shopping-merchant-quota-bom</artifactId>
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:google-shopping-merchant-quota:current} -->
<packaging>pom</packaging>
<parent>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-pom-parent</artifactId>
<version>1.32.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-java:current} -->
<relativePath>../../google-cloud-pom-parent/pom.xml</relativePath>
</parent>

<name>Google Merchant Quota API BOM</name>
<description>
BOM for Merchant Quota API
</description>

<properties>
<maven.antrun.skip>true</maven.antrun.skip>
</properties>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.shopping</groupId>
<artifactId>google-shopping-merchant-quota</artifactId>
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:google-shopping-merchant-quota:current} -->
</dependency>
<dependency>
<groupId>com.google.shopping.api.grpc</groupId>
<artifactId>grpc-google-shopping-merchant-quota-v1beta</artifactId>
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:grpc-google-shopping-merchant-quota-v1beta:current} -->
</dependency>
<dependency>
<groupId>com.google.shopping.api.grpc</groupId>
<artifactId>proto-google-shopping-merchant-quota-v1beta</artifactId>
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:proto-google-shopping-merchant-quota-v1beta:current} -->
</dependency>
</dependencies>
</dependencyManagement>
</project>