google-cloud-oracle_database-v1 0.10.0 → 0.11.0

data/proto_docs/google/cloud/oracledatabase/v1/pluggable_database.rb

@@ -0,0 +1,366 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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 OracleDatabase
+      module V1
+        # The PluggableDatabase resource.
+        # https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/PluggableDatabase/
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The name of the PluggableDatabase resource in the following
+        #     format:
+        #     projects/\\{project}/locations/\\{region}/pluggableDatabases/\\{pluggable_database}
+        # @!attribute [rw] properties
+        #   @return [::Google::Cloud::OracleDatabase::V1::PluggableDatabaseProperties]
+        #     Optional. The properties of the PluggableDatabase.
+        # @!attribute [r] oci_url
+        #   @return [::String]
+        #     Output only. HTTPS link to OCI resources exposed to Customer via UI
+        #     Interface.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The date and time that the PluggableDatabase was created.
+        class PluggableDatabase
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The properties of a PluggableDatabase.
+        # @!attribute [rw] compartment_id
+        #   @return [::String]
+        #     Required. The OCID of the compartment.
+        # @!attribute [rw] connection_strings
+        #   @return [::Google::Cloud::OracleDatabase::V1::PluggableDatabaseConnectionStrings]
+        #     Optional. The Connection strings used to connect to the Oracle Database.
+        # @!attribute [rw] container_database_ocid
+        #   @return [::String]
+        #     Required. The OCID of the CDB.
+        # @!attribute [rw] defined_tags
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OracleDatabase::V1::PluggableDatabaseProperties::DefinedTagValue}]
+        #     Optional. Defined tags for this resource. Each key is predefined and scoped
+        #     to a namespace.
+        # @!attribute [rw] freeform_tags
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Free-form tags for this resource. Each tag is a simple key-value
+        #     pair with no predefined name, type, or namespace.
+        # @!attribute [r] ocid
+        #   @return [::String]
+        #     Output only. The OCID of the pluggable database.
+        # @!attribute [rw] is_restricted
+        #   @return [::Boolean]
+        #     Optional. The restricted mode of the pluggable database. If a pluggable
+        #     database is opened in restricted mode, the user needs both create a session
+        #     and have restricted session privileges to connect to it.
+        # @!attribute [r] lifecycle_details
+        #   @return [::String]
+        #     Output only. Additional information about the current lifecycle state.
+        # @!attribute [r] lifecycle_state
+        #   @return [::Google::Cloud::OracleDatabase::V1::PluggableDatabaseProperties::PluggableDatabaseLifecycleState]
+        #     Output only. The current state of the pluggable database.
+        # @!attribute [rw] pdb_name
+        #   @return [::String]
+        #     Required. The database name.
+        # @!attribute [rw] pdb_node_level_details
+        #   @return [::Array<::Google::Cloud::OracleDatabase::V1::PluggableDatabaseNodeLevelDetails>]
+        #     Optional. Pluggable Database Node Level Details
+        # @!attribute [r] database_management_config
+        #   @return [::Google::Cloud::OracleDatabase::V1::DatabaseManagementConfig]
+        #     Output only. The configuration of the Database Management service.
+        # @!attribute [r] operations_insights_state
+        #   @return [::Google::Cloud::OracleDatabase::V1::PluggableDatabaseProperties::OperationsInsightsState]
+        #     Output only. The status of Operations Insights for this Database.
+        class PluggableDatabaseProperties
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Wrapper message for the value of a defined tag.
+          # @!attribute [rw] tags
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     The tags within the namespace.
+          class DefinedTagValue
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class TagsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::OracleDatabase::V1::PluggableDatabaseProperties::DefinedTagValue]
+          class DefinedTagsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class FreeformTagsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The various lifecycle states of the PluggableDatabase.
+          module PluggableDatabaseLifecycleState
+            # The lifecycle state is unspecified.
+            PLUGGABLE_DATABASE_LIFECYCLE_STATE_UNSPECIFIED = 0
+
+            # The pluggable database is provisioning.
+            PROVISIONING = 1
+
+            # The pluggable database is available.
+            AVAILABLE = 2
+
+            # The pluggable database is terminating.
+            TERMINATING = 3
+
+            # The pluggable database is terminated.
+            TERMINATED = 4
+
+            # The pluggable database is updating.
+            UPDATING = 5
+
+            # The pluggable database is in a failed state.
+            FAILED = 6
+
+            # The pluggable database is relocating.
+            RELOCATING = 7
+
+            # The pluggable database is relocated.
+            RELOCATED = 8
+
+            # The pluggable database is refreshing.
+            REFRESHING = 9
+
+            # The pluggable database is restoring.
+            RESTORE_IN_PROGRESS = 10
+
+            # The pluggable database restore failed.
+            RESTORE_FAILED = 11
+
+            # The pluggable database is backing up.
+            BACKUP_IN_PROGRESS = 12
+
+            # The pluggable database is disabled.
+            DISABLED = 13
+          end
+
+          # The status of Operations Insights for this Database.
+          module OperationsInsightsState
+            # The status is not specified.
+            OPERATIONS_INSIGHTS_STATE_UNSPECIFIED = 0
+
+            # Operations Insights is enabling.
+            ENABLING = 1
+
+            # Operations Insights is enabled.
+            ENABLED = 2
+
+            # Operations Insights is disabling.
+            DISABLING = 3
+
+            # Operations Insights is not enabled.
+            NOT_ENABLED = 4
+
+            # Operations Insights failed to enable.
+            FAILED_ENABLING = 5
+
+            # Operations Insights failed to disable.
+            FAILED_DISABLING = 6
+          end
+        end
+
+        # The connection strings used to connect to the Oracle Database.
+        # @!attribute [rw] all_connection_strings
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. All connection strings to use to connect to the pluggable
+        #     database.
+        # @!attribute [rw] pdb_default
+        #   @return [::String]
+        #     Optional. The default connection string to use to connect to the pluggable
+        #     database.
+        # @!attribute [rw] pdb_ip_default
+        #   @return [::String]
+        #     Optional. The default connection string to use to connect to the pluggable
+        #     database using IP.
+        class PluggableDatabaseConnectionStrings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class AllConnectionStringsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The Pluggable Database Node Level Details.
+        # @!attribute [rw] node_name
+        #   @return [::String]
+        #     Required. The Node name of the Database home.
+        # @!attribute [rw] open_mode
+        #   @return [::Google::Cloud::OracleDatabase::V1::PluggableDatabaseNodeLevelDetails::PluggableDatabaseOpenMode]
+        #     Required. The mode that the pluggable database is in to open it.
+        # @!attribute [rw] pluggable_database_id
+        #   @return [::String]
+        #     Required. The OCID of the Pluggable Database.
+        class PluggableDatabaseNodeLevelDetails
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The mode that the pluggable database is in to open it.
+          module PluggableDatabaseOpenMode
+            # The open mode is unspecified.
+            PLUGGABLE_DATABASE_OPEN_MODE_UNSPECIFIED = 0
+
+            # The pluggable database is opened in read-only mode.
+            READ_ONLY = 1
+
+            # The pluggable database is opened in read-write mode.
+            READ_WRITE = 2
+
+            # The pluggable database is mounted.
+            MOUNTED = 3
+
+            # The pluggable database is migrated.
+            MIGRATE = 4
+          end
+        end
+
+        # The configuration of the Database Management service.
+        # @!attribute [r] management_state
+        #   @return [::Google::Cloud::OracleDatabase::V1::DatabaseManagementConfig::ManagementState]
+        #     Output only. The status of the Database Management service.
+        # @!attribute [r] management_type
+        #   @return [::Google::Cloud::OracleDatabase::V1::DatabaseManagementConfig::ManagementType]
+        #     Output only. The Database Management type.
+        class DatabaseManagementConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The status of the Database Management service.
+          module ManagementState
+            # The status is not specified.
+            MANAGEMENT_STATE_UNSPECIFIED = 0
+
+            # The Database Management service is enabling.
+            ENABLING = 1
+
+            # The Database Management service is enabled.
+            ENABLED = 2
+
+            # The Database Management service is disabling.
+            DISABLING = 3
+
+            # The Database Management service is disabled.
+            DISABLED = 4
+
+            # The Database Management service is updating.
+            UPDATING = 5
+
+            # The Database Management service failed to enable.
+            FAILED_ENABLING = 6
+
+            # The Database Management service failed to disable.
+            FAILED_DISABLING = 7
+
+            # The Database Management service failed to update.
+            FAILED_UPDATING = 8
+          end
+
+          # The Database Management type.
+          module ManagementType
+            # The type is not specified.
+            MANAGEMENT_TYPE_UNSPECIFIED = 0
+
+            # Basic Database Management.
+            BASIC = 1
+
+            # Advanced Database Management.
+            ADVANCED = 2
+          end
+        end
+
+        # The request for `PluggableDatabase.Get`.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the PluggableDatabase resource in the following
+        #     format:
+        #     projects/\\{project}/locations/\\{region}/pluggableDatabases/\\{pluggable_database}
+        class GetPluggableDatabaseRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for `PluggableDatabase.List`.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent, which owns this collection of PluggableDatabases.
+        #     Format: projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of PluggableDatabases to return. The service
+        #     may return fewer than this value.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListPluggableDatabases`
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to `ListPluggableDatabases`
+        #     must match the call that provided the page token.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. An expression for filtering the results of the request. List for
+        #     pluggable databases is supported only with a valid container database (full
+        #     resource name) filter in this format:
+        #     `database="projects/{project}/locations/{location}/databases/{database}"`
+        class ListPluggableDatabasesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response for `PluggableDatabase.List`.
+        # @!attribute [rw] pluggable_databases
+        #   @return [::Array<::Google::Cloud::OracleDatabase::V1::PluggableDatabase>]
+        #     The list of PluggableDatabases.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token identifying a page of results the server should return.
+        class ListPluggableDatabasesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/oracledatabase/v1/vm_cluster.rb

