Better document Storage API #356

mziccard · 2015-11-11T16:24:53Z

This follows from #351

gcloud-java-storage/src/main/java/com/google/gcloud/storage/BlobInfo.java

@@ -158,11 +173,20 @@ Builder componentCount(Integer componentCount) {
      return this;
    }

+    /**
+     * Sets the blob's data cache control.


aozarov · 2015-11-11T22:30:48Z

Do you think BucketInfo is already well documented (compared to https://cloud.google.com/storage/docs/json_api/v1/buckets#resource)?

aozarov · 2015-11-11T23:00:51Z

Ignore my last comment. Just noticed that you added javadoc for BucketInfo in #355.

mziccard · 2015-11-12T17:52:37Z

I fixed the comments and integrated javadoc

Better document Storage API

🤖 I have created a release *beep* *boop* --- ## [2.2.1](googleapis/java-orgpolicy@v2.2.0...v2.2.1) (2022-06-23) ### Dependencies * update dependency com.google.cloud:google-cloud-shared-dependencies to v2.13.0 ([#356](googleapis/java-orgpolicy#356)) ([bd72427](googleapis/java-orgpolicy@bd72427)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

🤖 I have created a release \*beep\* \*boop\* --- ### Updating meta-information for bleeding-edge SNAPSHOT release. --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

Source-Link: googleapis/synthtool@7a220e2 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:6d4e3a15c62cfdcb823d60e16da7521e7c6fc00eba07c8ff12e4de9924a57d28

Making CLIRR not required. The version bumps are now controlled by the Release Please and OwlBot. The CL authors create appropriate change description to control major version bumps.

- [ ] Regenerate this pull request now. PiperOrigin-RevId: 477955264 Source-Link: https://togithub.com/googleapis/googleapis/commit/a724450af76d0001f23602684c49cd6a4b3a5654 Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/4abcbcaec855e74a0b22a4988cf9e0eb61a83094 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNGFiY2JjYWVjODU1ZTc0YTBiMjJhNDk4OGNmOWUwZWI2MWE4MzA5NCJ9

🤖 I have created a release *beep* *boop* --- ### Updating meta-information for bleeding-edge SNAPSHOT release. --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [io.grpc:grpc-protobuf](https://togithub.com/grpc/grpc-java) | `1.46.0` -> `1.47.0` | [![age](https://badges.renovateapi.com/packages/maven/io.grpc:grpc-protobuf/1.47.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/maven/io.grpc:grpc-protobuf/1.47.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/maven/io.grpc:grpc-protobuf/1.47.0/compatibility-slim/1.46.0)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/maven/io.grpc:grpc-protobuf/1.47.0/confidence-slim/1.46.0)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>grpc/grpc-java</summary> ### [`v1.47.0`](https://togithub.com/grpc/grpc-java/releases/tag/v1.47.0) ##### Bug Fixes - api: Ignore `ClassCastExceptions` for hard-coded providers on Android ([#9174](https://togithub.com/grpc/grpc-java/issues/9174)). This avoids `ServiceConfigurationError` in certain cases when an “SDK” includes a copy of gRPC that was renamed with Proguard-like tools that do precise class name rewriting (versus something like Maven Shade Plugin which uses coarse pattern matching) - binder: respect requested message limits when provide received messages to listener ([#9163](https://togithub.com/grpc/grpc-java/issues/9163)) - binder: Avoid an ISE from `asAndroidAppUri()` ([#9169](https://togithub.com/grpc/grpc-java/issues/9169)) - okhttp: Use the user-provided `ScheduledExecutorService` for keepalive if provided. Previously the user-provided executor was used for deadlines, but not keepalive. Keepalive always used the default executor ([#9073](https://togithub.com/grpc/grpc-java/issues/9073)) - bom: Reverted “bom: Removed protoc-gen-grpc-java from the BOM” in v1.46.0. There was a way to use it with Gradle ([#9154](https://togithub.com/grpc/grpc-java/issues/9154)) - build: fix grpc-java build against protobuf 3.21 ([#9218](https://togithub.com/grpc/grpc-java/issues/9218)) - grpclb: Adds missing META-INF resources to `libgrpclb.jar` produced by bazel `//grpclb:grpclb` target ([#9156](https://togithub.com/grpc/grpc-java/issues/9156)) - xds: Protect xdstp processing with federation env var. If the xds server uses xdstp:// resource names it was possible for federation code paths to be entered even without enabling the experimental federation support. This is now fixed and it is safe for xds servers to use xdstp:// resource names. ([#9190](https://togithub.com/grpc/grpc-java/issues/9190)) - xds: fix bugs in ring-hash load balancer picking subchannel behavior per gRFC. The bug may cause connection not failing over from `TRANSIENT_FAILURE` status. ([#9085](https://togithub.com/grpc/grpc-java/issues/9085)) - xds: NACK EDS resources with duplicate localities in the same priority ([#9119](https://togithub.com/grpc/grpc-java/issues/9119)) ##### New Features - api: Add connection management APIs to `ServerBuilder` ([#9176](https://togithub.com/grpc/grpc-java/issues/9176)). This includes methods for keepalive, max connection age, and max connection idle. These APIs have been available on NettyServerBuilder since v1.4.0 - api: allow `NameResolver` to influence which transport to use ([#9076](https://togithub.com/grpc/grpc-java/issues/9076)) - api: New API in ServerCall to expose SecurityLevel on server-side ([#8943](https://togithub.com/grpc/grpc-java/issues/8943)) - netty: Add `NameResolver` for `unix:` scheme, as defined in [gRPC Name Resolution](https://togithub.com/grpc/grpc/blob/master/doc/naming.md) ([#9113](https://togithub.com/grpc/grpc-java/issues/9113)) - binder: add `allOf` security policy, which allows access iff ALL given security policies allow access. ([#9125](https://togithub.com/grpc/grpc-java/issues/9125)) - binder: add `anyOf` security policy, which allows access if ANY given security policy allows access. ([#9147](https://togithub.com/grpc/grpc-java/issues/9147)) - binder: add `hasPermissions` security policy, which checks that a caller has all of the given package permissions. ([#9117](https://togithub.com/grpc/grpc-java/issues/9117)) - build: Add Bazel build support for xds, googleapis, rls, and services. grpc-services previously had partial bazel support, but some parts were missing. These artifacts are now configured via `IO_GRPC_GRPC_JAVA_OVERRIDE_TARGETS` so maven_install will not use the artifacts from Maven Central ([#9172](https://togithub.com/grpc/grpc-java/issues/9172)) - xds: New ability to configure custom load balancer implementations via the xDS `Cluster.load_balancing_policy` field. This implements [gRFC A52: gRPC xDS Custom Load Balancer Configuration](https://togithub.com/grpc/proposal/blob/master/A52-xds-custom-lb-policies.md). ([#9141](https://togithub.com/grpc/grpc-java/issues/9141)) - xds, orca: add support for custom backend metrics reporting: allow setting metrics at gRPC server and consuming metrics reports from a custom load balancing policy at the client. This implements [gRFC A51: Custom Backend Metrics Support](https://togithub.com/grpc/proposal/blob/master/A51-custom-backend-metrics.md). - xds: include node ID in RPC failure status messages from the XdsClient ([#9099](https://togithub.com/grpc/grpc-java/issues/9099)) - xds: support for the `is_optional` logic in Cluster Specifier Plugins: if an unsupported Cluster Specifier Plugin is optional, don't NACK, and skip any routes that point to it. ([#9168](https://togithub.com/grpc/grpc-java/issues/9168)) ##### Behavior Changes - xds: Allow unspecified listener traffic direction, to match other languages and to work with Istio ([#9173](https://togithub.com/grpc/grpc-java/issues/9173)) - xds: change priority load balancer failover time behavior and `ring_hash` LB aggregation rule to better handle transient_failure channel status ([#9084](https://togithub.com/grpc/grpc-java/issues/9084), [#9093](https://togithub.com/grpc/grpc-java/issues/9093)) ##### Dependencies - Bump GSON to 2.9.0. Earlier versions of GSON are affected by [CVE-2022-25647](https://nvd.nist.gov/vuln/detail/CVE-2022-25647). gRPC was not impacted by the vulnerability. ([#9215](https://togithub.com/grpc/grpc-java/issues/9215)) - gcp-observability: add grpc-census as a dependency and update opencensus version ([#9140](https://togithub.com/grpc/grpc-java/issues/9140)) ##### Acknowledgements [@caseyduquettesc](https://togithub.com/caseyduquettesc) [@cfredri4](https://togithub.com/cfredri4) [@jvolkman](https://togithub.com/jvolkman) [@mirlord](https://togithub.com/mirlord) [@ovidiutirla](https://togithub.com/ovidiutirla) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/java-iam).

🤖 I have created a release *beep* *boop* --- ## [1.4.1](googleapis/java-iam@v1.4.0...v1.4.1) (2022-06-13) ### Dependencies * update dependency com.google.api:api-common to v2.2.1 ([#358](googleapis/java-iam#358)) ([ca095d6](googleapis/java-iam@ca095d6)) * update dependency com.google.protobuf:protobuf-java to v3.21.0 ([#354](googleapis/java-iam#354)) ([8c9442d](googleapis/java-iam@8c9442d)) * update dependency com.google.protobuf:protobuf-java to v3.21.1 ([#355](googleapis/java-iam#355)) ([19ea082](googleapis/java-iam@19ea082)) * update dependency io.grpc:grpc-protobuf to v1.47.0 ([#356](googleapis/java-iam#356)) ([6c16481](googleapis/java-iam@6c16481)) * update dependency io.grpc:grpc-stub to v1.47.0 ([#357](googleapis/java-iam#357)) ([698bd90](googleapis/java-iam@698bd90)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

mziccard added 7 commits November 11, 2015 15:32

Add javadoc to Acl

dde30aa

Add javadoc to Blob

93dd0c2

Add javadoc to BlobId

6de12f2

Add javadoc to Bucket

e2a4500

Add javadoc to Cors

9608e61

Add javadoc to BlobInfo

ecaf751

Add javadoc to Storage

b9ef508

mziccard added docs api: storage Issues related to the Cloud Storage API. labels Nov 11, 2015

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Nov 11, 2015

aozarov reviewed Nov 11, 2015
View reviewed changes

gcloud-java-storage/src/main/java/com/google/gcloud/storage/BlobInfo.java

@@ -158,11 +173,20 @@ Builder componentCount(Integer componentCount) {

return this;

}

/**

* Sets the blob's data cache control.

This comment was marked as spam.

Sign in to view

aozarov mentioned this pull request Nov 11, 2015

Switch from enum to String for location and storageClass in BucketInfo #355

Merged

mziccard added 2 commits November 12, 2015 07:58

More detailed javadoc for BlobInfo

7193d0d

Better javadoc for (Bucket/Blob)ListOptions.prefix

5f9eaa4

aozarov added a commit that referenced this pull request Nov 12, 2015

Merge pull request #356 from mziccard/storage-javadoc

9979502

Better document Storage API

aozarov merged commit 9979502 into googleapis:master Nov 12, 2015

mziccard mentioned this pull request Nov 12, 2015

We should better document the Storage API #351

Closed

github-actions bot pushed a commit that referenced this pull request Jul 1, 2022

chore: change branch master to main in github configurations (#356)

104e5fb

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Better document Storage API #356

Better document Storage API #356

mziccard commented Nov 11, 2015

This comment was marked as spam.

aozarov commented Nov 11, 2015

aozarov commented Nov 11, 2015

mziccard commented Nov 12, 2015

Better document Storage API #356

Better document Storage API #356

Conversation

mziccard commented Nov 11, 2015

This comment was marked as spam.

aozarov commented Nov 11, 2015

aozarov commented Nov 11, 2015

mziccard commented Nov 12, 2015