📄 Source: WriteResponse.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Firestore;
class WriteResponse extends \Google\Collection
{
protected $collection_key = 'writeResults';
/**
* The time at which the commit occurred. Any read with an equal or greater
* `read_time` is guaranteed to see the effects of the write.
*
* @var string
*/
public $commitTime;
/**
* The ID of the stream. Only set on the first message, when a new stream was
* created.
*
* @var string
*/
public $streamId;
/**
* A token that represents the position of this response in the stream. This
* can be used by a client to resume the stream at this point. This field is
* always set.
*
* @var string
*/
public $streamToken;
protected $writeResultsType = WriteResult::class;
protected $writeResultsDataType = 'array';
/**
* The time at which the commit occurred. Any read with an equal or greater
* `read_time` is guaranteed to see the effects of the write.
*
* @param string $commitTime
*/
public function setCommitTime($commitTime)
{
$this->commitTime = $commitTime;
}
/**
* @return string
*/
public function getCommitTime()
{
return $this->commitTime;
}
/**
* The ID of the stream. Only set on the first message, when a new stream was
* created.
*
* @param string $streamId
*/
public function setStreamId($streamId)
{
$this->streamId = $streamId;
}
/**
* @return string
*/
public function getStreamId()
{
return $this->streamId;
}
/**
* A token that represents the position of this response in the stream. This
* can be used by a client to resume the stream at this point. This field is
* always set.
*
* @param string $streamToken
*/
public function setStreamToken($streamToken)
{
$this->streamToken = $streamToken;
}
/**
* @return string
*/
public function getStreamToken()
{
return $this->streamToken;
}
/**
* The result of applying the writes. This i-th write result corresponds to
* the i-th write in the request.
*
* @param WriteResult[] $writeResults
*/
public function setWriteResults($writeResults)
{
$this->writeResults = $writeResults;
}
/**
* @return WriteResult[]
*/
public function getWriteResults()
{
return $this->writeResults;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(WriteResponse::class, 'Google_Service_Firestore_WriteResponse');
← Back