google-cloud-support-v2beta 0.a → 0.1.0

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/support/v2beta/actor.rb

@@ -0,0 +1,59 @@
+# 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 Support
+      module V2beta
+        # An Actor represents an entity that performed an action. For example, an actor
+        # could be a user who posted a comment on a support case, a user who
+        # uploaded an attachment, or a service account that created a support case.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The name to display for the actor. If not provided, it is inferred from
+        #     credentials supplied during case creation. When an email is provided, a
+        #     display name must also be provided. This will be obfuscated if the user
+        #     is a Google Support agent.
+        # @!attribute [rw] email
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::String]
+        #     The email address of the actor. If not provided, it is inferred from the
+        #     credentials supplied during case creation. When a name is provided, an
+        #     email must also be provided. If the user is a Google Support agent, this is
+        #     obfuscated.
+        #
+        #     This field is deprecated. Use **username** field instead.
+        # @!attribute [r] google_support
+        #   @return [::Boolean]
+        #     Output only. Whether the actor is a Google support actor.
+        # @!attribute [r] username
+        #   @return [::String]
+        #     Output only. The username of the actor. It may look like an email or other
+        #     format provided by the identity provider. If not provided, it is inferred
+        #     from the credentials supplied. When a name is provided, a username must
+        #     also be provided. If the user is a Google Support agent, this will not be
+        #     set.
+        class Actor
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/support/v2beta/attachment.rb

@@ -0,0 +1,58 @@
+# 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 Support
+      module V2beta
+        # An Attachment contains metadata about a file that was uploaded to a
+        # case - it is NOT a file itself. That being said, the name of an Attachment
+        # object can be used to download its accompanying file through the
+        # `media.download` endpoint.
+        #
+        # While attachments can be uploaded in the console at the
+        # same time as a comment, they're associated on a "case" level, not a
+        # "comment" level.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name of the attachment.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time at which the attachment was created.
+        # @!attribute [r] creator
+        #   @return [::Google::Cloud::Support::V2beta::Actor]
+        #     Output only. The user who uploaded the attachment. Note, the name and email
+        #     will be obfuscated if the attachment was uploaded by Google support.
+        # @!attribute [rw] filename
+        #   @return [::String]
+        #     The filename of the attachment (e.g. `"graph.jpg"`).
+        # @!attribute [r] mime_type
+        #   @return [::String]
+        #     Output only. The MIME type of the attachment (e.g. text/plain).
+        # @!attribute [r] size_bytes
+        #   @return [::Integer]
+        #     Output only. The size of the attachment in bytes.
+        class Attachment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/support/v2beta/attachment_service.rb

@@ -0,0 +1,63 @@
+# 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 Support
+      module V2beta
+        # The request message for the ListAttachments endpoint.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The name of the case for which attachments should be listed.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The maximum number of attachments fetched with each request.
+        #
+        #     If not provided, the default is 10. The maximum page size that will be
+        #     returned is 100.
+        #
+        #     The size of each page can be smaller than the requested page size and can
+        #     include zero. For example, you could request 100 attachments on one page,
+        #     receive 0, and then on the next page, receive 90.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying the page of results to return. If unspecified, the
+        #     first page is retrieved.
+        class ListAttachmentsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for the ListAttachments endpoint.
+        # @!attribute [rw] attachments
+        #   @return [::Array<::Google::Cloud::Support::V2beta::Attachment>]
+        #     The list of attachments associated with a case.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results. Set this in the `page_token`
+        #     field of subsequent `cases.attachments.list` requests. If unspecified,
+        #     there are no more results to retrieve.
+        class ListAttachmentsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/support/v2beta/case.rb