@@ -35,10 +35,6 @@ module Google
         # @!attribute [rw] display_name
         #   @return [::String]
         #     Optional. User friendly name for this resource.
-        # @!attribute [r] gcp_oracle_zone
-        #   @return [::String]
-        #     Output only. Google Cloud Platform location where Oracle Exadata is hosted.
-        #     It is same as Google Cloud Platform Oracle zone of Exadata infrastructure.
         # @!attribute [rw] properties
         #   @return [::Google::Cloud::OracleDatabase::V1::CloudVmClusterProperties]
         #     Optional. Various properties of the VM Cluster.
@@ -50,14 +46,40 @@ module Google
         #     Output only. The date and time that the VM cluster was created.
         # @!attribute [rw] cidr
         #   @return [::String]
-        #     Required. Network settings. CIDR to use for cluster IP allocation.
+        #     Optional. Network settings. CIDR to use for cluster IP allocation.
         # @!attribute [rw] backup_subnet_cidr
         #   @return [::String]
-        #     Required. CIDR range of the backup subnet.
+        #     Optional. CIDR range of the backup subnet.
         # @!attribute [rw] network
         #   @return [::String]
-        #     Required. The name of the VPC network.
+        #     Optional. The name of the VPC network.
         #     Format: projects/\\{project}/global/networks/\\{network}
