CommitResponse.php

<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/spanner/v1/commit_response.proto

namespace Google\Cloud\Spanner\V1;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\GPBUtil;
use Google\Protobuf\RepeatedField;

/**
 * The response for [Commit][google.spanner.v1.Spanner.Commit].
 *
 * Generated from protobuf message <code>google.spanner.v1.CommitResponse</code>
 */
class CommitResponse extends \Google\Protobuf\Internal\Message
{
    /**
     * The Cloud Spanner timestamp at which the transaction committed.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp commit_timestamp = 1;</code>
     */
    protected $commit_timestamp = null;
    /**
     * The statistics about this `Commit`. Not returned by default.
     * For more information, see
     * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
     *
     * Generated from protobuf field <code>.google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;</code>
     */
    protected $commit_stats = null;
    /**
     * If `TransactionOptions.isolation_level` is set to
     * `IsolationLevel.REPEATABLE_READ`, then the snapshot timestamp is the
     * timestamp at which all reads in the transaction ran. This timestamp is
     * never returned.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp snapshot_timestamp = 5;</code>
     */
    protected $snapshot_timestamp = null;
    /**
     * Optional. A cache update expresses a set of changes the client should
     * incorporate into its location cache. The client should discard the changes
     * if they are older than the data it already has. This data can be obtained
     * in response to requests that included a `RoutingHint` field, but may also
     * be obtained by explicit location-fetching RPCs which may be added in the
     * future.
     *
     * Generated from protobuf field <code>.google.spanner.v1.CacheUpdate cache_update = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $cache_update = null;
    /**
     * The isolation level used for the read-write transaction.
     *
     * Generated from protobuf field <code>.google.spanner.v1.TransactionOptions.IsolationLevel isolation_level = 7;</code>
     */
    protected $isolation_level = 0;
    /**
     * The read lock mode used for the read-write transaction.
     *
     * Generated from protobuf field <code>.google.spanner.v1.TransactionOptions.ReadWrite.ReadLockMode read_lock_mode = 8;</code>
     */
    protected $read_lock_mode = 0;
    protected $MultiplexedSessionRetry;

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type \Google\Protobuf\Timestamp $commit_timestamp
     *           The Cloud Spanner timestamp at which the transaction committed.
     *     @type \Google\Cloud\Spanner\V1\CommitResponse\CommitStats $commit_stats
     *           The statistics about this `Commit`. Not returned by default.
     *           For more information, see
     *           [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
     *     @type \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $precommit_token
     *           If specified, transaction has not committed yet.
     *           You must retry the commit with the new precommit token.
     *     @type \Google\Protobuf\Timestamp $snapshot_timestamp
     *           If `TransactionOptions.isolation_level` is set to
     *           `IsolationLevel.REPEATABLE_READ`, then the snapshot timestamp is the
     *           timestamp at which all reads in the transaction ran. This timestamp is
     *           never returned.
     *     @type \Google\Cloud\Spanner\V1\CacheUpdate $cache_update
     *           Optional. A cache update expresses a set of changes the client should
     *           incorporate into its location cache. The client should discard the changes
     *           if they are older than the data it already has. This data can be obtained
     *           in response to requests that included a `RoutingHint` field, but may also
     *           be obtained by explicit location-fetching RPCs which may be added in the
     *           future.
     *     @type int $isolation_level
     *           The isolation level used for the read-write transaction.
     *     @type int $read_lock_mode
     *           The read lock mode used for the read-write transaction.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Spanner\V1\CommitResponse::initOnce();
        parent::__construct($data);
    }

    /**
     * The Cloud Spanner timestamp at which the transaction committed.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp commit_timestamp = 1;</code>
     * @return \Google\Protobuf\Timestamp|null
     */
    public function getCommitTimestamp()
    {
        return $this->commit_timestamp;
    }

    public function hasCommitTimestamp()
    {
        return isset($this->commit_timestamp);
    }

    public function clearCommitTimestamp()
    {
        unset($this->commit_timestamp);
    }

    /**
     * The Cloud Spanner timestamp at which the transaction committed.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp commit_timestamp = 1;</code>
     * @param \Google\Protobuf\Timestamp $var
     * @return $this
     */
    public function setCommitTimestamp($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
        $this->commit_timestamp = $var;

        return $this;
    }

    /**
     * The statistics about this `Commit`. Not returned by default.
     * For more information, see
     * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
     *
     * Generated from protobuf field <code>.google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;</code>
     * @return \Google\Cloud\Spanner\V1\CommitResponse\CommitStats|null
     */
    public function getCommitStats()
    {
        return $this->commit_stats;
    }

    public function hasCommitStats()
    {
        return isset($this->commit_stats);
    }

    public function clearCommitStats()
    {
        unset($this->commit_stats);
    }

    /**
     * The statistics about this `Commit`. Not returned by default.
     * For more information, see
     * [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
     *
     * Generated from protobuf field <code>.google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;</code>
     * @param \Google\Cloud\Spanner\V1\CommitResponse\CommitStats $var
     * @return $this
     */
    public function setCommitStats($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\CommitResponse\CommitStats::class);
        $this->commit_stats = $var;

