google-cloud-ces-v1 0.a → 0.1.0

data/proto_docs/google/cloud/ces/v1/app_version.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Ces
+      module V1
+        # A snapshot of the app.
+        # @!attribute [rw] app
+        #   @return [::Google::Cloud::Ces::V1::App]
+        #     Optional. The basic settings for the app.
+        # @!attribute [rw] agents
+        #   @return [::Array<::Google::Cloud::Ces::V1::Agent>]
+        #     Optional. List of agents in the app.
+        # @!attribute [rw] tools
+        #   @return [::Array<::Google::Cloud::Ces::V1::Tool>]
+        #     Optional. List of tools in the app.
+        # @!attribute [rw] examples
+        #   @return [::Array<::Google::Cloud::Ces::V1::Example>]
+        #     Optional. List of examples in the app.
+        # @!attribute [rw] guardrails
+        #   @return [::Array<::Google::Cloud::Ces::V1::Guardrail>]
+        #     Optional. List of guardrails in the app.
+        # @!attribute [rw] toolsets
+        #   @return [::Array<::Google::Cloud::Ces::V1::Toolset>]
+        #     Optional. List of toolsets in the app.
+        class AppSnapshot
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # In Customer Engagement Suite (CES), an app version is a snapshot of the app
+        # at a specific point in time. It is immutable and cannot be modified once
+        # created.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The unique identifier of the app version.
+        #     Format:
+        #     `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. The display name of the app version.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. The description of the app version.
+        # @!attribute [r] creator
+        #   @return [::String]
+        #     Output only. Email of the user who created the app version.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the app version was created.
+        # @!attribute [r] snapshot
+        #   @return [::Google::Cloud::Ces::V1::AppSnapshot]
+        #     Output only. The snapshot of the app when the version is created.
+        # @!attribute [r] etag
+        #   @return [::String]
+        #     Output only. Etag used to ensure the object hasn't changed during a
+        #     read-modify-write operation. If the etag is empty, the update will
+        #     overwrite any concurrent changes.
+        class AppVersion
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/ces/v1/auth.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Ces
+      module V1
+        # Configurations for authentication with API key.
+        # @!attribute [rw] key_name
+        #   @return [::String]
+        #     Required. The parameter name or the header name of the API key.
+        #     E.g., If the API request is "https://example.com/act?X-Api-Key=<API
+        #     KEY>", "X-Api-Key" would be the parameter name.
+        # @!attribute [rw] api_key_secret_version
+        #   @return [::String]
+        #     Required. The name of the SecretManager secret version resource storing the
+        #     API key. Format: `projects/{project}/secrets/{secret}/versions/{version}`
+        #
+        #     Note: You should grant `roles/secretmanager.secretAccessor` role to the CES
+        #     service agent
+        #     `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`.
+        # @!attribute [rw] request_location
+        #   @return [::Google::Cloud::Ces::V1::ApiKeyConfig::RequestLocation]
+        #     Required. Key location in the request.
+        class ApiKeyConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The location of the API key in the request.
+          module RequestLocation
+            # Unspecified. This value should not be used.
+            REQUEST_LOCATION_UNSPECIFIED = 0
+
+            # Represents the key in http header.
+            HEADER = 1
+
+            # Represents the key in query string.
+            QUERY_STRING = 2
+          end
+        end
+
+        # Configurations for authentication with OAuth.
+        # @!attribute [rw] oauth_grant_type
+        #   @return [::Google::Cloud::Ces::V1::OAuthConfig::OauthGrantType]
+        #     Required. OAuth grant types.
+        # @!attribute [rw] client_id
+        #   @return [::String]
+        #     Required. The client ID from the OAuth provider.
+        # @!attribute [rw] client_secret_version
+        #   @return [::String]
+        #     Required. The name of the SecretManager secret version resource storing the
+        #     client secret.
+        #     Format: `projects/{project}/secrets/{secret}/versions/{version}`
+        #
+        #     Note: You should grant `roles/secretmanager.secretAccessor` role to the CES
+        #     service agent
+        #     `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`.
+        # @!attribute [rw] token_endpoint
+        #   @return [::String]
+        #     Required. The token endpoint in the OAuth provider to exchange for an
+        #     access token.
+        # @!attribute [rw] scopes
+        #   @return [::Array<::String>]
+        #     Optional. The OAuth scopes to grant.
+        class OAuthConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # OAuth grant types. Only [client credential
+          # grant](https://oauth.net/2/grant-types/client-credentials) is supported.
+          module OauthGrantType
+            # Unspecified. Defaults to CLIENT_CREDENTIAL.
+            OAUTH_GRANT_TYPE_UNSPECIFIED = 0
+
+            # Represents the [client credential
+            # flow](https://oauth.net/2/grant-types/client-credentials).
+            CLIENT_CREDENTIAL = 1
+          end
+        end
+
+        # Configurations for authentication with [ID
+        # token](https://cloud.google.com/docs/authentication/token-types#id) generated
+        # from service agent.
+        class ServiceAgentIdTokenAuthConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configurations for authentication using a custom service account.
+        # @!attribute [rw] service_account
+        #   @return [::String]
+        #     Required. The email address of the service account used for authentication.
+        #     CES uses this service account to exchange an access token and the access
+        #     token is then sent in the `Authorization` header of the request.
+        #
+        #     The service account must have the
+        #     `roles/iam.serviceAccountTokenCreator` role granted to the
+        #     CES service agent
+        #     `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`.
+        # @!attribute [rw] scopes
+        #   @return [::Array<::String>]
+        #     Optional. The OAuth scopes to grant. If not specified, the default scope
+        #     `https://www.googleapis.com/auth/cloud-platform` is used.
+        class ServiceAccountAuthConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configurations for authentication with a bearer token.
+        # @!attribute [rw] token
+        #   @return [::String]
+        #     Required. The bearer token.
+        #     Must be in the format `$context.variables.<name_of_variable>`.
+        class BearerTokenConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # End-user authentication configuration used for Connection calls.
+        # The field values must be the names of context variables in the format
+        # `$context.variables.<name_of_variable>`.
+        # @!attribute [rw] oauth2_auth_code_config
+        #   @return [::Google::Cloud::Ces::V1::EndUserAuthConfig::Oauth2AuthCodeConfig]
+        #     Oauth 2.0 Authorization Code authentication.
+        #
+        #     Note: The following fields are mutually exclusive: `oauth2_auth_code_config`, `oauth2_jwt_bearer_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] oauth2_jwt_bearer_config
+        #   @return [::Google::Cloud::Ces::V1::EndUserAuthConfig::Oauth2JwtBearerConfig]
+        #     JWT Profile Oauth 2.0 Authorization Grant authentication.
+        #
+        #     Note: The following fields are mutually exclusive: `oauth2_jwt_bearer_config`, `oauth2_auth_code_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class EndUserAuthConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Oauth 2.0 Authorization Code authentication configuration.
+          # @!attribute [rw] oauth_token
+          #   @return [::String]
+          #     Required. Oauth token parameter name to pass through.
+          #     Must be in the format `$context.variables.<name_of_variable>`.
+          class Oauth2AuthCodeConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # JWT Profile Oauth 2.0 Authorization Grant authentication configuration.
+          # @!attribute [rw] issuer
+          #   @return [::String]
+          #     Required. Issuer parameter name to pass through.
+          #     Must be in the format `$context.variables.<name_of_variable>`.
+          # @!attribute [rw] subject
+          #   @return [::String]
+          #     Required. Subject parameter name to pass through.
+          #     Must be in the format `$context.variables.<name_of_variable>`.
+          # @!attribute [rw] client_key
+          #   @return [::String]
+          #     Required. Client parameter name to pass through.
+          #     Must be in the format `$context.variables.<name_of_variable>`.
+          class Oauth2JwtBearerConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Authentication information required for API calls.
+        # @!attribute [rw] api_key_config
+        #   @return [::Google::Cloud::Ces::V1::ApiKeyConfig]
+        #     Optional. Config for API key auth.
+        #
+        #     Note: The following fields are mutually exclusive: `api_key_config`, `oauth_config`, `service_agent_id_token_auth_config`, `service_account_auth_config`, `bearer_token_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] oauth_config
+        #   @return [::Google::Cloud::Ces::V1::OAuthConfig]
+        #     Optional. Config for OAuth.
+        #
+        #     Note: The following fields are mutually exclusive: `oauth_config`, `api_key_config`, `service_agent_id_token_auth_config`, `service_account_auth_config`, `bearer_token_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] service_agent_id_token_auth_config
+        #   @return [::Google::Cloud::Ces::V1::ServiceAgentIdTokenAuthConfig]
+        #     Optional. Config for ID token auth generated from CES service agent.
+        #
+        #     Note: The following fields are mutually exclusive: `service_agent_id_token_auth_config`, `api_key_config`, `oauth_config`, `service_account_auth_config`, `bearer_token_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] service_account_auth_config
+        #   @return [::Google::Cloud::Ces::V1::ServiceAccountAuthConfig]
+        #     Optional. Config for service account authentication.
+        #
+        #     Note: The following fields are mutually exclusive: `service_account_auth_config`, `api_key_config`, `oauth_config`, `service_agent_id_token_auth_config`, `bearer_token_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] bearer_token_config
+        #   @return [::Google::Cloud::Ces::V1::BearerTokenConfig]
+        #     Optional. Config for bearer token auth.
+        #
+        #     Note: The following fields are mutually exclusive: `bearer_token_config`, `api_key_config`, `oauth_config`, `service_agent_id_token_auth_config`, `service_account_auth_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        class ApiAuthentication
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/ces/v1/bigquery_export.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Ces
+      module V1
+        # Settings to describe the BigQuery export behaviors for the app.
+        # @!attribute [rw] enabled
+        #   @return [::Boolean]
+        #     Optional. Indicates whether the BigQuery export is enabled.
+        # @!attribute [rw] project
+        #   @return [::String]
+        #     Optional. The **project ID** of the BigQuery dataset to export the data to.
+        #
+        #     Note: If the BigQuery dataset is in a different project from the app,
+        #     you should grant `roles/bigquery.admin` role to the CES service agent
+        #     `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`.
+        # @!attribute [rw] dataset
+        #   @return [::String]
+        #     Optional. The BigQuery **dataset ID** to export the data to.
+        class BigQueryExportSettings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/ces/v1/changelog.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Ces
+      module V1
+        # Changelogs represent a change made to the app or to an resource within the
+        # app.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The unique identifier of the changelog.
+        #     Format:
+        #     `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}`
+        # @!attribute [r] author
+        #   @return [::String]
+        #     Output only. Email address of the change author.
+        # @!attribute [r] display_name
+        #   @return [::String]
+        #     Output only. Display name of the change. It typically should be the display
+        #     name of the resource that was changed.
+        # @!attribute [r] description
+        #   @return [::String]
+        #     Output only. Description of the change. which typically captures the
+        #     changed fields in the resource.
+        # @!attribute [r] resource
+        #   @return [::String]
+        #     Output only. The resource that was changed.
+        # @!attribute [r] resource_type
+        #   @return [::String]
+        #     Output only. The type of the resource that was changed.
+        # @!attribute [r] action
+        #   @return [::String]
+        #     Output only. The action that was performed on the resource.
+        # @!attribute [r] original_resource
+        #   @return [::Google::Protobuf::Struct]
+        #     Output only. The original resource before the change.
+        # @!attribute [r] new_resource
+        #   @return [::Google::Protobuf::Struct]
+        #     Output only. The new resource after the change.
+        # @!attribute [r] dependent_resources
+        #   @return [::Array<::Google::Protobuf::Struct>]
+        #     Output only. The dependent resources that were changed.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the change was made.
+        # @!attribute [r] sequence_number
+        #   @return [::Integer]
+        #     Output only. The monotonically increasing sequence number of the changelog.
+        class Changelog
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/ces/v1/client_function.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Ces
+      module V1
+        # Represents a client-side function that the agent can invoke. When the
+        # tool is chosen by the agent, control is handed off to the client.
+        # The client is responsible for executing the function and returning the result
+        # as a {::Google::Cloud::Ces::V1::ToolResponse ToolResponse} to continue the
+        # interaction with the agent.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The function name.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. The function description.
+        # @!attribute [rw] parameters
+        #   @return [::Google::Cloud::Ces::V1::Schema]
+        #     Optional. The schema of the function parameters.
+        # @!attribute [rw] response
+        #   @return [::Google::Cloud::Ces::V1::Schema]
+        #     Optional. The schema of the function response.
+        class ClientFunction
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end