+        # @!attribute [r] gcp_oracle_zone
+        #   @return [::String]
+        #     Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted.
+        #     This will be the same as the gcp_oracle_zone of the
+        #     CloudExadataInfrastructure. Example: us-east4-b-r2.
+        # @!attribute [rw] odb_network
+        #   @return [::String]
+        #     Optional. The name of the OdbNetwork associated with the VM Cluster.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/odbNetworks/\\{odb_network}
+        #     It is optional but if specified, this should match the parent ODBNetwork of
+        #     the odb_subnet and backup_odb_subnet.
+        # @!attribute [rw] odb_subnet
+        #   @return [::String]
+        #     Optional. The name of the OdbSubnet associated with the VM Cluster for
+        #     IP allocation. Format:
+        #     projects/\\{project}/locations/\\{location}/odbNetworks/\\{odb_network}/odbSubnets/\\{odb_subnet}
+        # @!attribute [rw] backup_odb_subnet
+        #   @return [::String]
+        #     Optional. The name of the backup OdbSubnet associated with the VM Cluster.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/odbNetworks/\\{odb_network}/odbSubnets/\\{odb_subnet}
+        # @!attribute [r] identity_connector
+        #   @return [::Google::Cloud::OracleDatabase::V1::IdentityConnector]
+        #     Output only. The identity connector details which will allow OCI to
+        #     securely access the resources in the customer project.
         class CloudVmCluster
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -173,6 +195,9 @@ module Google
         # @!attribute [rw] cluster_name
         #   @return [::String]
         #     Optional. OCI Cluster name.
+        # @!attribute [r] compute_model
+        #   @return [::Google::Cloud::OracleDatabase::V1::ComputeModel]
+        #     Output only. The compute model of the VM Cluster.
         class CloudVmClusterProperties
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/field_mask.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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 Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # # Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # # Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # ## Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # # JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # # Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # ## Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is unmappable.
+    # @!attribute [rw] paths
+    #   @return [::Array<::String>]
+    #     The set of field mask paths.
+    class FieldMask
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end