class Google::Apis::GroupsmigrationV1::GroupsMigrationService
Groups
Migration API
The Groups
Migration API allows domain administrators to archive emails into
Google groups.
@example
require 'google/apis/groupsmigration_v1' Groupsmigration = Google::Apis::GroupsmigrationV1 # Alias the module service = Groupsmigration::GroupsMigrationService.new
Attributes
@return [String]
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
@return [String]
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
Public Class Methods
# File lib/google/apis/groupsmigration_v1/service.rb, line 46 def initialize super('https://groupsmigration.googleapis.com/', '', client_name: 'google-apis-groupsmigration_v1', client_version: Google::Apis::GroupsmigrationV1::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
Inserts a new mail into the archive of the Google
group. @param [String] group_id
The group ID
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
@param [IO, String] upload_source
IO stream or filename containing content to upload
@param [String] content_type
Content type of the uploaded content.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::GroupsmigrationV1::Groups] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::GroupsmigrationV1::Groups]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/groupsmigration_v1/service.rb, line 77 def insert_archive(group_id, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? command = make_simple_command(:post, 'groups/v1/groups/{groupId}/archive', options) else command = make_upload_command(:post, 'groups/v1/groups/{groupId}/archive', options) command.upload_source = upload_source command.upload_content_type = content_type end command.response_representation = Google::Apis::GroupsmigrationV1::Groups::Representation command.response_class = Google::Apis::GroupsmigrationV1::Groups command.params['groupId'] = group_id unless group_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end
Protected Instance Methods
# File lib/google/apis/groupsmigration_v1/service.rb, line 95 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end