Class: Google::Apis::AdminDatatransferV1::DataTransferService

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

Overview

Admin Data Transfer API

Transfers user data from one user to another.

Examples:

require 'google/apis/admin_datatransfer_v1'

Admin = Google::Apis::AdminDatatransferV1 # Alias the module
service = Admin::DataTransferService.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

Constructor Details

#initialize ⇒ DataTransferService

Returns a new instance of DataTransferService.



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

def initialize
  super('https://www.googleapis.com/', 'admin/datatransfer/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/admin_datatransfer_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/admin_datatransfer_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/admin_datatransfer_v1/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#get_application(application_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::Application

Retrieves information about an application for the given application ID.

Parameters:

  • application_id (String) —

    ID of the application resource to be retrieved.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



79
80
81
82
83
84
85
86
87
88
 
# File 'generated/google/apis/admin_datatransfer_v1/service.rb', line 79

def get_application(application_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'applications/{applicationId}', options)
  command.response_representation = Google::Apis::AdminDatatransferV1::Application::Representation
  command.response_class = Google::Apis::AdminDatatransferV1::Application
  command.params['applicationId'] = application_id unless application_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

#get_transfer(data_transfer_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::DataTransfer

Retrieves a data transfer request by its resource ID.

Parameters:

  • data_transfer_id (String) —

    ID of the resource to be retrieved. This is returned in the response from the insert method.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



156
157
158
159
160
161
162
163
164
165
 
# File 'generated/google/apis/admin_datatransfer_v1/service.rb', line 156

def get_transfer(data_transfer_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'transfers/{dataTransferId}', options)
  command.response_representation = Google::Apis::AdminDatatransferV1::DataTransfer::Representation
  command.response_class = Google::Apis::AdminDatatransferV1::DataTransfer
  command.params['dataTransferId'] = data_transfer_id unless data_transfer_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

#insert_transfer(data_transfer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::DataTransfer

Inserts a data transfer request.

Parameters:

  • data_transfer_object (Google::Apis::AdminDatatransferV1::DataTransfer) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



190
191
192
193
194
195
196
197
198
199
200
 
# File 'generated/google/apis/admin_datatransfer_v1/service.rb', line 190

def insert_transfer(data_transfer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'transfers', options)
  command.request_representation = Google::Apis::AdminDatatransferV1::DataTransfer::Representation
  command.request_object = data_transfer_object
  command.response_representation = Google::Apis::AdminDatatransferV1::DataTransfer::Representation
  command.response_class = Google::Apis::AdminDatatransferV1::DataTransfer
  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

#list_applications(customer_id: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::ApplicationsListResponse

Lists the applications available for data transfer for a customer.

Parameters:

  • customer_id (String) (defaults to: nil) —

    Immutable ID of the Google Apps account.

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return. Default is 100.

  • page_token (String) (defaults to: nil) —

    Token to specify next page in the list.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'generated/google/apis/admin_datatransfer_v1/service.rb', line 118

def list_applications(customer_id: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'applications', options)
  command.response_representation = Google::Apis::AdminDatatransferV1::ApplicationsListResponse::Representation
  command.response_class = Google::Apis::AdminDatatransferV1::ApplicationsListResponse
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.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

#list_transfers(customer_id: nil, max_results: nil, new_owner_user_id: nil, old_owner_user_id: nil, page_token: nil, status: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::DataTransfersListResponse

Lists the transfers for a customer by source user, destination user, or status.

Parameters:

  • customer_id (String) (defaults to: nil) —

    Immutable ID of the Google Apps account.

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return. Default is 100.

  • new_owner_user_id (String) (defaults to: nil) —

    Destination user's profile ID.

  • old_owner_user_id (String) (defaults to: nil) —

    Source user's profile ID.

  • page_token (String) (defaults to: nil) —

    Token to specify the next page in the list.

  • status (String) (defaults to: nil) —

    Status of the transfer.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

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

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'generated/google/apis/admin_datatransfer_v1/service.rb', line 236

def list_transfers(customer_id: nil, max_results: nil, new_owner_user_id: nil, old_owner_user_id: nil, page_token: nil, status: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'transfers', options)
  command.response_representation = Google::Apis::AdminDatatransferV1::DataTransfersListResponse::Representation
  command.response_class = Google::Apis::AdminDatatransferV1::DataTransfersListResponse
  command.query['customerId'] = customer_id unless customer_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['newOwnerUserId'] = new_owner_user_id unless new_owner_user_id.nil?
  command.query['oldOwnerUserId'] = old_owner_user_id unless old_owner_user_id.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['status'] = status unless status.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