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

data/proto_docs/google/api/launch_stage.rb

@@ -0,0 +1,71 @@
+# 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 Api
+    # The launch stage as defined by [Google Cloud Platform
+    # Launch Stages](https://cloud.google.com/terms/launch-stages).
+    module LaunchStage
+      # Do not use this default value.
+      LAUNCH_STAGE_UNSPECIFIED = 0
+
+      # The feature is not yet implemented. Users can not use it.
+      UNIMPLEMENTED = 6
+
+      # Prelaunch features are hidden from users and are only visible internally.
+      PRELAUNCH = 7
+
+      # Early Access features are limited to a closed group of testers. To use
+      # these features, you must sign up in advance and sign a Trusted Tester
+      # agreement (which includes confidentiality provisions). These features may
+      # be unstable, changed in backward-incompatible ways, and are not
+      # guaranteed to be released.
+      EARLY_ACCESS = 1
+
+      # Alpha is a limited availability test for releases before they are cleared
+      # for widespread use. By Alpha, all significant design issues are resolved
+      # and we are in the process of verifying functionality. Alpha customers
+      # need to apply for access, agree to applicable terms, and have their
+      # projects allowlisted. Alpha releases don't have to be feature complete,
+      # no SLAs are provided, and there are no technical support obligations, but
+      # they will be far enough along that customers can actually use them in
+      # test environments or for limited-use tests -- just like they would in
+      # normal production cases.
+      ALPHA = 2
+
+      # Beta is the point at which we are ready to open a release for any
+      # customer to use. There are no SLA or technical support obligations in a
+      # Beta release. Products will be complete from a feature perspective, but
+      # may have some open outstanding issues. Beta releases are suitable for
+      # limited production use cases.
+      BETA = 3
+
+      # GA features are open to all developers and are considered stable and
+      # fully qualified for production use.
+      GA = 4
+
+      # Deprecated features are scheduled to be shut down and removed. For more
+      # information, see the "Deprecation Policy" section of our [Terms of
+      # Service](https://cloud.google.com/terms/)
+      # and the [Google Cloud Platform Subject to the Deprecation
+      # Policy](https://cloud.google.com/terms/deprecation) documentation.
+      DEPRECATED = 5
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,227 @@
+# 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 Api
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         pattern: "projects/{project}/topics/{topic}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       pattern: "projects/{project}/topics/{topic}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [::Array<::String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [::String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [::Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [::String]
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
+    #     to this is for Nested Collections that have stuttering names, as defined
+    #     in [AIP-122](https://google.aip.dev/122#nested-collections), where the
+    #     collection ID in the resource name pattern does not necessarily directly
+    #     match the `plural` value.
+    #
+    #     It is the same concept of the `plural` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
+    # @!attribute [rw] singular
+    #   @return [::String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
+    class ResourceDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [::String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
+    class ResourceReference
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/cloud/licensemanager/v1/api_entities.rb

@@ -0,0 +1,297 @@
+# 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 LicenseManager
+      module V1
+        # Configuration for a Google SPLA product
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. name of resource
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. User given name.
+        # @!attribute [rw] product
+        #   @return [::String]
+        #     Required. Name field (with URL) of the Product offered for SPLA.
+        # @!attribute [rw] license_type
+        #   @return [::Google::Cloud::LicenseManager::V1::LicenseType]
+        #     Required. LicenseType to be applied for billing
+        # @!attribute [rw] current_billing_info
+        #   @return [::Google::Cloud::LicenseManager::V1::BillingInfo]
+        #     Required. Billing information applicable till end of the current month.
+        # @!attribute [rw] next_billing_info
+        #   @return [::Google::Cloud::LicenseManager::V1::BillingInfo]
+        #     Required. Billing information applicable for next month.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. [Output only] Create time stamp
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. [Output only] Update time stamp
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Labels as key value pairs
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::LicenseManager::V1::Configuration::State]
+        #     Output only. State of the configuration.
+        class Configuration
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # State of the configuration.
+          module State
+            # The Status of the configuration is unspecified
+            STATE_UNSPECIFIED = 0
+
+            # Configuration is in active state.
+            STATE_ACTIVE = 1
+
+            # Configuration is in deactivated state.
+            STATE_SUSPENDED = 2
+
+            # Configuration is in deleted state.
+            STATE_DELETED = 3
+          end
+        end
+
+        # Billing Information.
+        # @!attribute [rw] user_count_billing
+        #   @return [::Google::Cloud::LicenseManager::V1::UserCountBillingInfo]
+        #     Required. This type of billing uses user count for computing total
+        #     charge.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. When the billing starts.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. When the billing ends.
+        class BillingInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # This approach uses total unique user count for billing.
+        # @!attribute [rw] user_count
+        #   @return [::Integer]
+        #     Required. Number of users to bill for.
+        class UserCountBillingInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message representing usage for license configurations which use user-count
+        # billing.
+        # @!attribute [rw] unique_user_count
+        #   @return [::Integer]
+        #     Required. Unique number of licensed users.
+        class UserCountUsage
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Products for Google SPLA.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. Full name of the product resource.
+        #     ex "projects/1/locations/us-central1/products/office-2021"
+        # @!attribute [rw] version
+        #   @return [::String]
+        #     Required. Version of the product.
+        # @!attribute [rw] product_company
+        #   @return [::String]
+        #     Required. Company that released the product.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::LicenseManager::V1::Product::State]
+        #     Output only. State of the product.
+        # @!attribute [rw] sku
+        #   @return [::String]
+        #     Required. SKU for mapping to the Billing/Subscription resource.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Required. Human-readable, detailed description of the Product
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. Human-readable name of the Product
+        class Product
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # State of the product.
+          module State
+            # The Status of the product is unknown.
+            STATE_UNSPECIFIED = 0
+
+            # Product is under provisioning stage.
+            STATE_PROVISIONING = 1
+
+            # Product is ok to run on instances.
+            STATE_RUNNING = 2
+
+            # The product is about to terminate or has been announced for termination.
+            STATE_TERMINATING = 3
+
+            # The product has been terminated.
+            STATE_TERMINATED = 4
+          end
+        end
+
+        # Message describing Instance object
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. name of resource
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. [Output only] Create time stamp
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. [Output only] Update time stamp
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Labels as key value pairs
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::LicenseManager::V1::Instance::State]
+        #     Output only. The state of the VM.
+        # @!attribute [r] region
+        #   @return [::String]
+        #     Output only. The location of the VM.
+        # @!attribute [r] product_activation
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::LicenseManager::V1::ActivationState}]
+        #     Output only. Map with Product_Name and Activation State of the VM.
+        # @!attribute [r] license_version_id
+        #   @return [::String]
+        #     Output only. license version id.
+        # @!attribute [rw] compute_instance
+        #   @return [::String]
+        #     Required. Compute Instance resource name, i.e.
+        #     projects/\\{project}/zones/\\{zone}/instances/\\{instance}
+        class Instance
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::LicenseManager::V1::ActivationState]
+          class ProductActivationEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # VM status enum.
+          module State
+            # The Status of the VM is unspecified.
+            STATE_UNSPECIFIED = 0
+
+            # Resources are being allocated for the instance.
+            PROVISIONING = 1
+
+            # All required resources have been allocated and
+            # the instance is being started.
+            STAGING = 2
+
+            # The instance is running.
+            RUNNING = 3
+
+            # The instance is currently stopping (either being deleted or terminated).
+            STOPPING = 4
+
+            # The instance has stopped due to various reasons (user request, VM
+            # preemption, project freezing, etc.).
+            STOPPED = 5
+
+            # The instance has failed in some way.
+            TERMINATED = 6
+
+            # The instance is in repair.
+            REPAIRING = 7
+          end
+        end
+
+        # Message describing total counts of users who accessed a VM.
+        # @!attribute [rw] lima_instance
+        #   @return [::String]
+        #     LiMa Instance resource name, i.e.
+        #     projects/\\{project}/locations/\\{location}/instances/\\{instance}
+        # @!attribute [rw] users
+        #   @return [::Integer]
+        #     Number of unique users accessing the VM.
+        class Usage
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Different types of licenses that are supported.
+        module LicenseType
+          # unspecified.
+          LICENSE_TYPE_UNSPECIFIED = 0
+
+          # Billing will be based on number of users listed per month.
+          LICENSE_TYPE_PER_MONTH_PER_USER = 1
+
+          # Bring your own license.
+          LICENSE_TYPE_BRING_YOUR_OWN_LICENSE = 2
+        end
+
+        # State of the License Key activation on the instance.
+        module ActivationState
+          # The Status of the activation is unspecified
+          ACTIVATION_STATE_UNSPECIFIED = 0
+
+          # Activation key (MAK) requested for the instance.
+          ACTIVATION_STATE_KEY_REQUESTED = 1
+
+          # License activation process is running on the instance.
+          ACTIVATION_STATE_ACTIVATING = 2
+
+          # License activation is complete on the instance.
+          ACTIVATION_STATE_ACTIVATED = 3
+
+          # License Key is deactivating on the instance.
+          ACTIVATION_STATE_DEACTIVATING = 4
+
+          # License Key is deactivated on the instance.
+          ACTIVATION_STATE_DEACTIVATED = 5
+
+          # License Key activation failed on the instance.
+          ACTIVATION_STATE_TERMINATED = 6
+        end
+      end
+    end
+  end
+end