App Engine PHP SDK  v1 rev.445
The PHP runtime is available as an experimental Preview feature.
Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
google\net\ProtocolMessage Class Reference
Inheritance diagram for google\net\ProtocolMessage:
google\appengine\AppIdentityServiceError google\appengine\AppOverride google\appengine\base\BoolProto google\appengine\base\BytesProto google\appengine\base\DoubleProto google\appengine\base\Integer32Proto google\appengine\base\Integer64Proto google\appengine\base\StringProto google\appengine\base\VoidProto google\appengine\BlobstoreServiceError google\appengine\CheckOAuthSignatureRequest google\appengine\CheckOAuthSignatureResponse google\appengine\CloneBlobRequest google\appengine\CloneBlobResponse google\appengine\CompositeImageOptions google\appengine\CreateEncodedGoogleStorageKeyRequest google\appengine\CreateEncodedGoogleStorageKeyResponse google\appengine\CreateLoginURLRequest google\appengine\CreateLoginURLResponse google\appengine\CreateLogoutURLRequest google\appengine\CreateLogoutURLResponse google\appengine\CreateUploadURLRequest google\appengine\CreateUploadURLResponse google\appengine\datastore\v4\AllocateIdsRequest google\appengine\datastore\v4\AllocateIdsResponse google\appengine\datastore\v4\BeginTransactionRequest google\appengine\datastore\v4\BeginTransactionResponse google\appengine\datastore\v4\CommitRequest google\appengine\datastore\v4\CommitResponse google\appengine\datastore\v4\CompositeFilter google\appengine\datastore\v4\ContinueQueryRequest google\appengine\datastore\v4\ContinueQueryResponse google\appengine\datastore\v4\DeprecatedMutation google\appengine\datastore\v4\DeprecatedMutationResult google\appengine\datastore\v4\Entity google\appengine\datastore\v4\EntityResult google\appengine\datastore\v4\Error google\appengine\datastore\v4\Filter google\appengine\datastore\v4\GqlQuery google\appengine\datastore\v4\GqlQueryArg google\appengine\datastore\v4\Key google\appengine\datastore\v4\Key\PathElement google\appengine\datastore\v4\KindExpression google\appengine\datastore\v4\LookupRequest google\appengine\datastore\v4\LookupResponse google\appengine\datastore\v4\Mutation google\appengine\datastore\v4\MutationResult google\appengine\datastore\v4\PartitionId google\appengine\datastore\v4\Property google\appengine\datastore\v4\PropertyExpression google\appengine\datastore\v4\PropertyFilter google\appengine\datastore\v4\PropertyOrder google\appengine\datastore\v4\PropertyReference google\appengine\datastore\v4\Query google\appengine\datastore\v4\QueryResultBatch google\appengine\datastore\v4\ReadOptions google\appengine\datastore\v4\RollbackRequest google\appengine\datastore\v4\RollbackResponse google\appengine\datastore\v4\RunQueryRequest google\appengine\datastore\v4\RunQueryResponse google\appengine\datastore\v4\Value google\appengine\datastore\v4\WriteRequest google\appengine\DecodeBlobKeyRequest google\appengine\DecodeBlobKeyResponse google\appengine\DeleteBlobRequest google\appengine\ext\remote_api\ApplicationError google\appengine\ext\remote_api\Request google\appengine\ext\remote_api\Response google\appengine\ext\remote_api\RpcError google\appengine\ext\remote_api\TransactionQueryResult google\appengine\ext\remote_api\TransactionRequest google\appengine\ext\remote_api\TransactionRequest\Precondition google\appengine\FetchDataRequest google\appengine\FetchDataResponse google\appengine\files\AppendRequest google\appengine\files\AppendResponse google\appengine\files\CloseRequest google\appengine\files\CloseResponse google\appengine\files\CreateRequest google\appengine\files\CreateRequest\Parameter google\appengine\files\CreateResponse google\appengine\files\DeleteRequest google\appengine\files\DeleteResponse google\appengine\files\FileContentType google\appengine\files\FileServiceErrors google\appengine\files\FileStat google\appengine\files\FinalizeRequest google\appengine\files\FinalizeResponse google\appengine\files\GetCapabilitiesRequest google\appengine\files\GetCapabilitiesResponse google\appengine\files\GetDefaultGsBucketNameRequest google\appengine\files\GetDefaultGsBucketNameResponse google\appengine\files\GetShuffleStatusRequest google\appengine\files\GetShuffleStatusResponse google\appengine\files\KeyValue google\appengine\files\KeyValues google\appengine\files\ListDirRequest google\appengine\files\ListDirResponse google\appengine\files\OpenRequest google\appengine\files\OpenResponse google\appengine\files\ReadKeyValueRequest google\appengine\files\ReadKeyValueResponse google\appengine\files\ReadKeyValueResponse\KeyValue google\appengine\files\ReadRequest google\appengine\files\ReadResponse google\appengine\files\ShuffleEnums google\appengine\files\ShuffleInputSpecification google\appengine\files\ShuffleOutputSpecification google\appengine\files\ShuffleRequest google\appengine\files\ShuffleRequest\Callback google\appengine\files\ShuffleResponse google\appengine\files\StatRequest google\appengine\files\StatResponse google\appengine\FlushRequest google\appengine\GetAccessTokenRequest google\appengine\GetAccessTokenResponse google\appengine\GetDefaultGcsBucketNameRequest google\appengine\GetDefaultGcsBucketNameResponse google\appengine\GetDefaultVersionRequest google\appengine\GetDefaultVersionResponse google\appengine\GetHostnameRequest google\appengine\GetHostnameResponse google\appengine\GetModulesRequest google\appengine\GetModulesResponse google\appengine\GetNumInstancesRequest google\appengine\GetNumInstancesResponse google\appengine\GetOAuthUserRequest google\appengine\GetOAuthUserResponse google\appengine\GetPublicCertificateForAppRequest google\appengine\GetPublicCertificateForAppResponse google\appengine\GetServiceAccountNameRequest google\appengine\GetServiceAccountNameResponse google\appengine\GetVersionsRequest google\appengine\GetVersionsResponse google\appengine\ImageData google\appengine\ImagesCanvas google\appengine\ImagesCompositeRequest google\appengine\ImagesCompositeResponse google\appengine\ImagesDeleteUrlBaseRequest google\appengine\ImagesDeleteUrlBaseResponse google\appengine\ImagesGetUrlBaseRequest google\appengine\ImagesGetUrlBaseResponse google\appengine\ImagesHistogram google\appengine\ImagesHistogramRequest google\appengine\ImagesHistogramResponse google\appengine\ImagesServiceError google\appengine\ImagesServiceTransform google\appengine\ImagesTransformRequest google\appengine\ImagesTransformResponse google\appengine\InputSettings google\appengine\LogLine google\appengine\LogModuleVersion google\appengine\LogOffset google\appengine\LogReadRequest google\appengine\LogReadResponse google\appengine\LogServiceError google\appengine\LogUsageRecord google\appengine\LogUsageRequest google\appengine\LogUsageResponse google\appengine\MailAttachment google\appengine\MailHeader google\appengine\MailMessage google\appengine\MailServiceError google\appengine\MemcacheBatchIncrementRequest google\appengine\MemcacheBatchIncrementResponse google\appengine\MemcacheDeleteRequest google\appengine\MemcacheDeleteRequest\Item google\appengine\MemcacheDeleteResponse google\appengine\MemcacheFlushRequest google\appengine\MemcacheFlushResponse google\appengine\MemcacheGetRequest google\appengine\MemcacheGetResponse google\appengine\MemcacheGetResponse\Item google\appengine\MemcacheGrabTailRequest google\appengine\MemcacheGrabTailResponse google\appengine\MemcacheGrabTailResponse\Item google\appengine\MemcacheIncrementRequest google\appengine\MemcacheIncrementResponse google\appengine\MemcacheServiceError google\appengine\MemcacheSetRequest google\appengine\MemcacheSetRequest\Item google\appengine\MemcacheSetResponse google\appengine\MemcacheStatsRequest google\appengine\MemcacheStatsResponse google\appengine\MergedNamespaceStats google\appengine\ModulesServiceError google\appengine\OutputSettings google\appengine\PublicCertificate google\appengine\RequestLog google\appengine\SetNumInstancesRequest google\appengine\SetNumInstancesResponse google\appengine\SetStatusRequest google\appengine\SignForAppRequest google\appengine\SignForAppResponse google\appengine\StartModuleRequest google\appengine\StartModuleResponse google\appengine\StopModuleRequest google\appengine\StopModuleResponse google\appengine\TaskPayload google\appengine\TaskQueueAcl google\appengine\TaskQueueAddRequest google\appengine\TaskQueueAddRequest\CronTimetable google\appengine\TaskQueueAddRequest\Header google\appengine\TaskQueueAddResponse google\appengine\TaskQueueBulkAddRequest google\appengine\TaskQueueBulkAddResponse google\appengine\TaskQueueBulkAddResponse\TaskResult google\appengine\TaskQueueDeleteGroupRequest google\appengine\TaskQueueDeleteGroupResponse google\appengine\TaskQueueDeleteQueueRequest google\appengine\TaskQueueDeleteQueueResponse google\appengine\TaskQueueDeleteRequest google\appengine\TaskQueueDeleteResponse google\appengine\TaskQueueFetchQueuesRequest google\appengine\TaskQueueFetchQueuesResponse google\appengine\TaskQueueFetchQueuesResponse\Queue google\appengine\TaskQueueFetchQueueStatsRequest google\appengine\TaskQueueFetchQueueStatsResponse google\appengine\TaskQueueFetchQueueStatsResponse\QueueStats google\appengine\TaskQueueFetchTaskRequest google\appengine\TaskQueueFetchTaskResponse google\appengine\TaskQueueForceRunRequest google\appengine\TaskQueueForceRunResponse google\appengine\TaskQueueHttpHeader google\appengine\TaskQueueMode google\appengine\TaskQueueModifyTaskLeaseRequest google\appengine\TaskQueueModifyTaskLeaseResponse google\appengine\TaskQueuePauseQueueRequest google\appengine\TaskQueuePauseQueueResponse google\appengine\TaskQueuePurgeQueueRequest google\appengine\TaskQueuePurgeQueueResponse google\appengine\TaskQueueQueryAndOwnTasksRequest google\appengine\TaskQueueQueryAndOwnTasksResponse google\appengine\TaskQueueQueryAndOwnTasksResponse\Task google\appengine\TaskQueueQueryTasksRequest google\appengine\TaskQueueQueryTasksResponse google\appengine\TaskQueueQueryTasksResponse\Task google\appengine\TaskQueueQueryTasksResponse\Task\CronTimetable google\appengine\TaskQueueQueryTasksResponse\Task\Header google\appengine\TaskQueueQueryTasksResponse\Task\RunLog google\appengine\TaskQueueRetryParameters google\appengine\TaskQueueScannerQueueInfo google\appengine\TaskQueueServiceError google\appengine\TaskQueueUpdateQueueRequest google\appengine\TaskQueueUpdateQueueResponse google\appengine\TaskQueueUpdateStorageLimitRequest google\appengine\TaskQueueUpdateStorageLimitResponse google\appengine\Transform google\appengine\URLFetchRequest google\appengine\URLFetchRequest\Header google\appengine\URLFetchResponse google\appengine\URLFetchResponse\Header google\appengine\URLFetchServiceError google\appengine\UserAppLogGroup google\appengine\UserAppLogLine google\appengine\UserServiceError google\appengine_datastore_v3\Action google\appengine_datastore_v3\AddActionsRequest google\appengine_datastore_v3\AddActionsResponse google\appengine_datastore_v3\AllocateIdsRequest google\appengine_datastore_v3\AllocateIdsResponse google\appengine_datastore_v3\BeginTransactionRequest google\appengine_datastore_v3\CommitResponse google\appengine_datastore_v3\CommitResponse\Version google\appengine_datastore_v3\CompiledCursor google\appengine_datastore_v3\CompiledCursor\Position google\appengine_datastore_v3\CompiledCursor\Position\IndexValue google\appengine_datastore_v3\CompiledQuery google\appengine_datastore_v3\CompiledQuery\EntityFilter google\appengine_datastore_v3\CompiledQuery\MergeJoinScan google\appengine_datastore_v3\CompiledQuery\PrimaryScan google\appengine_datastore_v3\CompositeIndices google\appengine_datastore_v3\Cost google\appengine_datastore_v3\Cost\CommitCost google\appengine_datastore_v3\Cursor google\appengine_datastore_v3\DeleteRequest google\appengine_datastore_v3\DeleteResponse google\appengine_datastore_v3\Error google\appengine_datastore_v3\GetRequest google\appengine_datastore_v3\GetResponse google\appengine_datastore_v3\GetResponse\Entity google\appengine_datastore_v3\InternalHeader google\appengine_datastore_v3\NextRequest google\appengine_datastore_v3\PutRequest google\appengine_datastore_v3\PutResponse google\appengine_datastore_v3\Query google\appengine_datastore_v3\Query\Filter google\appengine_datastore_v3\Query\Order google\appengine_datastore_v3\QueryResult google\appengine_datastore_v3\TouchRequest google\appengine_datastore_v3\TouchResponse google\appengine_datastore_v3\Transaction storage_onestore_v3\CompositeIndex storage_onestore_v3\CompositeProperty storage_onestore_v3\EntityProto storage_onestore_v3\Index storage_onestore_v3\Index\Property storage_onestore_v3\IndexPosition storage_onestore_v3\IndexPostfix storage_onestore_v3\IndexPostfix\IndexValue storage_onestore_v3\Path storage_onestore_v3\Path\Element storage_onestore_v3\Property storage_onestore_v3\PropertyValue storage_onestore_v3\PropertyValue\PointValue storage_onestore_v3\PropertyValue\ReferenceValue storage_onestore_v3\PropertyValue\ReferenceValue\PathElement storage_onestore_v3\PropertyValue\UserValue storage_onestore_v3\Reference storage_onestore_v3\Snapshot storage_onestore_v3\User

