Class: Google::Apis::AdminDatatransferV1::DataTransferService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::AdminDatatransferV1::DataTransferService
- Defined in:
- lib/google/apis/admin_datatransfer_v1/service.rb
Overview
Admin SDK API
Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.
Constant Summary collapse
- DEFAULT_ENDPOINT_TEMPLATE =
"https://admin.$UNIVERSE_DOMAIN$/"
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#get_application(application_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::Application
Retrieves information about an application for the given application ID.
-
#get_transfer(data_transfer_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::DataTransfer
Retrieves a data transfer request by its resource ID.
-
#initialize ⇒ DataTransferService
constructor
A new instance of DataTransferService.
-
#insert_transfer(data_transfer_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::DataTransfer
Inserts a data transfer request.
-
#list_applications(customer_id: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::ApplicationsListResponse
Lists the applications available for data transfer for a customer.
-
#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, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::DataTransfersListResponse
Lists the transfers for a customer by source user, destination user, or status.
Constructor Details
#initialize ⇒ DataTransferService
Returns a new instance of DataTransferService.
49 50 51 52 53 54 |
# File 'lib/google/apis/admin_datatransfer_v1/service.rb', line 49 def initialize super(DEFAULT_ENDPOINT_TEMPLATE, '', client_name: 'google-apis-admin_datatransfer_v1', client_version: Google::Apis::AdminDatatransferV1::GEM_VERSION) @batch_path = 'batch' 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.
42 43 44 |
# File 'lib/google/apis/admin_datatransfer_v1/service.rb', line 42 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.
47 48 49 |
# File 'lib/google/apis/admin_datatransfer_v1/service.rb', line 47 def quota_user @quota_user end |
Instance Method Details
#get_application(application_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::Application
Retrieves information about an application for the given application ID.
76 77 78 79 80 81 82 83 84 |
# File 'lib/google/apis/admin_datatransfer_v1/service.rb', line 76 def get_application(application_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'admin/datatransfer/v1/applications/{applicationId}', ) 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? execute_or_queue_command(command, &block) end |
#get_transfer(data_transfer_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::DataTransfer
Retrieves a data transfer request by its resource ID.
143 144 145 146 147 148 149 150 151 |
# File 'lib/google/apis/admin_datatransfer_v1/service.rb', line 143 def get_transfer(data_transfer_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'admin/datatransfer/v1/transfers/{dataTransferId}', ) 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? execute_or_queue_command(command, &block) end |
#insert_transfer(data_transfer_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::DataTransfer
Inserts a data transfer request. See the Transfer parameters reference for specific application requirements.
173 174 175 176 177 178 179 180 181 182 |
# File 'lib/google/apis/admin_datatransfer_v1/service.rb', line 173 def insert_transfer(data_transfer_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'admin/datatransfer/v1/transfers', ) 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? execute_or_queue_command(command, &block) end |
#list_applications(customer_id: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::ApplicationsListResponse
Lists the applications available for data transfer for a customer.
110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/google/apis/admin_datatransfer_v1/service.rb', line 110 def list_applications(customer_id: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'admin/datatransfer/v1/applications', ) 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? 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, options: nil) {|result, err| ... } ⇒ Google::Apis::AdminDatatransferV1::DataTransfersListResponse
Lists the transfers for a customer by source user, destination user, or status.
214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/google/apis/admin_datatransfer_v1/service.rb', line 214 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, options: nil, &block) command = make_simple_command(:get, 'admin/datatransfer/v1/transfers', ) 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? execute_or_queue_command(command, &block) end |