From 417c5250eb7ad1a7b04a055a39d72e6536a63e18 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Mon, 15 Nov 2021 15:02:12 -0800 Subject: [PATCH] docs: Add comments to GCS gRPC API proto spec to describe how naming work (#1139) * docs: Add comments to GCS gRPC API proto spec to describe how naming works PiperOrigin-RevId: 408352508 Source-Author: Google APIs Source-Date: Mon Nov 8 08:42:59 2021 -0800 Source-Repo: googleapis/googleapis Source-Sha: be4be3dde73955e934eb6daddbab68e793e1c1e5 Source-Link: https://github.com/googleapis/googleapis/commit/be4be3dde73955e934eb6daddbab68e793e1c1e5 * chore: update Java and Python dependencies PiperOrigin-RevId: 408420890 Source-Author: Google APIs Source-Date: Mon Nov 8 13:03:45 2021 -0800 Source-Repo: googleapis/googleapis Source-Sha: 2921f9fb3bfbd16f6b2da0104373e2b47a80a65e Source-Link: https://github.com/googleapis/googleapis/commit/2921f9fb3bfbd16f6b2da0104373e2b47a80a65e --- .../com/google/storage/v2/StorageClient.java | 16 +++- .../com/google/storage/v2/package-info.java | 16 +++- .../com/google/storage/v2/StorageGrpc.java | 96 ++++++++++++++++++- .../java/com/google/storage/v2/Bucket.java | 49 ---------- .../google/storage/v2/BucketOrBuilder.java | 14 --- .../storage/v2/CommonRequestParams.java | 7 -- .../v2/CommonRequestParamsOrBuilder.java | 2 - .../java/com/google/storage/v2/Object.java | 7 -- .../google/storage/v2/ObjectOrBuilder.java | 2 - .../proto/google/storage/v2/storage.proto | 31 ++++-- synth.metadata | 6 +- 11 files changed, 145 insertions(+), 101 deletions(-) diff --git a/gapic-google-cloud-storage-v2/src/main/java/com/google/storage/v2/StorageClient.java b/gapic-google-cloud-storage-v2/src/main/java/com/google/storage/v2/StorageClient.java index 41da80132..5d98a7f57 100644 --- a/gapic-google-cloud-storage-v2/src/main/java/com/google/storage/v2/StorageClient.java +++ b/gapic-google-cloud-storage-v2/src/main/java/com/google/storage/v2/StorageClient.java @@ -29,7 +29,21 @@ // AUTO-GENERATED DOCUMENTATION AND CLASS. /** - * Service Description: Manages Google Cloud Storage resources. + * Service Description: ## API Overview and Naming Syntax + * + *

The GCS gRPC API allows applications to read and write data through the abstractions of + * buckets and objects. For a description of these abstractions please see + * https://cloud.google.com/storage/docs. + * + *

Resources are named as follows: - Projects are referred to as they are defined by the Resource + * Manager API, using strings like `projects/123456` or `projects/my-string-id`. - Buckets are named + * using string names of the form: `projects/{project}/buckets/{bucket}` For globally unique + * buckets, `_` may be substituted for the project. - Objects are uniquely identified by their name + * along with the name of the bucket they belong to, as separate strings in this API. For example: + * + *

ReadObjectRequest { bucket: 'projects/_/buckets/my-bucket' object: 'my-object' } Note that + * object names can contain `/` characters, which are treated as any other character (no special + * directory semantics). * *

This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. Sample code to get started: diff --git a/gapic-google-cloud-storage-v2/src/main/java/com/google/storage/v2/package-info.java b/gapic-google-cloud-storage-v2/src/main/java/com/google/storage/v2/package-info.java index bfb389cc8..2bc5db089 100644 --- a/gapic-google-cloud-storage-v2/src/main/java/com/google/storage/v2/package-info.java +++ b/gapic-google-cloud-storage-v2/src/main/java/com/google/storage/v2/package-info.java @@ -19,7 +19,21 @@ * *

======================= StorageClient ======================= * - *

Service Description: Manages Google Cloud Storage resources. + *

Service Description: ## API Overview and Naming Syntax + * + *

The GCS gRPC API allows applications to read and write data through the abstractions of + * buckets and objects. For a description of these abstractions please see + * https://cloud.google.com/storage/docs. + * + *

Resources are named as follows: - Projects are referred to as they are defined by the Resource + * Manager API, using strings like `projects/123456` or `projects/my-string-id`. - Buckets are named + * using string names of the form: `projects/{project}/buckets/{bucket}` For globally unique + * buckets, `_` may be substituted for the project. - Objects are uniquely identified by their name + * along with the name of the bucket they belong to, as separate strings in this API. For example: + * + *

ReadObjectRequest { bucket: 'projects/_/buckets/my-bucket' object: 'my-object' } Note that + * object names can contain `/` characters, which are treated as any other character (no special + * directory semantics). * *

Sample for StorageClient: * diff --git a/grpc-google-cloud-storage-v2/src/main/java/com/google/storage/v2/StorageGrpc.java b/grpc-google-cloud-storage-v2/src/main/java/com/google/storage/v2/StorageGrpc.java index 0875e1a65..d589fa889 100644 --- a/grpc-google-cloud-storage-v2/src/main/java/com/google/storage/v2/StorageGrpc.java +++ b/grpc-google-cloud-storage-v2/src/main/java/com/google/storage/v2/StorageGrpc.java @@ -21,12 +21,30 @@ * * * 

- * Manages Google Cloud Storage resources.
+ * ## API Overview and Naming Syntax
+ * The GCS gRPC API allows applications to read and write data through the
+ * abstractions of buckets and objects. For a description of these abstractions
+ * please see https://cloud.google.com/storage/docs.
+ * Resources are named as follows:
+ *   - Projects are referred to as they are defined by the Resource Manager API,
+ *     using strings like `projects/123456` or `projects/my-string-id`.
+ *   - Buckets are named using string names of the form:
+ *     `projects/{project}/buckets/{bucket}`
+ *     For globally unique buckets, `_` may be substituted for the project.
+ *   - Objects are uniquely identified by their name along with the name of the
+ *     bucket they belong to, as separate strings in this API. For example:
+ *       ReadObjectRequest {
+ *         bucket: 'projects/_/buckets/my-bucket'
+ *         object: 'my-object'
+ *       }
+ *     Note that object names can contain `/` characters, which are treated as
+ *     any other character (no special directory semantics).
  *
*/ @javax.annotation.Generated( value = "by gRPC proto compiler", comments = "Source: google/storage/v2/storage.proto") +@io.grpc.stub.annotations.GrpcGenerated public final class StorageGrpc { private StorageGrpc() {} @@ -252,7 +270,24 @@ public StorageFutureStub newStub( * * * 
-   * Manages Google Cloud Storage resources.
+   * ## API Overview and Naming Syntax
+   * The GCS gRPC API allows applications to read and write data through the
+   * abstractions of buckets and objects. For a description of these abstractions
+   * please see https://cloud.google.com/storage/docs.
+   * Resources are named as follows:
+   *   - Projects are referred to as they are defined by the Resource Manager API,
+   *     using strings like `projects/123456` or `projects/my-string-id`.
+   *   - Buckets are named using string names of the form:
+   *     `projects/{project}/buckets/{bucket}`
+   *     For globally unique buckets, `_` may be substituted for the project.
+   *   - Objects are uniquely identified by their name along with the name of the
+   *     bucket they belong to, as separate strings in this API. For example:
+   *       ReadObjectRequest {
+   *         bucket: 'projects/_/buckets/my-bucket'
+   *         object: 'my-object'
+   *       }
+   *     Note that object names can contain `/` characters, which are treated as
+   *     any other character (no special directory semantics).
    *
*/ public abstract static class StorageImplBase implements io.grpc.BindableService { @@ -382,7 +417,24 @@ public final io.grpc.ServerServiceDefinition bindService() { * * * 
-   * Manages Google Cloud Storage resources.
+   * ## API Overview and Naming Syntax
+   * The GCS gRPC API allows applications to read and write data through the
+   * abstractions of buckets and objects. For a description of these abstractions
+   * please see https://cloud.google.com/storage/docs.
+   * Resources are named as follows:
+   *   - Projects are referred to as they are defined by the Resource Manager API,
+   *     using strings like `projects/123456` or `projects/my-string-id`.
+   *   - Buckets are named using string names of the form:
+   *     `projects/{project}/buckets/{bucket}`
+   *     For globally unique buckets, `_` may be substituted for the project.
+   *   - Objects are uniquely identified by their name along with the name of the
+   *     bucket they belong to, as separate strings in this API. For example:
+   *       ReadObjectRequest {
+   *         bucket: 'projects/_/buckets/my-bucket'
+   *         object: 'my-object'
+   *       }
+   *     Note that object names can contain `/` characters, which are treated as
+   *     any other character (no special directory semantics).
    *
*/ public static final class StorageStub extends io.grpc.stub.AbstractAsyncStub { @@ -493,7 +545,24 @@ public void queryWriteStatus( * * * 
-   * Manages Google Cloud Storage resources.
+   * ## API Overview and Naming Syntax
+   * The GCS gRPC API allows applications to read and write data through the
+   * abstractions of buckets and objects. For a description of these abstractions
+   * please see https://cloud.google.com/storage/docs.
+   * Resources are named as follows:
+   *   - Projects are referred to as they are defined by the Resource Manager API,
+   *     using strings like `projects/123456` or `projects/my-string-id`.
+   *   - Buckets are named using string names of the form:
+   *     `projects/{project}/buckets/{bucket}`
+   *     For globally unique buckets, `_` may be substituted for the project.
+   *   - Objects are uniquely identified by their name along with the name of the
+   *     bucket they belong to, as separate strings in this API. For example:
+   *       ReadObjectRequest {
+   *         bucket: 'projects/_/buckets/my-bucket'
+   *         object: 'my-object'
+   *       }
+   *     Note that object names can contain `/` characters, which are treated as
+   *     any other character (no special directory semantics).
    *
*/ public static final class StorageBlockingStub @@ -563,7 +632,24 @@ public com.google.storage.v2.QueryWriteStatusResponse queryWriteStatus( * * * 
-   * Manages Google Cloud Storage resources.
+   * ## API Overview and Naming Syntax
+   * The GCS gRPC API allows applications to read and write data through the
+   * abstractions of buckets and objects. For a description of these abstractions
+   * please see https://cloud.google.com/storage/docs.
+   * Resources are named as follows:
+   *   - Projects are referred to as they are defined by the Resource Manager API,
+   *     using strings like `projects/123456` or `projects/my-string-id`.
+   *   - Buckets are named using string names of the form:
+   *     `projects/{project}/buckets/{bucket}`
+   *     For globally unique buckets, `_` may be substituted for the project.
+   *   - Objects are uniquely identified by their name along with the name of the
+   *     bucket they belong to, as separate strings in this API. For example:
+   *       ReadObjectRequest {
+   *         bucket: 'projects/_/buckets/my-bucket'
+   *         object: 'my-object'
+   *       }
+   *     Note that object names can contain `/` characters, which are treated as
+   *     any other character (no special directory semantics).
    *
*/ public static final class StorageFutureStub diff --git a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/Bucket.java b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/Bucket.java index 91808f239..72acdc83a 100644 --- a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/Bucket.java +++ b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/Bucket.java @@ -14384,11 +14384,6 @@ public com.google.storage.v2.Bucket.Website getDefaultInstanceForType() { * * 
    * Immutable. The name of the bucket.
-   * Global buckets will be of the format `projects/{project}/buckets/{bucket}`.
-   * Other sorts of buckets in the future are not guaranteed to follow this
-   * pattern.
-   * For globally unique bucket names, a `_` may be substituted for the project
-   * ID.
    *
* * string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; @@ -14412,11 +14407,6 @@ public java.lang.String getName() { * * 
    * Immutable. The name of the bucket.
-   * Global buckets will be of the format `projects/{project}/buckets/{bucket}`.
-   * Other sorts of buckets in the future are not guaranteed to follow this
-   * pattern.
-   * For globally unique bucket names, a `_` may be substituted for the project
-   * ID.
    *
* * string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; @@ -14496,8 +14486,6 @@ public com.google.protobuf.ByteString getBucketIdBytes() { * * 
    * Immutable. The project which owns this bucket.
-   * Format: projects/{project_number}
-   * Example: `projects/123456`.
    *
* * @@ -14523,8 +14511,6 @@ public java.lang.String getProject() { * * 
    * Immutable. The project which owns this bucket.
-   * Format: projects/{project_number}
-   * Example: `projects/123456`.
    *
* * @@ -16767,11 +16753,6 @@ public Builder mergeFrom( * * 
      * Immutable. The name of the bucket.
-     * Global buckets will be of the format `projects/{project}/buckets/{bucket}`.
-     * Other sorts of buckets in the future are not guaranteed to follow this
-     * pattern.
-     * For globally unique bucket names, a `_` may be substituted for the project
-     * ID.
      *
* * string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; @@ -16794,11 +16775,6 @@ public java.lang.String getName() { * * 
      * Immutable. The name of the bucket.
-     * Global buckets will be of the format `projects/{project}/buckets/{bucket}`.
-     * Other sorts of buckets in the future are not guaranteed to follow this
-     * pattern.
-     * For globally unique bucket names, a `_` may be substituted for the project
-     * ID.
      *
* * string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; @@ -16821,11 +16797,6 @@ public com.google.protobuf.ByteString getNameBytes() { * * 
      * Immutable. The name of the bucket.
-     * Global buckets will be of the format `projects/{project}/buckets/{bucket}`.
-     * Other sorts of buckets in the future are not guaranteed to follow this
-     * pattern.
-     * For globally unique bucket names, a `_` may be substituted for the project
-     * ID.
      *
* * string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; @@ -16847,11 +16818,6 @@ public Builder setName(java.lang.String value) { * * 
      * Immutable. The name of the bucket.
-     * Global buckets will be of the format `projects/{project}/buckets/{bucket}`.
-     * Other sorts of buckets in the future are not guaranteed to follow this
-     * pattern.
-     * For globally unique bucket names, a `_` may be substituted for the project
-     * ID.
      *
* * string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; @@ -16869,11 +16835,6 @@ public Builder clearName() { * * 
      * Immutable. The name of the bucket.
-     * Global buckets will be of the format `projects/{project}/buckets/{bucket}`.
-     * Other sorts of buckets in the future are not guaranteed to follow this
-     * pattern.
-     * For globally unique bucket names, a `_` may be substituted for the project
-     * ID.
      *
* * string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; @@ -17014,8 +16975,6 @@ public Builder setBucketIdBytes(com.google.protobuf.ByteString value) { * * 
      * Immutable. The project which owns this bucket.
-     * Format: projects/{project_number}
-     * Example: `projects/123456`.
      *
* * @@ -17040,8 +16999,6 @@ public java.lang.String getProject() { * * 
      * Immutable. The project which owns this bucket.
-     * Format: projects/{project_number}
-     * Example: `projects/123456`.
      *
* * @@ -17066,8 +17023,6 @@ public com.google.protobuf.ByteString getProjectBytes() { * * 
      * Immutable. The project which owns this bucket.
-     * Format: projects/{project_number}
-     * Example: `projects/123456`.
      *
* * @@ -17091,8 +17046,6 @@ public Builder setProject(java.lang.String value) { * * 
      * Immutable. The project which owns this bucket.
-     * Format: projects/{project_number}
-     * Example: `projects/123456`.
      *
* * @@ -17112,8 +17065,6 @@ public Builder clearProject() { * * 
      * Immutable. The project which owns this bucket.
-     * Format: projects/{project_number}
-     * Example: `projects/123456`.
      *
* * diff --git a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/BucketOrBuilder.java b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/BucketOrBuilder.java index 9cfd286d1..3dc8804d3 100644 --- a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/BucketOrBuilder.java +++ b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/BucketOrBuilder.java @@ -28,11 +28,6 @@ public interface BucketOrBuilder * * 
    * Immutable. The name of the bucket.
-   * Global buckets will be of the format `projects/{project}/buckets/{bucket}`.
-   * Other sorts of buckets in the future are not guaranteed to follow this
-   * pattern.
-   * For globally unique bucket names, a `_` may be substituted for the project
-   * ID.
    *
* * string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; @@ -45,11 +40,6 @@ public interface BucketOrBuilder * * 
    * Immutable. The name of the bucket.
-   * Global buckets will be of the format `projects/{project}/buckets/{bucket}`.
-   * Other sorts of buckets in the future are not guaranteed to follow this
-   * pattern.
-   * For globally unique bucket names, a `_` may be substituted for the project
-   * ID.
    *
* * string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; @@ -92,8 +82,6 @@ public interface BucketOrBuilder * * 
    * Immutable. The project which owns this bucket.
-   * Format: projects/{project_number}
-   * Example: `projects/123456`.
    *
* * @@ -108,8 +96,6 @@ public interface BucketOrBuilder * * 
    * Immutable. The project which owns this bucket.
-   * Format: projects/{project_number}
-   * Example: `projects/123456`.
    *
* * diff --git a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/CommonRequestParams.java b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/CommonRequestParams.java index 70e27fdcd..831d2c657 100644 --- a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/CommonRequestParams.java +++ b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/CommonRequestParams.java @@ -118,7 +118,6 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { * * 
    * Required. Required when using buckets with Requestor Pays feature enabled.
-   * Example: `projects/123456`.
    *
* * @@ -144,7 +143,6 @@ public java.lang.String getUserProject() { * * 
    * Required. Required when using buckets with Requestor Pays feature enabled.
-   * Example: `projects/123456`.
    *
* * @@ -488,7 +486,6 @@ public Builder mergeFrom( * * 
      * Required. Required when using buckets with Requestor Pays feature enabled.
-     * Example: `projects/123456`.
      *
* * @@ -513,7 +510,6 @@ public java.lang.String getUserProject() { * * 
      * Required. Required when using buckets with Requestor Pays feature enabled.
-     * Example: `projects/123456`.
      *
* * @@ -538,7 +534,6 @@ public com.google.protobuf.ByteString getUserProjectBytes() { * * 
      * Required. Required when using buckets with Requestor Pays feature enabled.
-     * Example: `projects/123456`.
      *
* * @@ -562,7 +557,6 @@ public Builder setUserProject(java.lang.String value) { * * 
      * Required. Required when using buckets with Requestor Pays feature enabled.
-     * Example: `projects/123456`.
      *
* * @@ -582,7 +576,6 @@ public Builder clearUserProject() { * * 
      * Required. Required when using buckets with Requestor Pays feature enabled.
-     * Example: `projects/123456`.
      *
* * diff --git a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/CommonRequestParamsOrBuilder.java b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/CommonRequestParamsOrBuilder.java index 54558051a..050241c84 100644 --- a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/CommonRequestParamsOrBuilder.java +++ b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/CommonRequestParamsOrBuilder.java @@ -28,7 +28,6 @@ public interface CommonRequestParamsOrBuilder * * 
    * Required. Required when using buckets with Requestor Pays feature enabled.
-   * Example: `projects/123456`.
    *
* * @@ -43,7 +42,6 @@ public interface CommonRequestParamsOrBuilder * * 
    * Required. Required when using buckets with Requestor Pays feature enabled.
-   * Example: `projects/123456`.
    *
* * diff --git a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/Object.java b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/Object.java index 9914081c3..ce256ffba 100644 --- a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/Object.java +++ b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/Object.java @@ -1215,7 +1215,6 @@ public com.google.protobuf.ByteString getNameBytes() { * * 
    * Immutable. The name of the bucket containing this object.
-   * Example: `projects/_/buckets/foo`.
    *
* * @@ -1241,7 +1240,6 @@ public java.lang.String getBucket() { * * 
    * Immutable. The name of the bucket containing this object.
-   * Example: `projects/_/buckets/foo`.
    *
* * @@ -3498,7 +3496,6 @@ public Builder setNameBytes(com.google.protobuf.ByteString value) { * * 
      * Immutable. The name of the bucket containing this object.
-     * Example: `projects/_/buckets/foo`.
      *
* * @@ -3523,7 +3520,6 @@ public java.lang.String getBucket() { * * 
      * Immutable. The name of the bucket containing this object.
-     * Example: `projects/_/buckets/foo`.
      *
* * @@ -3548,7 +3544,6 @@ public com.google.protobuf.ByteString getBucketBytes() { * * 
      * Immutable. The name of the bucket containing this object.
-     * Example: `projects/_/buckets/foo`.
      *
* * @@ -3572,7 +3567,6 @@ public Builder setBucket(java.lang.String value) { * * 
      * Immutable. The name of the bucket containing this object.
-     * Example: `projects/_/buckets/foo`.
      *
* * @@ -3592,7 +3586,6 @@ public Builder clearBucket() { * * 
      * Immutable. The name of the bucket containing this object.
-     * Example: `projects/_/buckets/foo`.
      *
* * diff --git a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/ObjectOrBuilder.java b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/ObjectOrBuilder.java index 084105197..c82202c29 100644 --- a/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/ObjectOrBuilder.java +++ b/proto-google-cloud-storage-v2/src/main/java/com/google/storage/v2/ObjectOrBuilder.java @@ -65,7 +65,6 @@ public interface ObjectOrBuilder * * 
    * Immutable. The name of the bucket containing this object.
-   * Example: `projects/_/buckets/foo`.
    *
* * @@ -80,7 +79,6 @@ public interface ObjectOrBuilder * * 
    * Immutable. The name of the bucket containing this object.
-   * Example: `projects/_/buckets/foo`.
    *
* * diff --git a/proto-google-cloud-storage-v2/src/main/proto/google/storage/v2/storage.proto b/proto-google-cloud-storage-v2/src/main/proto/google/storage/v2/storage.proto index 46170df1c..c36b9df23 100644 --- a/proto-google-cloud-storage-v2/src/main/proto/google/storage/v2/storage.proto +++ b/proto-google-cloud-storage-v2/src/main/proto/google/storage/v2/storage.proto @@ -35,7 +35,27 @@ option (google.api.resource_definition) = { pattern: "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}" }; -// Manages Google Cloud Storage resources. +// ## API Overview and Naming Syntax +// +// The GCS gRPC API allows applications to read and write data through the +// abstractions of buckets and objects. For a description of these abstractions +// please see https://cloud.google.com/storage/docs. +// +// Resources are named as follows: +// - Projects are referred to as they are defined by the Resource Manager API, +// using strings like `projects/123456` or `projects/my-string-id`. +// - Buckets are named using string names of the form: +// `projects/{project}/buckets/{bucket}` +// For globally unique buckets, `_` may be substituted for the project. +// - Objects are uniquely identified by their name along with the name of the +// bucket they belong to, as separate strings in this API. For example: +// +// ReadObjectRequest { +// bucket: 'projects/_/buckets/my-bucket' +// object: 'my-object' +// } +// Note that object names can contain `/` characters, which are treated as +// any other character (no special directory semantics). service Storage { option (google.api.default_host) = "storage.googleapis.com"; option (google.api.oauth_scopes) = @@ -353,7 +373,6 @@ message CommonObjectRequestParams { // Parameters that can be passed to any request. message CommonRequestParams { // Required. Required when using buckets with Requestor Pays feature enabled. - // Example: `projects/123456`. string user_project = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { @@ -664,11 +683,6 @@ message Bucket { } // Immutable. The name of the bucket. - // Global buckets will be of the format `projects/{project}/buckets/{bucket}`. - // Other sorts of buckets in the future are not guaranteed to follow this - // pattern. - // For globally unique bucket names, a `_` may be substituted for the project - // ID. string name = 1 [(google.api.field_behavior) = IMMUTABLE]; // Output only. The user-chosen part of the bucket name. The `{bucket}` portion of the @@ -677,8 +691,6 @@ message Bucket { string bucket_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Immutable. The project which owns this bucket. - // Format: projects/{project_number} - // Example: `projects/123456`. string project = 3 [ (google.api.field_behavior) = IMMUTABLE, (google.api.resource_reference) = { @@ -895,7 +907,6 @@ message Object { string name = 1 [(google.api.field_behavior) = IMMUTABLE]; // Immutable. The name of the bucket containing this object. - // Example: `projects/_/buckets/foo`. string bucket = 2 [ (google.api.field_behavior) = IMMUTABLE, (google.api.resource_reference) = { diff --git a/synth.metadata b/synth.metadata index 0ba5a7dfc..172751f36 100644 --- a/synth.metadata +++ b/synth.metadata @@ -4,15 +4,15 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/java-storage.git", - "sha": "eb9006a81a410a0180ff3327623780cf59bf050b" + "sha": "0ba77f3c8f7379df0e25340f06b711d22d10b602" } }, { "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "d2977af9e9f1fc0c9dc8368352daa032471f3c63", - "internalRef": "403132955" + "sha": "2921f9fb3bfbd16f6b2da0104373e2b47a80a65e", + "internalRef": "408420890" } }, {