google-cloud-capacity_planner-v1beta 0.a → 0.1.0

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

@@ -0,0 +1,374 @@
+# 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

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

@@ -0,0 +1,185 @@
+# 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
+        # Repesents Future Reservation request which is part of aggregated
+        # reservations data response of "QueryReservations".
+        # @!attribute [rw] specific_sku_properties
+        #   @return [::Google::Cloud::CapacityPlanner::V1beta::FutureReservation::SpecificSKUProperties]
+        #     Future Reservation configuration to indicate instance properties and
+        #     total count.
+        # @!attribute [rw] id
+        #   @return [::Integer]
+        #     A unique identifier for this future reservation. The server
+        #     defines this identifier.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The creation timestamp for this future reservation.
+        # @!attribute [rw] zone
+        #   @return [::String]
+        #     URL of the Zone where this future reservation resides.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Description of the future reservation provided by user.
+        # @!attribute [rw] future_reservation
+        #   @return [::String]
+        #     The future reservation resource name.
+        # @!attribute [rw] owner_project_id
+        #   @return [::String]
+        # @!attribute [rw] time_window
+        #   @return [::Google::Cloud::CapacityPlanner::V1beta::FutureReservation::TimeWindow]
+        #     Time window for this Future Reservation.
+        # @!attribute [rw] share_settings
+        #   @return [::Google::Cloud::CapacityPlanner::V1beta::Allocation::ShareSettings]
+        #     List of Projects/Folders to share with.
+        # @!attribute [rw] name_prefix
+        #   @return [::String]
+        #     Name prefix for the reservations to be created at the time of
+        #     delivery. The name prefix must comply with RFC1035.
+        #     Maximum allowed length for name prefix is 20. Automatically created
+        #     reservations name format will be <name-prefix>-date-####.
+        # @!attribute [rw] status
+        #   @return [::Google::Cloud::CapacityPlanner::V1beta::FutureReservation::Status]
+        #     Status of the Future Reservation
+        # @!attribute [rw] auto_created_reservations_delete_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Future timestamp when the FR auto-created reservations will be deleted by
+        #     Compute Engine. Format of this field must be a valid RFC3339 value.
+        # @!attribute [rw] auto_delete_auto_created_reservations
+        #   @return [::Boolean]
+        #     Setting for enabling or disabling automatic deletion for auto-created
+        #     reservation. If set to true, auto-created reservations will be
+        #     deleted at Future Reservation's end time (default) or at user's defined
+        #     timestamp if any of the
+        #     [auto_created_reservations_delete_time, auto_created_reservations_duration]
+        #     values is specified.
+        #     For keeping auto-created reservation indefinitely, this value should be set
+        #     to false.
+        class FutureReservation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents specific SKU properties for the Future Reservation.
+          # @!attribute [rw] instance_properties
+          #   @return [::Google::Cloud::CapacityPlanner::V1beta::Allocation::SpecificSKUAllocation::AllocatedInstanceProperties]
+          #     Properties of the SKU instances being reserved.
+          # @!attribute [rw] total_count
+          #   @return [::Integer]
+          #     Total number of instances for which capacity assurance is requested at a
+          #     future time period.
+          class SpecificSKUProperties
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents time window for the Future Reservation.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Start time of the Future Reservation.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     End time of the Future Reservation.
+          class TimeWindow
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents status related to the future reservation.
+          # @!attribute [rw] procurement_status
+          #   @return [::Google::Cloud::CapacityPlanner::V1beta::FutureReservation::Status::ProcurementStatus]
+          #     Current state of this Future Reservation
+          # @!attribute [rw] lock_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Time when Future Reservation would become LOCKED, after which no
+          #     modifications to Future Reservation will be allowed. Applicable only
+          #     after the Future Reservation is in the APPROVED state. The lock_time is
+          #     an RFC3339 string. The procurement_status will transition to PROCURING
+          #     state at this time.
+          # @!attribute [rw] auto_created_reservations
+          #   @return [::Array<::String>]
+          #     Fully qualified urls of the automatically created reservations at
+          #     start_time.
+          # @!attribute [rw] fulfilled_count
+          #   @return [::Integer]
+          #     This count indicates the fulfilled capacity so far. This is set during
+          #     "PROVISIONING" state. This count also includes capacity delivered as part
+          #     of existing matching reservations.
+          class Status
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Represents procurement status of the Future Reservation.
+            module ProcurementStatus
+              # This is unused status value.
+              PROCUREMENT_STATUS_UNSPECIFIED = 0
+
+              # Future reservation is pending approval by Google Cloud Platform.
+              PENDING_APPROVAL = 1
+
+              # Future reservation is approved by Google Cloud Platform.
+              APPROVED = 2
+
+              # Future reservation is committed by the customer.
+              COMMITTED = 3
+
+              # Future reservation is rejected by Google Cloud Platform.
+              DECLINED = 4
+
+              # Future reservation is cancelled by the customer.
+              CANCELLED = 5
+
+              # Future reservation is being procured by Google Cloud Platform. Beyond
+              # this point, Future reservation is locked and no further modifications
+              # are allowed.
+              PROCURING = 6
+
+              # Future reservation capacity is being provisioned. This state will be
+              # entered after start_time, while reservations are being created to
+              # provide total_count reserved instance slots. This state will not
+              # persist past start_time + 24h.
+              PROVISIONING = 7
+
+              # Future reservation is fulfilled completely.
+              FULFILLED = 8
+
+              # Future reservation failed. No additional reservations were provided.
+              FAILED = 9
+
+              # Future reservation is partially fulfilled. Additional reservations were
+              # provided but did not reach total_count reserved instance slots.
+              FAILED_PARTIALLY_FULFILLED = 10
+
+              # Related status for PlanningStatus.Draft. Transitions to
+              # PENDING_APPROVAL upon user submitting FR.
+              DRAFTING = 11
+
+              # An Amendment to the Future Reservation has been requested. If the
+              # Amendment is declined, the Future Reservation will be restored to the
+              # last known good state.
+              PENDING_AMENDMENT_APPROVAL = 12
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# 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
+        # Identifier for a Google Cloud Platform location.
+        # @!attribute [rw] location_level
+        #   @return [::Google::Cloud::CapacityPlanner::V1beta::LocationLevel]
+        #     The location level such as a region.
+        # @!attribute [rw] source
+        #   @return [::String]
+        #     Required. Location where resource is sourced. For Cloud Storage, the
+        #     alphabetically first location is the source.
+        # @!attribute [rw] linked_locations
+        #   @return [::Array<::Google::Cloud::CapacityPlanner::V1beta::LocationIdentifier::LinkedLocation>]
+        #     Optional. Other linked locations.
+        class LocationIdentifier
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] location_level
+          #   @return [::Google::Cloud::CapacityPlanner::V1beta::LocationLevel]
+          #     The location level such as a region.
+          # @!attribute [rw] location
+          #   @return [::String]
+          #     Required. The linked cloud location.
+          # @!attribute [rw] label
+          #   @return [::String]
+          class LinkedLocation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The level of the Google Cloud Platform location.
+        module LocationLevel
+          # Location level is unspecified.
+          LOCATION_LEVEL_UNSPECIFIED = 0
+
+          # Cloud region.
+          REGION = 1
+
+          # Cloud zone.
+          ZONE = 2
+
+          # Globally.
+          GLOBAL = 3
+
+          # A metro.
+          METRO = 4
+
+          # Dual region pair.
+          DUAL_REGION = 5
+
+          # Multiple regions.
+          MULTI_REGION = 6
+        end
+      end
+    end
+  end
+end