Public Member Functions

 serializeToString ()
 
 serializePartialToString ()
 
 parseFromString ($s)
 
 parsePartialFromString ($s)
 
 mergeFromString ($s)
 
 mergePartialFromString ($s)
 
 copyFrom ($pb)
 
 isInitialized ()
 
 checkInitialized ()
 
 tryMerge ($decoder)
 
 outputPartial ($encoder)
 
 byteSizePartial ()
 
 clear ()
 
 mergeFrom ($proto)
 
 equals ($proto)
 
 shortDebugString ()
 

Protected Member Functions

 checkProtoArray ($arr)
 

Static Protected Member Functions

static debugFormatString ($value)
 
static debugFormatDouble ($value)
 
static lengthVarUint64 ($value)
 
static lengthVarInt64 ($value)
 
static lengthVarInt32 ($value)
 
static lengthString ($len)
 
static debugFormatBool ($b)
 
static debugFormatFloat ($value)
 
static debugFormatFixed32 ($value)
 
static debugFormatFixed64 ($value)
 
static debugFormatInt32 ($value)
 
static debugFormatInt64 ($value)
 
static integerEquals ($a, $b)
 

Detailed Description

The parent class of all protocol buffers. Subclasses are automatically generated by php protocol buffer compiler. Encoding methods can raise ProtocolBufferEncodeError if a value for an integer or long field is too large, or if any required field is not set. Decoding methods can raise ProtocolBufferDecodeError if they couldn't decode correctly, or the decoded message doesn't have all required fields.