        return $this;
    }

    /**
     * If specified, transaction has not committed yet.
     * You must retry the commit with the new precommit token.
     *
     * Generated from protobuf field <code>.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 4;</code>
     * @return \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken|null
     */
    public function getPrecommitToken()
    {
        return $this->readOneof(4);
    }

    public function hasPrecommitToken()
    {
        return $this->hasOneof(4);
    }

    /**
     * If specified, transaction has not committed yet.
     * You must retry the commit with the new precommit token.
     *
     * Generated from protobuf field <code>.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 4;</code>
     * @param \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $var
     * @return $this
     */
    public function setPrecommitToken($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken::class);
        $this->writeOneof(4, $var);

        return $this;
    }

    /**
     * If `TransactionOptions.isolation_level` is set to
     * `IsolationLevel.REPEATABLE_READ`, then the snapshot timestamp is the
     * timestamp at which all reads in the transaction ran. This timestamp is
     * never returned.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp snapshot_timestamp = 5;</code>
     * @return \Google\Protobuf\Timestamp|null
     */
    public function getSnapshotTimestamp()
    {
        return $this->snapshot_timestamp;
    }

    public function hasSnapshotTimestamp()
    {
        return isset($this->snapshot_timestamp);
    }

    public function clearSnapshotTimestamp()
    {
        unset($this->snapshot_timestamp);
    }

    /**
     * If `TransactionOptions.isolation_level` is set to
     * `IsolationLevel.REPEATABLE_READ`, then the snapshot timestamp is the
     * timestamp at which all reads in the transaction ran. This timestamp is
     * never returned.
     *
     * Generated from protobuf field <code>.google.protobuf.Timestamp snapshot_timestamp = 5;</code>
     * @param \Google\Protobuf\Timestamp $var
     * @return $this
     */
    public function setSnapshotTimestamp($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
        $this->snapshot_timestamp = $var;

        return $this;
    }

    /**
     * Optional. A cache update expresses a set of changes the client should
     * incorporate into its location cache. The client should discard the changes
     * if they are older than the data it already has. This data can be obtained
     * in response to requests that included a `RoutingHint` field, but may also
     * be obtained by explicit location-fetching RPCs which may be added in the
     * future.
     *
     * Generated from protobuf field <code>.google.spanner.v1.CacheUpdate cache_update = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return \Google\Cloud\Spanner\V1\CacheUpdate|null
     */
    public function getCacheUpdate()
    {
        return $this->cache_update;
    }

    public function hasCacheUpdate()
    {
        return isset($this->cache_update);
    }

    public function clearCacheUpdate()
    {
        unset($this->cache_update);
    }

    /**
     * Optional. A cache update expresses a set of changes the client should
     * incorporate into its location cache. The client should discard the changes
     * if they are older than the data it already has. This data can be obtained
     * in response to requests that included a `RoutingHint` field, but may also
     * be obtained by explicit location-fetching RPCs which may be added in the
     * future.
     *
     * Generated from protobuf field <code>.google.spanner.v1.CacheUpdate cache_update = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param \Google\Cloud\Spanner\V1\CacheUpdate $var
     * @return $this
     */
    public function setCacheUpdate($var)
    {
        GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\CacheUpdate::class);
        $this->cache_update = $var;

        return $this;
    }

    /**
     * The isolation level used for the read-write transaction.
     *
     * Generated from protobuf field <code>.google.spanner.v1.TransactionOptions.IsolationLevel isolation_level = 7;</code>
     * @return int
     */
    public function getIsolationLevel()
    {
        return $this->isolation_level;
    }

    /**
     * The isolation level used for the read-write transaction.
     *
     * Generated from protobuf field <code>.google.spanner.v1.TransactionOptions.IsolationLevel isolation_level = 7;</code>
     * @param int $var
     * @return $this
     */
    public function setIsolationLevel($var)
    {
        GPBUtil::checkEnum($var, \Google\Cloud\Spanner\V1\TransactionOptions\IsolationLevel::class);
        $this->isolation_level = $var;

        return $this;
    }

    /**
     * The read lock mode used for the read-write transaction.
     *
     * Generated from protobuf field <code>.google.spanner.v1.TransactionOptions.ReadWrite.ReadLockMode read_lock_mode = 8;</code>
     * @return int
     */
    public function getReadLockMode()
    {
        return $this->read_lock_mode;
    }

    /**
     * The read lock mode used for the read-write transaction.
     *
     * Generated from protobuf field <code>.google.spanner.v1.TransactionOptions.ReadWrite.ReadLockMode read_lock_mode = 8;</code>
     * @param int $var
     * @return $this
     */
    public function setReadLockMode($var)
    {
        GPBUtil::checkEnum($var, \Google\Cloud\Spanner\V1\TransactionOptions\ReadWrite\ReadLockMode::class);
        $this->read_lock_mode = $var;

        return $this;
    }

    /**
     * @return string
     */
    public function getMultiplexedSessionRetry()
    {
        return $this->whichOneof("MultiplexedSessionRetry");
    }

}