google-apps-events-subscriptions-v1 0.a → 0.1.0

data/proto_docs/google/api/launch_stage.rb

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

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,222 @@
+# 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 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'. 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/apps/events/subscriptions/v1/subscription_resource.rb

@@ -0,0 +1,224 @@
+# 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 Apps
+    module Events
+      module Subscriptions
+        module V1
+          # A subscription to receive events about a Google Workspace resource. To learn
+          # more about subscriptions, see the [Google Workspace Events API
+          # overview](https://developers.google.com/workspace/events).
+          # @!attribute [rw] expire_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Non-empty default. The timestamp in UTC when the subscription expires.
+          #     Always displayed on output, regardless of what was used on input.
+          # @!attribute [rw] ttl
+          #   @return [::Google::Protobuf::Duration]
+          #     Input only. The time-to-live (TTL) or duration for the subscription. If
+          #     unspecified or set to `0`, uses the maximum possible duration.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Optional. Immutable. Identifier. Resource name of the subscription.
+          #
+          #     Format: `subscriptions/{subscription}`
+          # @!attribute [r] uid
+          #   @return [::String]
+          #     Output only. System-assigned unique identifier for the subscription.
+          # @!attribute [rw] target_resource
+          #   @return [::String]
+          #     Required. Immutable. The Google Workspace resource that's monitored for
+          #     events, formatted as the [full resource
+          #     name](https://google.aip.dev/122#full-resource-names). To learn about
+          #     target resources and the events that they support, see [Supported Google
+          #     Workspace
+          #     events](https://developers.google.com/workspace/events#supported-events).
+          #
+          #     A user can only authorize your app to create one subscription for a given
+          #     target resource. If your app tries to create another subscription with the
+          #     same user credentials, the request returns an `ALREADY_EXISTS` error.
+          # @!attribute [rw] event_types
+          #   @return [::Array<::String>]
+          #     Required. Immutable. Unordered list. Input for creating a subscription.
+          #     Otherwise, output only. One or more types of events to receive about the
+          #     target resource. Formatted according to the CloudEvents specification.
+          #
+          #     The supported event types depend on the target resource of your
+          #     subscription. For details, see [Supported Google Workspace
+          #     events](https://developers.google.com/workspace/events/guides#supported-events).
+          #
+          #     By default, you also receive events about the [lifecycle of your
+          #     subscription](https://developers.google.com/workspace/events/guides/events-lifecycle).
+          #     You don't need to specify lifecycle events for this field.
+          #
+          #     If you specify an event type that doesn't exist for the target resource,
+          #     the request returns an HTTP `400 Bad Request` status code.
+          # @!attribute [rw] payload_options
+          #   @return [::Google::Apps::Events::Subscriptions::V1::PayloadOptions]
+          #     Optional. Options about what data to include in the event payload. Only
+          #     supported for Google Chat events.
+          # @!attribute [rw] notification_endpoint
+          #   @return [::Google::Apps::Events::Subscriptions::V1::NotificationEndpoint]
+          #     Required. Immutable. The endpoint where the subscription delivers events,
+          #     such as a Pub/Sub topic.
+          # @!attribute [r] state
+          #   @return [::Google::Apps::Events::Subscriptions::V1::Subscription::State]
+          #     Output only. The state of the subscription. Determines whether the
+          #     subscription can receive events and deliver them to the notification
+          #     endpoint.
+          # @!attribute [r] suspension_reason
+          #   @return [::Google::Apps::Events::Subscriptions::V1::Subscription::ErrorType]
+          #     Output only. The error that suspended the subscription.
+          #
+          #     To reactivate the subscription, resolve the error and call the
+          #     {::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client#reactivate_subscription `ReactivateSubscription`}
+          #     method.
+          # @!attribute [r] authority
+          #   @return [::String]
+          #     Output only. The user who authorized the creation of the
+          #     subscription.
+          #
+          #     Format: `users/{user}`
+          #
+          #     For Google Workspace users, the `{user}` value is the
+          #     [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids)
+          #     field from the Directory API.
+          # @!attribute [r] create_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The time when the subscription is created.
+          # @!attribute [r] update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The last time that the subscription is updated.
+          # @!attribute [r] reconciling
+          #   @return [::Boolean]
+          #     Output only. If `true`, the subscription is in the process of being
+          #     updated.
+          # @!attribute [rw] etag
+          #   @return [::String]
+          #     Optional. This checksum is computed by the server based on the value of
+          #     other fields, and might be sent on update requests to ensure the client has
+          #     an up-to-date value before proceeding.
+          class Subscription
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Possible states for the subscription.
+            module State
+              # Default value. This value is unused.
+              STATE_UNSPECIFIED = 0
+
+              # The subscription is active and can receive and deliver events to its
+              # notification endpoint.
+              ACTIVE = 1
+
+              # The subscription is unable to receive events due to an error.
+              # To identify the error, see the
+              # {::Google::Apps::Events::Subscriptions::V1::Subscription#suspension_reason `suspension_reason`}
+              # field.
+              SUSPENDED = 2
+
+              # The subscription is deleted.
+              DELETED = 3
+            end
+
+            # Possible errors for a subscription.
+            module ErrorType
+              # Default value. This value is unused.
+              ERROR_TYPE_UNSPECIFIED = 0
+
+              # The authorizing user has revoked the grant of one or more OAuth scopes.
+              # To learn more about authorization for Google Workspace, see [Configure
+              # the OAuth consent
+              # screen](https://developers.google.com/workspace/guides/configure-oauth-consent#choose-scopes).
+              USER_SCOPE_REVOKED = 1
+
+              # The target resource for the subscription no longer exists.
+              RESOURCE_DELETED = 2
+
+              # The user that authorized the creation of the subscription no longer has
+              # access to the subscription's target resource.
+              USER_AUTHORIZATION_FAILURE = 3
+
+              # The Google Workspace application doesn't have access to deliver
+              # events to your subscription's notification endpoint.
+              ENDPOINT_PERMISSION_DENIED = 4
+
+              # The subscription's notification endpoint doesn't exist, or the endpoint
+              # can't be found in the Google Cloud project where you created the
+              # subscription.
+              ENDPOINT_NOT_FOUND = 6
+
+              # The subscription's notification endpoint failed to receive events due to
+              # insufficient quota or reaching rate limiting.
+              ENDPOINT_RESOURCE_EXHAUSTED = 7
+
+              # An unidentified error has occurred.
+              OTHER = 5
+            end
+          end
+
+          # Options about what data to include in the event payload. Only supported for
+          # Google Chat events.
+          # @!attribute [rw] include_resource
+          #   @return [::Boolean]
+          #     Optional. Whether the event payload includes data about the resource that
+          #     changed. For example, for an event where a Google Chat message was created,
+          #     whether the payload contains data about the
+          #     [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages)
+          #     resource. If false, the event payload only includes the name of the changed
+          #     resource.
+          # @!attribute [rw] field_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Optional. If `include_resource` is set to `true`, the list of fields to
+          #     include in the event payload. Separate fields with a comma. For example, to
+          #     include a Google Chat message's sender and create time, enter
+          #     `message.sender,message.createTime`. If omitted, the payload includes all
+          #     fields for the resource.
+          #
+          #     If you specify a field that doesn't exist for the resource, the system
+          #     ignores the field.
+          class PayloadOptions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The endpoint where the subscription delivers events.
+          # @!attribute [rw] pubsub_topic
+          #   @return [::String]
+          #     Immutable. The Cloud Pub/Sub topic that receives events for the
+          #     subscription.
+          #
+          #     Format: `projects/{project}/topics/{topic}`
+          #
+          #
+          #     You must create the topic in the same Google Cloud project where
+          #     you create this subscription.
+          #
+          #     When the topic receives events, the events are encoded as Cloud Pub/Sub
+          #     messages. For details, see the [Google Cloud Pub/Sub Protocol Binding for
+          #     CloudEvents](https://github.com/googleapis/google-cloudevents/blob/main/docs/spec/pubsub.md).
+          class NotificationEndpoint
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end