@@ -0,0 +1,215 @@
+# 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 Support
+      module V2beta
+        # A Case is an object that contains the details of a support case. It
+        # contains fields for the time it was created, its priority, its
+        # classification, and more. Cases can also have comments and attachments that
+        # get added over time.
+        #
+        # A case is parented by a Google Cloud organization or project.
+        #
+        # Organizations are identified by a number, so the name of a case parented by
+        # an organization would look like this:
+        #
+        # ```
+        # organizations/123/cases/456
+        # ```
+        #
+        # Projects have two unique identifiers, an ID and a number, and they look like
+        # this:
+        #
+        # ```
+        # projects/abc/cases/456
+        # ```
+        #
+        # ```
+        # projects/123/cases/456
+        # ```
+        #
+        # You can use either of them when calling the API. To learn more
+        # about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The resource name for the case.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The short summary of the issue reported in this case.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     A broad description of the issue.
+        # @!attribute [rw] classification
+        #   @return [::Google::Cloud::Support::V2beta::CaseClassification]
+        #     The issue classification applicable to this case.
+        # @!attribute [rw] time_zone
+        #   @return [::String]
+        #     The timezone of the user who created the support case.
+        #     It should be in a format IANA recognizes: https://www.iana.org/time-zones.
+        #     There is no additional validation done by the API.
+        # @!attribute [rw] subscriber_email_addresses
+        #   @return [::Array<::String>]
+        #     The email addresses to receive updates on this case.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Support::V2beta::Case::State]
+        #     Output only. The current status of the support case.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time this case was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time this case was last updated.
+        # @!attribute [rw] creator
+        #   @return [::Google::Cloud::Support::V2beta::Actor]
+        #     The user who created the case.
+        #
+        #     Note: The name and email will be obfuscated if the case was created by
+        #     Google Support.
+        # @!attribute [rw] contact_email
+        #   @return [::String]
+        #     A user-supplied email address to send case update notifications for. This
+        #     should only be used in BYOID flows, where we cannot infer the user's email
+        #     address directly from their EUCs.
+        # @!attribute [rw] escalated
+        #   @return [::Boolean]
+        #     Whether the case is currently escalated.
+        # @!attribute [rw] test_case
+        #   @return [::Boolean]
+        #     Whether this case was created for internal API testing and should not be
+        #     acted on by the support team.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     The language the user has requested to receive support in. This should be a
+        #     BCP 47 language code (e.g., `"en"`, `"zh-CN"`, `"zh-TW"`, `"ja"`, `"ko"`).
+        #     If no language or an unsupported language is specified, this field defaults
+        #     to English (en).
+        #
+        #     Language selection during case creation may affect your available support
+        #     options. For a list of supported languages and their support working hours,
+        #     see: https://cloud.google.com/support/docs/language-working-hours
+        # @!attribute [rw] priority
+        #   @return [::Google::Cloud::Support::V2beta::Case::Priority]
+        #     The priority of this case.
+        class Case
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The status of a support case.
+          module State
+            # Case is in an unknown state.
+            STATE_UNSPECIFIED = 0
+
+            # The case has been created but no one is assigned to work on it yet.
+            NEW = 1
+
+            # The case is currently being handled by Google support.
+            IN_PROGRESS_GOOGLE_SUPPORT = 2
+
+            # Google is waiting for a response.
+            ACTION_REQUIRED = 3
+
+            # A solution has been offered for the case, but it isn't yet closed.
+            SOLUTION_PROVIDED = 4
+
+            # The case has been resolved.
+            CLOSED = 5
+          end
+
+          # The case Priority. P0 is most urgent and P4 the least.
+          module Priority
+            # Priority is undefined or has not been set yet.
+            PRIORITY_UNSPECIFIED = 0
+
+            # Extreme impact on a production service. Service is hard down.
+            P0 = 1
+
+            # Critical impact on a production service. Service is currently unusable.
+            P1 = 2
+
+            # Severe impact on a production service. Service is usable but greatly
+            # impaired.
+            P2 = 3
+
+            # Medium impact on a production service.  Service is available, but
+            # moderately impaired.
+            P3 = 4
+
+            # General questions or minor issues.  Production service is fully
+            # available.
+            P4 = 5
+          end
+        end
+
+        # A Case Classification represents the topic that a case is about. It's very
+        # important to use accurate classifications, because they're
+        # used to route your cases to specialists who can help you.
+        #
+        # A classification always has an ID that is its unique identifier.
+        # A valid ID is required when creating a case.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     The unique ID for a classification. Must be specified for case creation.
+        #
+        #     To retrieve valid classification IDs for case creation, use
+        #     `caseClassifications.search`.
+        #
+        #     Classification IDs returned by `caseClassifications.search` are guaranteed
+        #     to be valid for at least 6 months. If a given classification is
+        #     deactiveated, it will immediately stop being returned. After 6 months,
+        #     `case.create` requests using the classification ID will fail.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     A display name for the classification.
+        #
+        #     The display name is not static and can change. To uniquely and consistently
+        #     identify classifications, use the `CaseClassification.id` field.
+        # @!attribute [rw] product
+        #   @return [::Google::Cloud::Support::V2beta::Product]
+        #     The full product the classification corresponds to.
+        class CaseClassification
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The product a case may be associated with.
+        # @!attribute [rw] product_line
+        #   @return [::Google::Cloud::Support::V2beta::ProductLine]
+        #     The product line of the Product.
+        class Product
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The product line a support case may be associated with.
+        module ProductLine
+          # Unknown product type.
+          PRODUCT_LINE_UNSPECIFIED = 0
+
+          # Google Cloud
+          GOOGLE_CLOUD = 1
+
+          # Google Maps
+          GOOGLE_MAPS = 2
+        end
+      end
+    end
+  end
+end