App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Static Public Attributes | List of all members
google.appengine.ext.mapreduce.input_readers.BlobstoreLineInputReader Class Reference
Inheritance diagram for google.appengine.ext.mapreduce.input_readers.BlobstoreLineInputReader:
google.appengine.ext.mapreduce.input_readers.InputReader google.appengine.ext.mapreduce.json_util.JsonMixin

Public Member Functions

def __init__
 
def next
 
def to_json
 
def __str__
 
def from_json
 
def validate
 
def split_input
 
- Public Member Functions inherited from google.appengine.ext.mapreduce.input_readers.InputReader
def __iter__
 
def next
 
def from_json
 
def to_json
 
def split_input
 
def validate
 
- Public Member Functions inherited from google.appengine.ext.mapreduce.json_util.JsonMixin
def to_json_str
 
def from_json_str
 

Static Public Attributes

string BLOB_KEYS_PARAM = "blob_keys"
 
string INITIAL_POSITION_PARAM = "initial_position"
 
string END_POSITION_PARAM = "end_position"
 
string BLOB_KEY_PARAM = "blob_key"
 
- Static Public Attributes inherited from google.appengine.ext.mapreduce.input_readers.InputReader
 expand_parameters = False
 
string NAMESPACE_PARAM = "namespace"
 
string NAMESPACES_PARAM = "namespaces"
 

Detailed Description

Input reader for a newline delimited blob in Blobstore.

Constructor & Destructor Documentation

def google.appengine.ext.mapreduce.input_readers.BlobstoreLineInputReader.__init__ (   self,
  blob_key,
  start_position,
  end_position 
)
Initializes this instance with the given blob key and character range.

This BlobstoreInputReader will read from the first record starting after
strictly after start_position until the first record ending at or after
end_position (exclusive). As an exception, if start_position is 0, then
this InputReader starts reading at the first record.

Args:
  blob_key: the BlobKey that this input reader is processing.
  start_position: the position to start reading at.
  end_position: a position in the last record to read.

Member Function Documentation

def google.appengine.ext.mapreduce.input_readers.BlobstoreLineInputReader.__str__ (   self)
Returns the string representation of this BlobstoreLineInputReader.
def google.appengine.ext.mapreduce.input_readers.BlobstoreLineInputReader.from_json (   cls,
  json 
)
Instantiates an instance of this InputReader for the given shard spec.
def google.appengine.ext.mapreduce.input_readers.BlobstoreLineInputReader.next (   self)
Returns the next input from as an (offset, line) tuple.
def google.appengine.ext.mapreduce.input_readers.BlobstoreLineInputReader.split_input (   cls,
  mapper_spec 
)
Returns a list of shard_count input_spec_shards for input_spec.

Args:
  mapper_spec: The mapper specification to split from. Must contain
  'blob_keys' parameter with one or more blob keys.

Returns:
  A list of BlobstoreInputReaders corresponding to the specified shards.
def google.appengine.ext.mapreduce.input_readers.BlobstoreLineInputReader.to_json (   self)
Returns an json-compatible input shard spec for remaining inputs.
def google.appengine.ext.mapreduce.input_readers.BlobstoreLineInputReader.validate (   cls,
  mapper_spec 
)
Validates mapper spec and all mapper parameters.

Args:
  mapper_spec: The MapperSpec for this InputReader.

Raises:
  BadReaderParamsError: required parameters are missing or invalid.

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