Member Function Documentation

google\net\ProtocolMessage::copyFrom (   $pb)

Copies data from another protocol buffer into this protocol buffer.

Parameters
mixed$pbThe protocol buffer to copy from.
static google\net\ProtocolMessage::debugFormatString (   $value)
staticprotected

Format protocol buffer as a text string for debugging.

static google\net\ProtocolMessage::integerEquals (   $a,
  $b 
)
staticprotected

Checks if two integers are equal.

Parameters
int$aThe first integer to compare.
int$bThe second integer to compare.
Returns
bool True if the intergers are equal, false otherwise.
google\net\ProtocolMessage::isInitialized ( )

Checks if this protocol message has all of the requried fields initialized.

Returns
bool true if all fields are initialized, false otherwise.
google\net\ProtocolMessage::mergeFromString (   $s)

Like parseFromString, fills the message with a protocol buffer parsed from the given input string.

Parameters
string$sThe string containing a serialized protocol buffer.
Exceptions
ProtocolBufferDecodeErrorIf the result message is not correctly initialized.
google\net\ProtocolMessage::mergePartialFromString (   $s)

Like parsePartialFromString, fills the message with a protocol buffer parsed from the given input string. Will not fail if the resulting protocol buffer is not fully initialized.

Parameters
string$sThe string containing a serialized protocol buffer.
google\net\ProtocolMessage::parseFromString (   $s)

Fills the message with a protocol buffer parsed from the given input string.

Parameters
string$sThe string containing a serialized protocol buffer.
Exceptions
ProtocolBufferDecodeErrorIf the result message is not correctly initialized.
google\net\ProtocolMessage::parsePartialFromString (   $s)

Fills the message with a protocol buffer parsed from the given input string. Will not fail if the resulting protocol buffer is not fully initialized.

Parameters
string$sThe string containing a serialized protocol buffer.
google\net\ProtocolMessage::serializePartialToString ( )

Serializes a protocol buffer that might not have all of the required fields set.

Returns
string The serialized protocol buffer.
google\net\ProtocolMessage::serializeToString ( )

Serializes the message and return it as a string.

Exceptions
ProtocolBufferEncodeErrorIf the protocol buffer is not initialized.
Returns
string The serialized protocol buffer.

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