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

data/proto_docs/google/cloud/apphub/v1/application.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AppHub
+      module V1
+        # Application defines the governance boundary for App Hub Entities that
+        # perform a logical end-to-end business function.
+        # App Hub supports application level IAM permission to align with governance
+        # requirements.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of an Application. Format:
+        #     "projects/\\{host-project-id}/locations/\\{location}/applications/\\{application-id}"
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. User-defined name for the Application.
+        #     Can have a maximum length of 63 characters.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. User-defined description of an Application.
+        #     Can have a maximum length of 2048 characters.
+        # @!attribute [rw] attributes
+        #   @return [::Google::Cloud::AppHub::V1::Attributes]
+        #     Optional. Consumer provided attributes.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Create time.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Update time.
+        # @!attribute [rw] scope
+        #   @return [::Google::Cloud::AppHub::V1::Scope]
+        #     Required. Immutable. Defines what data can be included into this
+        #     Application. Limits which Services and Workloads can be registered.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. A universally unique identifier (in UUID4 format) for the
+        #     `Application`.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::AppHub::V1::Application::State]
+        #     Output only. Application state.
+        class Application
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Application state.
+          module State
+            # Unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # The Application is being created.
+            CREATING = 1
+
+            # The Application is ready to register Services and Workloads.
+            ACTIVE = 2
+
+            # The Application is being deleted.
+            DELETING = 3
+          end
+        end
+
+        # Scope of an application.
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::AppHub::V1::Scope::Type]
+        #     Required. Scope Type.
+        class Scope
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Scope Type.
+          module Type
+            # Unspecified type.
+            TYPE_UNSPECIFIED = 0
+
+            # Regional type.
+            REGIONAL = 1
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/apphub/v1/attributes.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AppHub
+      module V1
+        # Consumer provided attributes.
+        # @!attribute [rw] criticality
+        #   @return [::Google::Cloud::AppHub::V1::Criticality]
+        #     Optional. User-defined criticality information.
+        # @!attribute [rw] environment
+        #   @return [::Google::Cloud::AppHub::V1::Environment]
+        #     Optional. User-defined environment information.
+        # @!attribute [rw] developer_owners
+        #   @return [::Array<::Google::Cloud::AppHub::V1::ContactInfo>]
+        #     Optional. Developer team that owns development and coding.
+        # @!attribute [rw] operator_owners
+        #   @return [::Array<::Google::Cloud::AppHub::V1::ContactInfo>]
+        #     Optional. Operator team that ensures runtime and operations.
+        # @!attribute [rw] business_owners
+        #   @return [::Array<::Google::Cloud::AppHub::V1::ContactInfo>]
+        #     Optional. Business team that ensures user needs are met and value is
+        #     delivered
+        class Attributes
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Criticality of the Application, Service, or Workload
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::AppHub::V1::Criticality::Type]
+        #     Required. Criticality Type.
+        class Criticality
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Criticality Type.
+          module Type
+            # Unspecified type.
+            TYPE_UNSPECIFIED = 0
+
+            # Mission critical service, application or workload.
+            MISSION_CRITICAL = 1
+
+            # High impact.
+            HIGH = 2
+
+            # Medium impact.
+            MEDIUM = 3
+
+            # Low impact.
+            LOW = 4
+          end
+        end
+
+        # Environment of the Application, Service, or Workload
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::AppHub::V1::Environment::Type]
+        #     Required. Environment Type.
+        class Environment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Environment Type.
+          module Type
+            # Unspecified type.
+            TYPE_UNSPECIFIED = 0
+
+            # Production environment.
+            PRODUCTION = 1
+
+            # Staging environment.
+            STAGING = 2
+
+            # Test environment.
+            TEST = 3
+
+            # Development environment.
+            DEVELOPMENT = 4
+          end
+        end
+
+        # Contact information of stakeholders.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. Contact's name.
+        #     Can have a maximum length of 63 characters.
+        # @!attribute [rw] email
+        #   @return [::String]
+        #     Required. Email address of the contacts.
+        class ContactInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/apphub/v1/service.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AppHub
+      module V1
+        # Service is an App Hub data model that contains a discovered service, which
+        # represents a network/api interface that exposes some functionality to clients
+        # for consumption over the network.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of a Service. Format:
+        #     "projects/\\{host-project-id}/locations/\\{location}/applications/\\{application-id}/services/\\{service-id}"
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. User-defined name for the Service.
+        #     Can have a maximum length of 63 characters.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. User-defined description of a Service.
+        #     Can have a maximum length of 2048 characters.
+        # @!attribute [r] service_reference
+        #   @return [::Google::Cloud::AppHub::V1::ServiceReference]
+        #     Output only. Reference to an underlying networking resource that can
+        #     comprise a Service. These are immutable.
+        # @!attribute [r] service_properties
+        #   @return [::Google::Cloud::AppHub::V1::ServiceProperties]
+        #     Output only. Properties of an underlying compute resource that can comprise
+        #     a Service. These are immutable.
+        # @!attribute [rw] attributes
+        #   @return [::Google::Cloud::AppHub::V1::Attributes]
+        #     Optional. Consumer provided attributes.
+        # @!attribute [rw] discovered_service
+        #   @return [::String]
+        #     Required. Immutable. The resource name of the original discovered service.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Create time.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Update time.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. A universally unique identifier (UUID) for the `Service` in
+        #     the UUID4 format.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::AppHub::V1::Service::State]
+        #     Output only. Service state.
+        class Service
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Service state.
+          module State
+            # Unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # The service is being created.
+            CREATING = 1
+
+            # The service is ready.
+            ACTIVE = 2
+
+            # The service is being deleted.
+            DELETING = 3
+
+            # The underlying networking resources have been deleted.
+            DETACHED = 4
+          end
+        end
+
+        # Reference to an underlying networking resource that can comprise a Service.
+        # @!attribute [r] uri
+        #   @return [::String]
+        #     Output only. The underlying resource URI (For example, URI of Forwarding
+        #     Rule, URL Map, and Backend Service).
+        class ServiceReference
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Properties of an underlying cloud resource that can comprise a Service.
+        # @!attribute [r] gcp_project
+        #   @return [::String]
+        #     Output only. The service project identifier that the underlying cloud
+        #     resource resides in.
+        # @!attribute [r] location
+        #   @return [::String]
+        #     Output only. The location that the underlying resource resides in, for
+        #     example, us-west1.
+        # @!attribute [r] zone
+        #   @return [::String]
+        #     Output only. The location that the underlying resource resides in if it is
+        #     zonal, for example, us-west1-a).
+        class ServiceProperties
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # DiscoveredService is a network/api interface that exposes some functionality
+        # to clients for consumption over the network. A discovered service can be
+        # registered to a App Hub service.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the discovered service. Format:
+        #     "projects/\\{host-project-id}/locations/\\{location}/discoveredServices/\\{uuid}""
+        # @!attribute [r] service_reference
+        #   @return [::Google::Cloud::AppHub::V1::ServiceReference]
+        #     Output only. Reference to an underlying networking resource that can
+        #     comprise a Service. These are immutable.
+        # @!attribute [r] service_properties
+        #   @return [::Google::Cloud::AppHub::V1::ServiceProperties]
+        #     Output only. Properties of an underlying compute resource that can comprise
+        #     a Service. These are immutable.
+        class DiscoveredService
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/apphub/v1/service_project_attachment.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AppHub
+      module V1
+        # ServiceProjectAttachment represents an attachment from a service project to a
+        # host project. Service projects contain the underlying cloud
+        # infrastructure resources, and expose these resources to the host project
+        # through a ServiceProjectAttachment. With the attachments, the host project
+        # can provide an aggregated view of resources across all service projects.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of a ServiceProjectAttachment. Format:
+        #     "projects/\\{host-project-id}/locations/global/serviceProjectAttachments/\\{service-project-id}."
+        # @!attribute [rw] service_project
+        #   @return [::String]
+        #     Required. Immutable. Service project name in the format: "projects/abc" or
+        #     "projects/123". As input, project name with either project id or number are
+        #     accepted. As output, this field will contain project number.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Create time.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. A globally unique identifier (in UUID4 format) for the
+        #     `ServiceProjectAttachment`.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::AppHub::V1::ServiceProjectAttachment::State]
+        #     Output only. ServiceProjectAttachment state.
+        class ServiceProjectAttachment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # ServiceProjectAttachment state.
+          module State
+            # Unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # The ServiceProjectAttachment is being created.
+            CREATING = 1
+
+            # The ServiceProjectAttachment is ready.
+            # This means Services and Workloads under the corresponding
+            # ServiceProjectAttachment is ready for registration.
+            ACTIVE = 2
+
+            # The ServiceProjectAttachment is being deleted.
+            DELETING = 3
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/apphub/v1/workload.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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 AppHub
+      module V1
+        # Workload is an App Hub data model that contains a discovered workload, which
+        # represents a binary deployment (such as managed instance groups (MIGs) and
+        # GKE deployments) that performs the smallest logical subset of business
+        # functionality.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the Workload. Format:
+        #     "projects/\\{host-project-id}/locations/\\{location}/applications/\\{application-id}/workloads/\\{workload-id}"
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. User-defined name for the Workload.
+        #     Can have a maximum length of 63 characters.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. User-defined description of a Workload.
+        #     Can have a maximum length of 2048 characters.
+        # @!attribute [r] workload_reference
+        #   @return [::Google::Cloud::AppHub::V1::WorkloadReference]
+        #     Output only. Reference of an underlying compute resource represented by the
+        #     Workload. These are immutable.
+        # @!attribute [r] workload_properties
+        #   @return [::Google::Cloud::AppHub::V1::WorkloadProperties]
+        #     Output only. Properties of an underlying compute resource represented by
+        #     the Workload. These are immutable.
+        # @!attribute [rw] discovered_workload
+        #   @return [::String]
+        #     Required. Immutable. The resource name of the original discovered workload.
+        # @!attribute [rw] attributes
+        #   @return [::Google::Cloud::AppHub::V1::Attributes]
+        #     Optional. Consumer provided attributes.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Create time.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Update time.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. A universally unique identifier (UUID) for the `Workload` in
+        #     the UUID4 format.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::AppHub::V1::Workload::State]
+        #     Output only. Workload state.
+        class Workload
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Workload state.
+          module State
+            # Unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # The Workload is being created.
+            CREATING = 1
+
+            # The Workload is ready.
+            ACTIVE = 2
+
+            # The Workload is being deleted.
+            DELETING = 3
+
+            # The underlying compute resources have been deleted.
+            DETACHED = 4
+          end
+        end
+
+        # Reference of an underlying compute resource represented by the Workload.
+        # @!attribute [r] uri
+        #   @return [::String]
+        #     Output only. The underlying compute resource uri.
+        class WorkloadReference
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Properties of an underlying compute resource represented by the Workload.
+        # @!attribute [r] gcp_project
+        #   @return [::String]
+        #     Output only. The service project identifier that the underlying cloud
+        #     resource resides in. Empty for non cloud resources.
+        # @!attribute [r] location
+        #   @return [::String]
+        #     Output only. The location that the underlying compute resource resides in
+        #     (e.g us-west1).
+        # @!attribute [r] zone
+        #   @return [::String]
+        #     Output only. The location that the underlying compute resource resides in
+        #     if it is zonal (e.g us-west1-a).
+        class WorkloadProperties
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # DiscoveredWorkload is a binary deployment (such as managed instance groups
+        # (MIGs) and GKE deployments) that performs the smallest logical subset of
+        # business functionality. A discovered workload can be registered to an App Hub
+        # Workload.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the discovered workload. Format:
+        #     "projects/\\{host-project-id}/locations/\\{location}/discoveredWorkloads/\\{uuid}"
+        # @!attribute [r] workload_reference
+        #   @return [::Google::Cloud::AppHub::V1::WorkloadReference]
+        #     Output only. Reference of an underlying compute resource represented by the
+        #     Workload. These are immutable.
+        # @!attribute [r] workload_properties
+        #   @return [::Google::Cloud::AppHub::V1::WorkloadProperties]
+        #     Output only. Properties of an underlying compute resource represented by
+        #     the Workload. These are immutable.
+        class DiscoveredWorkload
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end