google-cloud-capacity_planner-v1beta 0.2.0 → 0.3.0

data/proto_docs/google/cloud/capacityplanner/v1beta/capacity_planning_service.rb

@@ -1,374 +0,0 @@
-# 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 CapacityPlanner
-      module V1beta
-        # Request for getting a capacity plan.
-        # @!attribute [rw] name
-        #   @return [::String]
-        #     Required. The name of the capacity plan to retrieve.
-        #     Format: projects/\\{project}/capacityPlans/\\{capacity_plan}
-        class GetCapacityPlanRequest
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Request for querying capacity plans.
-        # @!attribute [rw] parent
-        #   @return [::String]
-        #     Required. The parent resource container.
-        #     Format:
-        #             projects/\\{project} or
-        #             folders/\\{folder} or
-        #             organizations/\\{organization}
-        # @!attribute [rw] page_size
-        #   @return [::Integer]
-        #     Optional. The maximum number of plans to return per page. The service may
-        #     return fewer than this value. If unspecified, the server will use a
-        #     sensible default. The maximum value is 1000; values above 1000 will be
-        #     coerced to 1000.
-        # @!attribute [rw] page_token
-        #   @return [::String]
-        #     Optional. A page token, received from a previous `QueryCapacityPlans` call.
-        #     Provide this to retrieve the subsequent page.
-        # @!attribute [rw] location
-        #   @return [::String]
-        #     Optional. The Google Cloud Platform location of capacity plans. If
-        #     unspecified, all locations will be included.
-        class QueryCapacityPlansRequest
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Response of querying capacity plans.
-        # @!attribute [rw] capacity_plans
-        #   @return [::Array<::Google::Cloud::CapacityPlanner::V1beta::CapacityPlan>]
-        #     List of capacity plans.
-        # @!attribute [rw] next_page_token
-        #   @return [::String]
-        #     Token to retrieve the next page of results. This will be empty if there are
-        #     no more pages.
-        class QueryCapacityPlansResponse
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Request for capacity plan insights.
-        # @!attribute [rw] parent
-        #   @return [::String]
-        #     Required. The parent resource container.
-        #     Format: projects/\\{project}
-        # @!attribute [rw] capacity_plan_filters
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::CapacityPlanFilters]
-        #     Required. The filters to apply to the capacity plan.
-        class QueryCapacityPlanInsightsRequest
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Response for capacity plan insights.
-        # @!attribute [rw] aggregated_capacity_plan_view
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::CapacityPlanView]
-        #     Optional. The aggregated capacity plan view. This is the aggregated view of
-        #     all the capacity plans that match the filters.
-        class QueryCapacityPlanInsightsResponse
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # CapacityPlanFilters is a set of filters to apply to the capacity plan.
-        # @!attribute [rw] keys
-        #   @return [::Array<::Google::Cloud::CapacityPlanner::V1beta::CapacityPlanKey>]
-        #     Required. The capacity plan keys to include in the response.
-        # @!attribute [rw] capacity_types
-        #   @return [::Array<::Google::Cloud::CapacityPlanner::V1beta::CapacityType>]
-        #     Required. The capacity types to include in the response.
-        # @!attribute [rw] capacity_plan_id
-        #   @return [::String]
-        #     Optional. Optional capacity plan id. Should be populated for request page
-        #     to lock based on the same capacity plan.
-        class CapacityPlanFilters
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # CapacityPlanKey is a the unique identifier for each Capacity Plan.
-        # @!attribute [rw] resource_container
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::ResourceContainer]
-        #     Required. The resource container associated with the capacity plan.
-        # @!attribute [rw] resource_id_key
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::ResourceIdKey]
-        #     Required. The resource id key associated with the capacity plan.
-        # @!attribute [rw] location_id
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::LocationIdentifier]
-        #     Required. Identifier of location.
-        class CapacityPlanKey
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # CapacityPlanView contains the capacity plan key and the time series views.
-        # @!attribute [rw] key
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::CapacityPlanKey]
-        #     Required. The capacity plan key associated with the capacity plan view.
-        # @!attribute [rw] time_series_views
-        #   @return [::Array<::Google::Cloud::CapacityPlanner::V1beta::TimeSeriesView>]
-        #     Required. The time series views associated with the capacity plan view.
-        class CapacityPlanView
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # TimeSeriesView contains capacity_value which has the timeseries for a given
-        # type. Each type as a single timeseries associated with it.
-        # @!attribute [rw] type
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::CapacityType]
-        #     Required. The capacity type associated with the time series view.
-        # @!attribute [rw] capacity_value
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::DemandValue]
-        #     Required. The capacity value associated with the time series view.
-        class TimeSeriesView
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # A plan for additional capacity needed by a Google Cloud Platform project.
-        # This is synonymous with CapacityDemand, CapacityRequest, and
-        # CapacityDemandRequest.
-        # @!attribute [rw] name
-        #   @return [::String]
-        #     Identifier. The  name of the capacity plan.
-        #
-        #     Format:
-        #             projects/\\{project}/capacityPlans/\\{capacity_plan_id}
-        # @!attribute [rw] capacity_demand_metadata
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::DemandMetadata]
-        #     Optional. The metadata associated with a capacity demand.
-        # @!attribute [rw] service_demands
-        #   @return [::Array<::Google::Cloud::CapacityPlanner::V1beta::ServiceDemand>]
-        #     Required. The capacity demand associated with a service.
-        # @!attribute [r] reporter
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::User]
-        #     Output only. User who created the capacity plan.
-        # @!attribute [r] state
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::State]
-        #     Output only. State of the plan.
-        # @!attribute [r] create_time
-        #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. Timestamp when the plan was created.
-        # @!attribute [r] update_time
-        #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. Timestamp when the plan was last updated.
-        # @!attribute [rw] description
-        #   @return [::String]
-        #     Optional. Description of the plan.
-        # @!attribute [rw] title
-        #   @return [::String]
-        #     Optional. Title of the plan.
-        class CapacityPlan
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # The metadata associated with a capacity demand.
-        # @!attribute [rw] demand_preferences
-        #   @return [::Array<::Google::Cloud::CapacityPlanner::V1beta::DemandPreference>]
-        #     Optional. The preferences associated with a capacity demand.
-        class DemandMetadata
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Preference associated with a request, such as flexibility with alternate
-        # resource type.
-        # @!attribute [r] preference_id
-        #   @return [::String]
-        #     Output only. The preference id.
-        # @!attribute [rw] value
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::Value]
-        #     Required. The value of demand preference.
-        class DemandPreference
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Capacity demand for a service.
-        # @!attribute [rw] service
-        #   @return [::String]
-        #     Required. Name of the service.
-        # @!attribute [rw] demand_metadata
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::DemandMetadata]
-        #     Optional. The metadata associated with a service demand.
-        # @!attribute [rw] resource_demands
-        #   @return [::Array<::Google::Cloud::CapacityPlanner::V1beta::ResourceDemand>]
-        #     Required. The demand associated with the resources.
-        class ServiceDemand
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Capacity demand for a resource.
-        # @!attribute [r] id
-        #   @return [::String]
-        #     Output only. Identifier of resource demand.
-        # @!attribute [rw] resource_container
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::ResourceContainer]
-        #     Required. The resource container associated with the demand.
-        # @!attribute [rw] resource_id
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::ResourceIdentifier]
-        #     Required. Identifier of resource.
-        # @!attribute [rw] location_id
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::LocationIdentifier]
-        #     Required. Identifier of location.
-        # @!attribute [r] state
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::State]
-        #     Output only. State of the resource demand.
-        # @!attribute [r] reporter
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::User]
-        #     Output only. User who reported the demand.
-        # @!attribute [r] create_time
-        #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. Timestamp when the demand was created.
-        # @!attribute [r] update_time
-        #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. Timestamp when the demand was last updated.
-        # @!attribute [rw] demand_values
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::DemandValues]
-        #     Required. The demand values associated with the resource.
-        # @!attribute [rw] demand_metadata
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::DemandMetadata]
-        #     Optional. The metadata associated with the demand.
-        # @!attribute [rw] child_resource_demands
-        #   @return [::Array<::Google::Cloud::CapacityPlanner::V1beta::ChildResourceDemand>]
-        #     Optional. The child resource demands associated with the resource.
-        class ResourceDemand
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # A user who created or updated a capacity demand.
-        # @!attribute [rw] email
-        #   @return [::String]
-        #     Required. Email of the user.
-        class User
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # The capacity demand values for a resource.
-        # @!attribute [rw] values
-        #   @return [::Array<::Google::Cloud::CapacityPlanner::V1beta::DemandValue>]
-        #     Required. The demand values.
-        class DemandValues
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Capacity demand value for a single resource attribute such as CPU count,
-        # vertex AI peak QPM, etc.
-        # @!attribute [rw] name
-        #   @return [::String]
-        #     Required. The name of the demand value such as CPU count.
-        # @!attribute [rw] time_values
-        #   @return [::Array<::Google::Cloud::CapacityPlanner::V1beta::TimeValue>]
-        #     Required. The demand values at different time points.
-        # @!attribute [rw] unit
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::Unit]
-        #     Required. Unit of measurement.
-        class DemandValue
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Capacity demand value for a single time point.
-        # @!attribute [rw] time
-        #   @return [::Google::Protobuf::Timestamp]
-        #     Required. The time point. If this demand value is non-temporal, set time to
-        #     -1.
-        # @!attribute [rw] value
-        #   @return [::Float]
-        #     Required. The demand value at the time point.
-        class TimeValue
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # Capacity demand for a child resource such as shapes.
-        # @!attribute [rw] resource_id
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::ResourceIdentifier]
-        #     Required. Identifier of resource.
-        # @!attribute [rw] demand_values
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::DemandValues]
-        #     Required. The demand values associated with the child resource.
-        # @!attribute [rw] demand_metadata
-        #   @return [::Google::Cloud::CapacityPlanner::V1beta::DemandMetadata]
-        #     Optional. The metadata associated with the child resource demand.
-        class ChildResourceDemand
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
-        # The state of a capacity demand.
-        module State
-          # The state is unspecified.
-          STATE_UNSPECIFIED = 0
-
-          # The demand is pending review.
-          PENDING_REVIEW = 1
-
-          # The demand is in review.
-          IN_REVIEW = 3
-
-          # The demand is provisionally approved.
-          APPROVED_PROVISIONAL = 8
-
-          # The demand is obsolete.
-          OBSOLETE = 5
-
-          # The demand cannot be fulfilled.
-          CANNOT_BE_FULFILLED = 7
-
-          # The demand is on hold, contact sales.
-          ON_HOLD_CONTACT_SALES = 9
-
-          # The demand is in fulfillment.
-          IN_FULFILLMENT = 10
-        end
-
-        # CapacityType is the type of the capacity plan.
-        module CapacityType
-          # Default value.
-          CAPACITY_TYPE_UNKNOWN = 0
-
-          # Latest inorganic data stored in horizon DB that is in draft state.
-          CAPACITY_TYPE_INORGANIC_DRAFT = 1
-
-          # Latest inorganic data stored in horizon DB that are pending i.e. submitted
-          # or assessment.
-          CAPACITY_TYPE_INORGANIC_PENDING = 2
-
-          # Latest inorganic data stored in horizon DB that has been approved.
-          CAPACITY_TYPE_INORGANIC_APPROVED = 3
-        end
-      end
-    end
-  end
-end