fix: [discoveryengine] update sample query, sample query set patterns (…

…#5558) * fix!: update sample query, sample query set patterns feat: A new resource pattern value `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}` added to the resource definition `discoveryengine.googleapis.com/SampleQuery` feat: A new resource pattern value `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}` added to the resource definition `discoveryengine.googleapis.com/SampleQuerySet` docs: keep the API doc up-to-date with recent changes PiperOrigin-RevId: 653290553 Source-Link: googleapis/googleapis@1964be3 Source-Link: googleapis/googleapis-gen@71a6ec9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpc2NvdmVyeWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiNzFhNmVjOTM2MDViYjgxMzUwMGQ3NWRhNGU5OTkyNGEyYzc3M2E5OSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Jul 17, 2024 · 2c4325f · 2c4325f
1 parent 28f75b7
commit 2c4325f
Show file tree

Hide file tree

Showing 54 changed files with 467 additions and 467 deletions.
diff --git a/...google-cloud-discoveryengine/protos/google/cloud/discoveryengine/v1alpha/evaluation.proto b/...google-cloud-discoveryengine/protos/google/cloud/discoveryengine/v1alpha/evaluation.proto
@@ -94,14 +94,14 @@ message Evaluation {
     FAILED = 4;
   }
 
-  // Immutable. The full resource name of the
+  // Identifier. The full resource name of the
   // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], in the
   // format of
   // `projects/{project}/locations/{location}/evaluations/{evaluation}`.
   //
   // This field must be a UTF-8 encoded string with a length limit of 1024
   // characters.
-  string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Required. The specification of the evaluation.
   EvaluationSpec evaluation_spec = 2 [(google.api.field_behavior) = REQUIRED];

diff --git a/...ogle-cloud-discoveryengine/protos/google/cloud/discoveryengine/v1alpha/sample_query.proto b/...ogle-cloud-discoveryengine/protos/google/cloud/discoveryengine/v1alpha/sample_query.proto
@@ -33,7 +33,7 @@ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
 message SampleQuery {
   option (google.api.resource) = {
     type: "discoveryengine.googleapis.com/SampleQuery"
-    pattern: "projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}"
+    pattern: "projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}"
   };
 
   // Query Entry captures metadata to be used for search evaluation.
@@ -71,12 +71,12 @@ message SampleQuery {
     QueryEntry query_entry = 2;
   }
 
-  // Immutable. The full resource name of the sample query, in the format of
-  // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`.
+  // Identifier. The full resource name of the sample query, in the format of
+  // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
   //
   // This field must be a UTF-8 encoded string with a length limit of 1024
   // characters.
-  string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Output only. Timestamp the
   // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] was created

diff --git a/...ud-discoveryengine/protos/google/cloud/discoveryengine/v1alpha/sample_query_service.proto b/...ud-discoveryengine/protos/google/cloud/discoveryengine/v1alpha/sample_query_service.proto
@@ -114,7 +114,7 @@ service SampleQueryService {
 message GetSampleQueryRequest {
   // Required. Full resource name of
   // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], such as
-  // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`.
+  // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
   //
   // If the caller does not have permission to access the
   // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
@@ -247,7 +247,7 @@ message UpdateSampleQueryRequest {
 message DeleteSampleQueryRequest {
   // Required. Full resource name of
   // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], such as
-  // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`.
+  // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
   //
   // If the caller does not have permission to delete the
   // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless

diff --git a/...-cloud-discoveryengine/protos/google/cloud/discoveryengine/v1alpha/sample_query_set.proto b/...-cloud-discoveryengine/protos/google/cloud/discoveryengine/v1alpha/sample_query_set.proto
@@ -34,17 +34,17 @@ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
 message SampleQuerySet {
   option (google.api.resource) = {
     type: "discoveryengine.googleapis.com/SampleQuerySet"
-    pattern: "projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}"
+    pattern: "projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}"
   };
 
-  // Immutable. The full resource name of the
+  // Identifier. The full resource name of the
   // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], in
   // the format of
-  // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+  // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
   //
   // This field must be a UTF-8 encoded string with a length limit of 1024
   // characters.
-  string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
   // Required. The sample query set display name.
   //

diff --git a/...iscoveryengine/protos/google/cloud/discoveryengine/v1alpha/sample_query_set_service.proto b/...iscoveryengine/protos/google/cloud/discoveryengine/v1alpha/sample_query_set_service.proto
@@ -100,7 +100,7 @@ message GetSampleQuerySetRequest {
   // Required. Full resource name of
   // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], such
   // as
-  // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+  // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
   //
   // If the caller does not have permission to access the
   // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
@@ -239,7 +239,7 @@ message DeleteSampleQuerySetRequest {
   // Required. Full resource name of
   // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], such
   // as
-  // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+  // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
   //
   // If the caller does not have permission to delete the
   // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],

diff --git a/packages/google-cloud-discoveryengine/protos/protos.json b/packages/google-cloud-discoveryengine/protos/protos.json
diff --git a/...oud-discoveryengine/samples/generated/v1alpha/sample_query_service.delete_sample_query.js b/...oud-discoveryengine/samples/generated/v1alpha/sample_query_service.delete_sample_query.js
@@ -31,7 +31,7 @@ function main(name) {
   /**
    *  Required. Full resource name of
    *  SampleQuery google.cloud.discoveryengine.v1alpha.SampleQuery, such as
-   *  `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`.
+   *  `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
    *  If the caller does not have permission to delete the
    *  SampleQuery google.cloud.discoveryengine.v1alpha.SampleQuery, regardless
    *  of whether or not it exists, a `PERMISSION_DENIED` error is returned.

diff --git a/...-cloud-discoveryengine/samples/generated/v1alpha/sample_query_service.get_sample_query.js b/...-cloud-discoveryengine/samples/generated/v1alpha/sample_query_service.get_sample_query.js
@@ -31,7 +31,7 @@ function main(name) {
   /**
    *  Required. Full resource name of
    *  SampleQuery google.cloud.discoveryengine.v1alpha.SampleQuery, such as
-   *  `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`.
+   *  `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
    *  If the caller does not have permission to access the
    *  SampleQuery google.cloud.discoveryengine.v1alpha.SampleQuery, regardless
    *  of whether or not it exists, a PERMISSION_DENIED error is returned.

diff --git a/...overyengine/samples/generated/v1alpha/sample_query_set_service.delete_sample_query_set.js b/...overyengine/samples/generated/v1alpha/sample_query_set_service.delete_sample_query_set.js
@@ -32,7 +32,7 @@ function main(name) {
    *  Required. Full resource name of
    *  SampleQuerySet google.cloud.discoveryengine.v1alpha.SampleQuerySet, such
    *  as
-   *  `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+   *  `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
    *  If the caller does not have permission to delete the
    *  SampleQuerySet google.cloud.discoveryengine.v1alpha.SampleQuerySet,
    *  regardless of whether or not it exists, a `PERMISSION_DENIED` error is

diff --git a/...iscoveryengine/samples/generated/v1alpha/sample_query_set_service.get_sample_query_set.js b/...iscoveryengine/samples/generated/v1alpha/sample_query_set_service.get_sample_query_set.js
@@ -32,7 +32,7 @@ function main(name) {
    *  Required. Full resource name of
    *  SampleQuerySet google.cloud.discoveryengine.v1alpha.SampleQuerySet, such
    *  as
-   *  `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+   *  `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
    *  If the caller does not have permission to access the
    *  SampleQuerySet google.cloud.discoveryengine.v1alpha.SampleQuerySet,
    *  regardless of whether or not it exists, a PERMISSION_DENIED error is

diff --git a/packages/google-cloud-discoveryengine/src/v1alpha/acl_config_service_client.ts b/packages/google-cloud-discoveryengine/src/v1alpha/acl_config_service_client.ts
@@ -340,10 +340,10 @@ export class AclConfigServiceClient {
           'projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'
         ),
       sampleQueryPathTemplate: new this._gaxModule.PathTemplate(
-        'projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}'
+        'projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'
       ),
       sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate(
-        'projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}'
+        'projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'
       ),
     };
 
@@ -3989,8 +3989,8 @@ export class AclConfigServiceClient {
    *
    * @param {string} project
    * @param {string} location
-   * @param {string} sampleQuerySet
-   * @param {string} sampleQuery
+   * @param {string} sample_query_set
+   * @param {string} sample_query
    * @returns {string} Resource name string.
    */
   sampleQueryPath(
@@ -4002,8 +4002,8 @@ export class AclConfigServiceClient {
     return this.pathTemplates.sampleQueryPathTemplate.render({
       project: project,
       location: location,
-      sampleQuerySet: sampleQuerySet,
-      sampleQuery: sampleQuery,
+      sample_query_set: sampleQuerySet,
+      sample_query: sampleQuery,
     });
   }
 
@@ -4032,35 +4032,35 @@ export class AclConfigServiceClient {
   }
 
   /**
-   * Parse the sampleQuerySet from SampleQuery resource.
+   * Parse the sample_query_set from SampleQuery resource.
    *
    * @param {string} sampleQueryName
    *   A fully-qualified path representing SampleQuery resource.
-   * @returns {string} A string representing the sampleQuerySet.
+   * @returns {string} A string representing the sample_query_set.
    */
   matchSampleQuerySetFromSampleQueryName(sampleQueryName: string) {
     return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
-      .sampleQuerySet;
+      .sample_query_set;
   }
 
   /**
-   * Parse the sampleQuery from SampleQuery resource.
+   * Parse the sample_query from SampleQuery resource.
    *
    * @param {string} sampleQueryName
    *   A fully-qualified path representing SampleQuery resource.
-   * @returns {string} A string representing the sampleQuery.
+   * @returns {string} A string representing the sample_query.
    */
   matchSampleQueryFromSampleQueryName(sampleQueryName: string) {
     return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
-      .sampleQuery;
+      .sample_query;
   }
 
   /**
    * Return a fully-qualified sampleQuerySet resource name string.
    *
    * @param {string} project
    * @param {string} location
-   * @param {string} sampleQuerySet
+   * @param {string} sample_query_set
    * @returns {string} Resource name string.
    */
   sampleQuerySetPath(
@@ -4071,7 +4071,7 @@ export class AclConfigServiceClient {
     return this.pathTemplates.sampleQuerySetPathTemplate.render({
       project: project,
       location: location,
-      sampleQuerySet: sampleQuerySet,
+      sample_query_set: sampleQuerySet,
     });
   }
 
@@ -4102,16 +4102,16 @@ export class AclConfigServiceClient {
   }
 
   /**
-   * Parse the sampleQuerySet from SampleQuerySet resource.
+   * Parse the sample_query_set from SampleQuerySet resource.
    *
    * @param {string} sampleQuerySetName
    *   A fully-qualified path representing SampleQuerySet resource.
-   * @returns {string} A string representing the sampleQuerySet.
+   * @returns {string} A string representing the sample_query_set.
    */
   matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string) {
     return this.pathTemplates.sampleQuerySetPathTemplate.match(
       sampleQuerySetName
-    ).sampleQuerySet;
+    ).sample_query_set;
   }
 
   /**

diff --git a/packages/google-cloud-discoveryengine/src/v1alpha/chunk_service_client.ts b/packages/google-cloud-discoveryengine/src/v1alpha/chunk_service_client.ts
@@ -344,10 +344,10 @@ export class ChunkServiceClient {
           'projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'
         ),
       sampleQueryPathTemplate: new this._gaxModule.PathTemplate(
-        'projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}'
+        'projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'
       ),
       sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate(
-        'projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}'
+        'projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'
       ),
     };
 
@@ -4147,8 +4147,8 @@ export class ChunkServiceClient {
    *
    * @param {string} project
    * @param {string} location
-   * @param {string} sampleQuerySet
-   * @param {string} sampleQuery
+   * @param {string} sample_query_set
+   * @param {string} sample_query
    * @returns {string} Resource name string.
    */
   sampleQueryPath(
@@ -4160,8 +4160,8 @@ export class ChunkServiceClient {
     return this.pathTemplates.sampleQueryPathTemplate.render({
       project: project,
       location: location,
-      sampleQuerySet: sampleQuerySet,
-      sampleQuery: sampleQuery,
+      sample_query_set: sampleQuerySet,
+      sample_query: sampleQuery,
     });
   }
 
@@ -4190,35 +4190,35 @@ export class ChunkServiceClient {
   }
 
   /**
-   * Parse the sampleQuerySet from SampleQuery resource.
+   * Parse the sample_query_set from SampleQuery resource.
    *
    * @param {string} sampleQueryName
    *   A fully-qualified path representing SampleQuery resource.
-   * @returns {string} A string representing the sampleQuerySet.
+   * @returns {string} A string representing the sample_query_set.
    */
   matchSampleQuerySetFromSampleQueryName(sampleQueryName: string) {
     return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
-      .sampleQuerySet;
+      .sample_query_set;
   }
 
   /**
-   * Parse the sampleQuery from SampleQuery resource.
+   * Parse the sample_query from SampleQuery resource.
    *
    * @param {string} sampleQueryName
    *   A fully-qualified path representing SampleQuery resource.
-   * @returns {string} A string representing the sampleQuery.
+   * @returns {string} A string representing the sample_query.
    */
   matchSampleQueryFromSampleQueryName(sampleQueryName: string) {
     return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
-      .sampleQuery;
+      .sample_query;
   }
 
   /**
    * Return a fully-qualified sampleQuerySet resource name string.
    *
    * @param {string} project
    * @param {string} location
-   * @param {string} sampleQuerySet
+   * @param {string} sample_query_set
    * @returns {string} Resource name string.
    */
   sampleQuerySetPath(
@@ -4229,7 +4229,7 @@ export class ChunkServiceClient {
     return this.pathTemplates.sampleQuerySetPathTemplate.render({
       project: project,
       location: location,
-      sampleQuerySet: sampleQuerySet,
+      sample_query_set: sampleQuerySet,
     });
   }
 
@@ -4260,16 +4260,16 @@ export class ChunkServiceClient {
   }
 
   /**
-   * Parse the sampleQuerySet from SampleQuerySet resource.
+   * Parse the sample_query_set from SampleQuerySet resource.
    *
    * @param {string} sampleQuerySetName
    *   A fully-qualified path representing SampleQuerySet resource.
-   * @returns {string} A string representing the sampleQuerySet.
+   * @returns {string} A string representing the sample_query_set.
    */
   matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string) {
     return this.pathTemplates.sampleQuerySetPathTemplate.match(
       sampleQuerySetName
-    ).sampleQuerySet;
+    ).sample_query_set;
   }
 
   /**