Class: Google::Apis::GroupsmigrationV1::GroupsMigrationService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/groupsmigration_v1/service.rb

Overview

Groups Migration API

Groups Migration Api.

Examples:

require 'google/apis/groupsmigration_v1'

Groupsmigration = Google::Apis::GroupsmigrationV1 # Alias the module
service = Groupsmigration::GroupsMigrationService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ GroupsMigrationService

Returns a new instance of GroupsMigrationService



51
52
53
54
 
# File 'generated/google/apis/groupsmigration_v1/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'groups/v1/groups/')
  @batch_path = 'batch/groupsmigration/v1'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (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.



38
39
40
 
# File 'generated/google/apis/groupsmigration_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns 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. Overrides userIp if both are provided.

Returns:

  • (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. Overrides userIp if both are provided.



44
45
46
 
# File 'generated/google/apis/groupsmigration_v1/service.rb', line 44

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



49
50
51
 
# File 'generated/google/apis/groupsmigration_v1/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#insert_archive(group_id, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GroupsmigrationV1::Groups

Inserts a new mail into the archive of the Google group.

Parameters:

  • group_id (String) —

    The group ID

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • upload_source (IO, String) —

    IO stream or filename containing content to upload

  • content_type (String) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'generated/google/apis/groupsmigration_v1/service.rb', line 84

def insert_archive(group_id, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:post, '{groupId}/archive', options)
  else
    command = make_upload_command(:post, '{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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end