feat: Automated regeneration of DiscoveryEngine client (googleapis#12328)

Auto-created at 2024-10-15 13:16:04 +0000 using the toys pull request generator.

Author: yoshi-code-bot

clients/discovery_engine/README.md

@@ -11,7 +11,7 @@ Install this package from [Hex](https://hex.pm) by adding
 
 ```elixir
 def deps do
-  [{:google_api_discovery_engine, "~> 0.18"}]
+  [{:google_api_discovery_engine, "~> 0.19"}]
 end
 ```
 

clients/discovery_engine/lib/google_api/discovery_engine/v1/api/projects.ex

@@ -344,8 +344,10 @@ defmodule GoogleApi.DiscoveryEngine.V1.Api.Projects do
       *   `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
       *   `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
       *   `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
+      *   `:cmekConfigName` (*type:* `String.t`) - Resource name of the CmekConfig to use for protecting this DataStore.
       *   `:createAdvancedSiteSearch` (*type:* `boolean()`) - A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
       *   `:dataStoreId` (*type:* `String.t`) - Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+      *   `:disableCmek` (*type:* `boolean()`) - DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.
       *   `:skipDefaultSchemaCreation` (*type:* `boolean()`) - A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.
       *   `:body` (*type:* `GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DataStore.t`) - 
   *   `opts` (*type:* `keyword()`) - Call options
@@ -383,8 +385,10 @@ defmodule GoogleApi.DiscoveryEngine.V1.Api.Projects do
       :quotaUser => :query,
       :uploadType => :query,
       :upload_protocol => :query,
+      :cmekConfigName => :query,
       :createAdvancedSiteSearch => :query,
       :dataStoreId => :query,
+      :disableCmek => :query,
       :skipDefaultSchemaCreation => :query,
       :body => :body
     }
@@ -8158,8 +8162,10 @@ defmodule GoogleApi.DiscoveryEngine.V1.Api.Projects do
       *   `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
       *   `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
       *   `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
+      *   `:cmekConfigName` (*type:* `String.t`) - Resource name of the CmekConfig to use for protecting this DataStore.
       *   `:createAdvancedSiteSearch` (*type:* `boolean()`) - A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
       *   `:dataStoreId` (*type:* `String.t`) - Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+      *   `:disableCmek` (*type:* `boolean()`) - DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.
       *   `:skipDefaultSchemaCreation` (*type:* `boolean()`) - A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.
       *   `:body` (*type:* `GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DataStore.t`) - 
   *   `opts` (*type:* `keyword()`) - Call options
@@ -8197,8 +8203,10 @@ defmodule GoogleApi.DiscoveryEngine.V1.Api.Projects do
       :quotaUser => :query,
       :uploadType => :query,
       :upload_protocol => :query,
+      :cmekConfigName => :query,
       :createAdvancedSiteSearch => :query,
       :dataStoreId => :query,
+      :disableCmek => :query,
       :skipDefaultSchemaCreation => :query,
       :body => :body
     }

clients/discovery_engine/lib/google_api/discovery_engine/v1/metadata.ex

@@ -20,7 +20,7 @@ defmodule GoogleApi.DiscoveryEngine.V1 do
   API client metadata for GoogleApi.DiscoveryEngine.V1.
   """
 
-  @discovery_revision "20241004"
+  @discovery_revision "20241010"
 
   def discovery_revision(), do: @discovery_revision
 end

clients/discovery_engine/lib/google_api/discovery_engine/v1/model/google_cloud_discoveryengine_v1_cmek_config.ex

@@ -0,0 +1,66 @@
+# Copyright 2019 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.
+
+# NOTE: This file is auto generated by the elixir code generator program.
+# Do not edit this file manually.
+
+defmodule GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1CmekConfig do
+  @moduledoc """
+  Configurations used to enable CMEK data encryption with Cloud KMS keys.
+
+  ## Attributes
+
+  *   `isDefault` (*type:* `boolean()`, *default:* `nil`) - Output only. The default CmekConfig for the Customer.
+  *   `kmsKey` (*type:* `String.t`, *default:* `nil`) - Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+  *   `kmsKeyVersion` (*type:* `String.t`, *default:* `nil`) - Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+  *   `lastRotationTimestampMicros` (*type:* `String.t`, *default:* `nil`) - Output only. The timestamp of the last key rotation.
+  *   `name` (*type:* `String.t`, *default:* `nil`) - Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
+  *   `state` (*type:* `String.t`, *default:* `nil`) - Output only. State of the CmekConfig.
+  """
+
+  use GoogleApi.Gax.ModelBase
+
+  @type t :: %__MODULE__{
+          :isDefault => boolean() | nil,
+          :kmsKey => String.t() | nil,
+          :kmsKeyVersion => String.t() | nil,
+          :lastRotationTimestampMicros => String.t() | nil,
+          :name => String.t() | nil,
+          :state => String.t() | nil
+        }
+
+  field(:isDefault)
+  field(:kmsKey)
+  field(:kmsKeyVersion)
+  field(:lastRotationTimestampMicros)
+  field(:name)
+  field(:state)
+end
+
+defimpl Poison.Decoder,
+  for: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1CmekConfig do
+  def decode(value, options) do
+    GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1CmekConfig.decode(
+      value,
+      options
+    )
+  end
+end
+
+defimpl Poison.Encoder,
+  for: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1CmekConfig do
+  def encode(value, options) do
+    GoogleApi.Gax.ModelBase.encode(value, options)
+  end
+end

clients/discovery_engine/lib/google_api/discovery_engine/v1/model/google_cloud_discoveryengine_v1_data_store.ex

@@ -22,12 +22,14 @@ defmodule GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DataSto
   ## Attributes
 
   *   `billingEstimation` (*type:* `GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DataStoreBillingEstimation.t`, *default:* `nil`) - Output only. Data size estimation for billing.
+  *   `cmekConfig` (*type:* `GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1CmekConfig.t`, *default:* `nil`) - Output only. CMEK-related information for the DataStore.
   *   `contentConfig` (*type:* `String.t`, *default:* `nil`) - Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   *   `createTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. Timestamp the DataStore was created at.
   *   `defaultSchemaId` (*type:* `String.t`, *default:* `nil`) - Output only. The id of the default Schema asscociated to this data store.
   *   `displayName` (*type:* `String.t`, *default:* `nil`) - Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
   *   `documentProcessingConfig` (*type:* `GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DocumentProcessingConfig.t`, *default:* `nil`) - Configuration for Document understanding and enrichment.
   *   `industryVertical` (*type:* `String.t`, *default:* `nil`) - Immutable. The industry vertical that the data store registers.
+  *   `kmsKeyName` (*type:* `String.t`, *default:* `nil`) - Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
   *   `name` (*type:* `String.t`, *default:* `nil`) - Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
   *   `servingConfigDataStore` (*type:* `GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1ServingConfigDataStore.t`, *default:* `nil`) - Optional. Stores serving config at DataStore level.
   *   `solutionTypes` (*type:* `list(String.t)`, *default:* `nil`) - The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
@@ -41,6 +43,8 @@ defmodule GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DataSto
           :billingEstimation =>
             GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DataStoreBillingEstimation.t()
             | nil,
+          :cmekConfig =>
+            GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1CmekConfig.t() | nil,
           :contentConfig => String.t() | nil,
           :createTime => DateTime.t() | nil,
           :defaultSchemaId => String.t() | nil,
@@ -49,6 +53,7 @@ defmodule GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DataSto
             GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DocumentProcessingConfig.t()
             | nil,
           :industryVertical => String.t() | nil,
+          :kmsKeyName => String.t() | nil,
           :name => String.t() | nil,
           :servingConfigDataStore =>
             GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1ServingConfigDataStore.t()
@@ -65,6 +70,8 @@ defmodule GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DataSto
     as: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DataStoreBillingEstimation
   )
 
+  field(:cmekConfig, as: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1CmekConfig)
+
   field(:contentConfig)
   field(:createTime, as: DateTime)
   field(:defaultSchemaId)
@@ -75,6 +82,7 @@ defmodule GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DataSto
   )
 
   field(:industryVertical)
+  field(:kmsKeyName)
   field(:name)
 
   field(:servingConfigDataStore,

clients/discovery_engine/lib/google_api/discovery_engine/v1/model/google_cloud_discoveryengine_v1_search_request.ex

@@ -31,6 +31,7 @@ defmodule GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchR
   *   `imageQuery` (*type:* `GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchRequestImageQuery.t`, *default:* `nil`) - Raw image query.
   *   `languageCode` (*type:* `String.t`, *default:* `nil`) - The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   *   `offset` (*type:* `integer()`, *default:* `nil`) - A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  *   `oneBoxPageSize` (*type:* `integer()`, *default:* `nil`) - The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   *   `orderBy` (*type:* `String.t`, *default:* `nil`) - The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   *   `pageSize` (*type:* `integer()`, *default:* `nil`) - Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
   *   `pageToken` (*type:* `String.t`, *default:* `nil`) - A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -74,6 +75,7 @@ defmodule GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchR
             | nil,
           :languageCode => String.t() | nil,
           :offset => integer() | nil,
+          :oneBoxPageSize => integer() | nil,
           :orderBy => String.t() | nil,
           :pageSize => integer() | nil,
           :pageToken => String.t() | nil,
@@ -129,6 +131,7 @@ defmodule GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchR
 
   field(:languageCode)
   field(:offset)
+  field(:oneBoxPageSize)
   field(:orderBy)
   field(:pageSize)
   field(:pageToken)

clients/discovery_engine/lib/google_api/discovery_engine/v1/model/google_cloud_discoveryengine_v1_update_cmek_config_metadata.ex

@@ -0,0 +1,54 @@
+# Copyright 2019 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.
+
+# NOTE: This file is auto generated by the elixir code generator program.
+# Do not edit this file manually.
+
+defmodule GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata do
+  @moduledoc """
+  Metadata related to the progress of the CmekConfigService.UpdateCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.
+
+  ## Attributes
+
+  *   `createTime` (*type:* `DateTime.t`, *default:* `nil`) - Operation create time.
+  *   `updateTime` (*type:* `DateTime.t`, *default:* `nil`) - Operation last update time. If the operation is done, this is also the finish time.
+  """
+
+  use GoogleApi.Gax.ModelBase
+
+  @type t :: %__MODULE__{
+          :createTime => DateTime.t() | nil,
+          :updateTime => DateTime.t() | nil
+        }
+
+  field(:createTime, as: DateTime)
+  field(:updateTime, as: DateTime)
+end
+
+defimpl Poison.Decoder,
+  for: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata do
+  def decode(value, options) do
+    GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata.decode(
+      value,
+      options
+    )
+  end
+end
+
+defimpl Poison.Encoder,
+  for: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1UpdateCmekConfigMetadata do
+  def encode(value, options) do
+    GoogleApi.Gax.ModelBase.encode(value, options)
+  end
+end