google-apps-meet-v2beta 0.a → 0.2.0

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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/meet/v2beta/resource.rb

@@ -0,0 +1,375 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Meet
+      module V2beta
+        # [Developer Preview](https://developers.google.com/workspace/preview).
+        # Virtual place where conferences are held. Only one active conference can be
+        # held in one space at any given time.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Resource name of the space.
+        #     Format: `spaces/{space}`
+        # @!attribute [r] meeting_uri
+        #   @return [::String]
+        #     Output only. URI used to join meeting, such as
+        #     `https://meet.google.com/abc-mnop-xyz`.
+        # @!attribute [r] meeting_code
+        #   @return [::String]
+        #     Output only. Type friendly code to join the meeting. Format:
+        #     `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128
+        #     characters. Can ONLY be used as alias of the space ID to get the space.
+        # @!attribute [rw] config
+        #   @return [::Google::Apps::Meet::V2beta::SpaceConfig]
+        #     Configuration pertaining to the meeting space.
+        # @!attribute [rw] active_conference
+        #   @return [::Google::Apps::Meet::V2beta::ActiveConference]
+        #     Active conference if it exists.
+        class Space
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Active conference.
+        # @!attribute [r] conference_record
+        #   @return [::String]
+        #     Output only. Reference to 'ConferenceRecord' resource.
+        #     Format: `conferenceRecords/{conference_record}` where `{conference_record}`
+        #     is a unique id for each instance of a call within a space.
+        class ActiveConference
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The configuration pertaining to a meeting space.
+        # @!attribute [rw] access_type
+        #   @return [::Google::Apps::Meet::V2beta::SpaceConfig::AccessType]
+        #     Access type of the meeting space that determines who can join without
+        #     knocking. Default: The user's default access settings.  Controlled by the
+        #     user's admin for enterprise users or RESTRICTED.
+        # @!attribute [rw] entry_point_access
+        #   @return [::Google::Apps::Meet::V2beta::SpaceConfig::EntryPointAccess]
+        #     Defines the entry points that can be used to join meetings hosted in this
+        #     meeting space.
+        #     Default: EntryPointAccess.ALL
+        class SpaceConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Possible access types for a meeting space.
+          module AccessType
+            # Default value specified by the user's organization.
+            # Note: This is never returned, as the configured access type is
+            # returned instead.
+            ACCESS_TYPE_UNSPECIFIED = 0
+
+            # Anyone with the join information (for example, the URL or phone access
+            # information) can join without knocking.
+            OPEN = 1
+
+            # Members of the host's organization, invited external users, and dial-in
+            # users can join without knocking. Everyone else must knock.
+            TRUSTED = 2
+
+            # Only invitees can join without knocking. Everyone else must knock.
+            RESTRICTED = 3
+          end
+
+          # Entry points that can be used to join a meeting.  Example:
+          # `meet.google.com`, the Embed SDK Web, or a mobile application.
+          module EntryPointAccess
+            # Unused.
+            ENTRY_POINT_ACCESS_UNSPECIFIED = 0
+
+            # All entry points are allowed.
+            ALL = 1
+
+            # Only entry points owned by the Google Cloud project that created the
+            # space can be used to join meetings in this space.  Apps can use the Embed
+            # SDK Web or mobile Meet SDKs to create owned entry points.
+            CREATOR_APP_ONLY = 2
+          end
+        end
+
+        # [Developer Preview](https://developers.google.com/workspace/preview).
+        # Single instance of a meeting held in a space.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. Resource name of the conference record.
+        #     Format: `conferenceRecords/{conference_record}` where `{conference_record}`
+        #     is a unique id for each instance of a call within a space.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the conference started, always set.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the conference ended.
+        #     Set for past conferences. Unset if the conference is ongoing.
+        # @!attribute [r] expire_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Server enforced expire time for when this conference record
+        #     resource is deleted. The resource is deleted 30 days after the conference
+        #     ends.
+        # @!attribute [r] space
+        #   @return [::String]
+        #     Output only. The space where the conference was held.
+        class ConferenceRecord
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # [Developer Preview](https://developers.google.com/workspace/preview).
+        # User who attended or is attending a conference.
+        # @!attribute [rw] signedin_user
+        #   @return [::Google::Apps::Meet::V2beta::SignedinUser]
+        #     Signed-in user.
+        # @!attribute [rw] anonymous_user
+        #   @return [::Google::Apps::Meet::V2beta::AnonymousUser]
+        #     Anonymous user.
+        # @!attribute [rw] phone_user
+        #   @return [::Google::Apps::Meet::V2beta::PhoneUser]
+        #     User who calls in from their phone.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Resource name of the participant.
+        #     Format: `conferenceRecords/{conference_record}/participants/{participant}`
+        # @!attribute [r] earliest_start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time when the participant joined the meeting for the first
+        #     time.
+        # @!attribute [r] latest_end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Time when the participant left the meeting for the last time.
+        #     This can be null if it is an active meeting.
+        class Participant
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # [Developer Preview](https://developers.google.com/workspace/preview).
+        # Refers to each unique join/leave session when a user joins a conference from
+        # a device. Note that any time a user joins the conference a new unique ID is
+        # assigned. That means if a user joins a space multiple times from the same
+        # device, they're assigned different IDs, and are also be treated as different
+        # participant sessions.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. Session id.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the user session started.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the user session ended. Unset if the user
+        #     session hasn’t ended.
+        class ParticipantSession
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A signed-in user can be:
+        # a) An individual joining from a personal computer, mobile device, or through
+        # companion mode.
+        # b) A robot account used by conference room devices.
+        # @!attribute [r] user
+        #   @return [::String]
+        #     Output only. Unique ID for the user. Interoperable with Admin SDK API and
+        #     People API. Format: `users/{user}`
+        # @!attribute [r] display_name
+        #   @return [::String]
+        #     Output only. For a personal device, it's the user's first and last name.
+        #     For a robot account, it's the admin specified device name. For example,
+        #     "Altostrat Room".
+        class SignedinUser
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # User who joins anonymously (meaning not signed into a Google Account).
+        # @!attribute [r] display_name
+        #   @return [::String]
+        #     Output only. User provided name when they join a conference anonymously.
+        class AnonymousUser
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # User dialing in from a phone where the user's identity is unknown because
+        # they haven't signed in with a Google Account.
+        # @!attribute [r] display_name
+        #   @return [::String]
+        #     Output only. Partially redacted user's phone number when they call in.
+        class PhoneUser
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # [Developer Preview](https://developers.google.com/workspace/preview).
+        # Metadata about a recording created during a conference.
+        # @!attribute [r] drive_destination
+        #   @return [::Google::Apps::Meet::V2beta::DriveDestination]
+        #     Output only. Recording is saved to Google Drive as an mp4 file. The
+        #     `drive_destination` includes the Drive `fileId` that can be used to
+        #     download the file using the `files.get` method of the Drive API.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Resource name of the recording.
+        #     Format: `conferenceRecords/{conference_record}/recordings/{recording}`
+        #     where `{recording}` is a 1:1 mapping to each unique recording session
+        #     during the conference.
+        # @!attribute [r] state
+        #   @return [::Google::Apps::Meet::V2beta::Recording::State]
+        #     Output only. Current state.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the recording started.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the recording ended.
+        class Recording
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Current state of the recording session.
+          module State
+            # Default, never used.
+            STATE_UNSPECIFIED = 0
+
+            # An active recording session has started.
+            STARTED = 1
+
+            # This recording session has ended, but the recording file hasn't been
+            # generated yet.
+            ENDED = 2
+
+            # Recording file is generated and ready to download.
+            FILE_GENERATED = 3
+          end
+        end
+
+        # Export location where a recording file is saved in Google Drive.
+        # @!attribute [r] file
+        #   @return [::String]
+        #     Output only. The `fileId` for the underlying MP4 file. For example,
+        #     "1kuceFZohVoCh6FulBHxwy6I15Ogpc4hP". Use `$ GET
+        #     https://www.googleapis.com/drive/v3/files/\\{$fileId}?alt=media` to download
+        #     the blob. For more information, see
+        #     https://developers.google.com/drive/api/v3/reference/files/get.
+        # @!attribute [r] export_uri
+        #   @return [::String]
+        #     Output only. Link used to play back the recording file in the browser. For
+        #     example, `https://drive.google.com/file/d/{$fileId}/view`.
+        class DriveDestination
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # [Developer Preview](https://developers.google.com/workspace/preview).
+        # Metadata for a transcript generated from a conference. It refers to the ASR
+        # (Automatic Speech Recognition) result of user's speech during the conference.
+        # @!attribute [r] docs_destination
+        #   @return [::Google::Apps::Meet::V2beta::DocsDestination]
+        #     Output only. Where the Google Docs transcript is saved.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Resource name of the transcript.
+        #     Format: `conferenceRecords/{conference_record}/transcripts/{transcript}`,
+        #     where `{transcript}` is a 1:1 mapping to each unique transcription session
+        #     of the conference.
+        # @!attribute [r] state
+        #   @return [::Google::Apps::Meet::V2beta::Transcript::State]
+        #     Output only. Current state.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the transcript started.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the transcript stopped.
+        class Transcript
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Current state of the transcript session.
+          module State
+            # Default, never used.
+            STATE_UNSPECIFIED = 0
+
+            # An active transcript session has started.
+            STARTED = 1
+
+            # This transcript session has ended, but the transcript file hasn't been
+            # generated yet.
+            ENDED = 2
+
+            # Transcript file is generated and ready to download.
+            FILE_GENERATED = 3
+          end
+        end
+
+        # Google Docs location where the transcript file is saved.
+        # @!attribute [r] document
+        #   @return [::String]
+        #     Output only. The document ID for the underlying Google Docs transcript
+        #     file. For example, "1kuceFZohVoCh6FulBHxwy6I15Ogpc4hP". Use the
+        #     `documents.get` method of the Google Docs API
+        #     (https://developers.google.com/docs/api/reference/rest/v1/documents/get) to
+        #     fetch the content.
+        # @!attribute [r] export_uri
+        #   @return [::String]
+        #     Output only. URI for the Google Docs transcript file. Use
+        #     `https://docs.google.com/document/d/{$DocumentId}/view` to browse the
+        #     transcript in the browser.
+        class DocsDestination
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # [Developer Preview](https://developers.google.com/workspace/preview).
+        # Single entry for one user’s speech during a transcript session.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Resource name of the entry. Format:
+        #     "conferenceRecords/\\{conference_record}/transcripts/\\{transcript}/entries/\\{entry}"
+        # @!attribute [r] participant
+        #   @return [::String]
+        #     Output only. Refer to the participant who speaks.
+        # @!attribute [r] text
+        #   @return [::String]
+        #     Output only. The transcribed text of the participant's voice, at maximum
+        #     10K words. Note that the limit is subject to change.
+        # @!attribute [r] language_code
+        #   @return [::String]
+        #     Output only. Language of spoken text, such as "en-US".
+        #     IETF BCP 47 syntax (https://tools.ietf.org/html/bcp47)
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the transcript entry started.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the transcript entry ended.
+        class TranscriptEntry
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end