App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Public Attributes | List of all members
google.appengine.tools.bulkloader.BulkTransporterApp Class Reference
Inheritance diagram for google.appengine.tools.bulkloader.BulkTransporterApp:
google.appengine.tools.bulkloader.BulkDownloaderApp google.appengine.tools.bulkloader.BulkMapperApp google.appengine.tools.bulkloader.BulkUploaderApp

Public Member Functions

def __init__
 
def RunPostAuthentication
 
def Run
 
def ReportStatus
 

Public Attributes

 app_id
 
 post_url
 
 kind
 
 batch_size
 
 input_generator_factory
 
 num_threads
 
 email
 
 passin
 
 dry_run
 
 throttle_class
 
 throttle
 
 progress_db
 
 progresstrackerthread_factory
 
 max_queue_size
 
 request_manager_factory
 
 datasourcethread_factory
 
 progress_queue_factory
 
 thread_pool_factory
 
 server
 
 secure
 
 error
 
 request_manager
 
 progress_thread
 
 data_source_thread
 

Detailed Description

Class to wrap bulk transport application functionality.

Constructor & Destructor Documentation

def google.appengine.tools.bulkloader.BulkTransporterApp.__init__ (   self,
  arg_dict,
  input_generator_factory,
  throttle,
  progress_db,
  progresstrackerthread_factory,
  max_queue_size = DEFAULT_QUEUE_SIZE,
  request_manager_factory = RequestManager,
  datasourcethread_factory = DataSourceThread,
  progress_queue_factory = Queue.Queue,
  thread_pool_factory = adaptive_thread_pool.AdaptiveThreadPool,
  server = None 
)
Instantiate a BulkTransporterApp.

Uploads or downloads data to or from application using HTTP requests.
When run, the class will spin up a number of threads to read entities
from the data source, pass those to a number of worker threads
for sending to the application, and track all of the progress in a
small database in case an error or pause/termination requires a
restart/resumption of the upload process.

Args:
  arg_dict: Dictionary of command line options.
  input_generator_factory: A factory that creates a WorkItem generator.
  throttle: A Throttle instance.
  progress_db: The database to use for replaying/recording progress.
  progresstrackerthread_factory: Used for dependency injection.
  max_queue_size: Maximum size of the queues before they should block.
  request_manager_factory: Used for dependency injection.
  datasourcethread_factory: Used for dependency injection.
  progress_queue_factory: Used for dependency injection.
  thread_pool_factory: Used for dependency injection.
  server: An existing AbstractRpcServer to reuse.

Member Function Documentation

def google.appengine.tools.bulkloader.BulkTransporterApp.ReportStatus (   self)
Display a message reporting the final status of the transfer.
def google.appengine.tools.bulkloader.BulkTransporterApp.Run (   self)
Perform the work of the BulkTransporterApp.

Raises:
  AuthenticationError: If authentication is required and fails.

Returns:
  Error code suitable for sys.exit, e.g. 0 on success, 1 on failure.
def google.appengine.tools.bulkloader.BulkTransporterApp.RunPostAuthentication (   self)
Method that gets called after authentication.

The documentation for this class was generated from the following file: