Initial commit: Complete WooCommerce Smart Google Pricing plugin with vendor dependencies

This commit is contained in:
2025-12-23 07:48:45 +01:00
commit 9b66109ca1
32472 changed files with 4065017 additions and 0 deletions

View File

@@ -0,0 +1,116 @@
<?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 Aggregation extends \Google\Model
{
/**
* Optional. Optional name of the field to store the result of the aggregation
* into. If not provided, Firestore will pick a default name following the
* format `field_`. For example: ``` AGGREGATE COUNT_UP_TO(1) AS
* count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT(*)
* OVER ( ... ); ``` becomes: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1,
* COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS
* field_2 OVER ( ... ); ``` Requires: * Must be unique across all aggregation
* aliases. * Conform to document field name limitations.
*
* @var string
*/
public $alias;
protected $avgType = Avg::class;
protected $avgDataType = '';
protected $countType = Count::class;
protected $countDataType = '';
protected $sumType = Sum::class;
protected $sumDataType = '';
/**
* Optional. Optional name of the field to store the result of the aggregation
* into. If not provided, Firestore will pick a default name following the
* format `field_`. For example: ``` AGGREGATE COUNT_UP_TO(1) AS
* count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT(*)
* OVER ( ... ); ``` becomes: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1,
* COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS
* field_2 OVER ( ... ); ``` Requires: * Must be unique across all aggregation
* aliases. * Conform to document field name limitations.
*
* @param string $alias
*/
public function setAlias($alias)
{
$this->alias = $alias;
}
/**
* @return string
*/
public function getAlias()
{
return $this->alias;
}
/**
* Average aggregator.
*
* @param Avg $avg
*/
public function setAvg(Avg $avg)
{
$this->avg = $avg;
}
/**
* @return Avg
*/
public function getAvg()
{
return $this->avg;
}
/**
* Count aggregator.
*
* @param Count $count
*/
public function setCount(Count $count)
{
$this->count = $count;
}
/**
* @return Count
*/
public function getCount()
{
return $this->count;
}
/**
* Sum aggregator.
*
* @param Sum $sum
*/
public function setSum(Sum $sum)
{
$this->sum = $sum;
}
/**
* @return Sum
*/
public function getSum()
{
return $this->sum;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Aggregation::class, 'Google_Service_Firestore_Aggregation');

View File

@@ -0,0 +1,46 @@
<?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 AggregationResult extends \Google\Model
{
protected $aggregateFieldsType = Value::class;
protected $aggregateFieldsDataType = 'map';
/**
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`. The
* key is the alias assigned to the aggregation function on input and the size
* of this map equals the number of aggregation functions in the query.
*
* @param Value[] $aggregateFields
*/
public function setAggregateFields($aggregateFields)
{
$this->aggregateFields = $aggregateFields;
}
/**
* @return Value[]
*/
public function getAggregateFields()
{
return $this->aggregateFields;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AggregationResult::class, 'Google_Service_Firestore_AggregationResult');

View File

@@ -0,0 +1,45 @@
<?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 ArrayValue extends \Google\Collection
{
protected $collection_key = 'values';
protected $valuesType = Value::class;
protected $valuesDataType = 'array';
/**
* Values in the array.
*
* @param Value[] $values
*/
public function setValues($values)
{
$this->values = $values;
}
/**
* @return Value[]
*/
public function getValues()
{
return $this->values;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ArrayValue::class, 'Google_Service_Firestore_ArrayValue');

View File

@@ -0,0 +1,44 @@
<?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 Avg extends \Google\Model
{
protected $fieldType = FieldReference::class;
protected $fieldDataType = '';
/**
* The field to aggregate on.
*
* @param FieldReference $field
*/
public function setField(FieldReference $field)
{
$this->field = $field;
}
/**
* @return FieldReference
*/
public function getField()
{
return $this->field;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Avg::class, 'Google_Service_Firestore_Avg');

View File

@@ -0,0 +1,145 @@
<?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 BatchGetDocumentsRequest extends \Google\Collection
{
protected $collection_key = 'documents';
/**
* The names of the documents to retrieve. In the format:
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
* The request will fail if any of the document is not a child resource of the
* given `database`. Duplicate names will be elided.
*
* @var string[]
*/
public $documents;
protected $maskType = DocumentMask::class;
protected $maskDataType = '';
protected $newTransactionType = TransactionOptions::class;
protected $newTransactionDataType = '';
/**
* Reads documents as they were at the given time. This must be a microsecond
* precision timestamp within the past one hour, or if Point-in-Time Recovery
* is enabled, can additionally be a whole minute timestamp within the past 7
* days.
*
* @var string
*/
public $readTime;
/**
* Reads documents in a transaction.
*
* @var string
*/
public $transaction;
/**
* The names of the documents to retrieve. In the format:
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
* The request will fail if any of the document is not a child resource of the
* given `database`. Duplicate names will be elided.
*
* @param string[] $documents
*/
public function setDocuments($documents)
{
$this->documents = $documents;
}
/**
* @return string[]
*/
public function getDocuments()
{
return $this->documents;
}
/**
* The fields to return. If not set, returns all fields. If a document has a
* field that is not present in this mask, that field will not be returned in
* the response.
*
* @param DocumentMask $mask
*/
public function setMask(DocumentMask $mask)
{
$this->mask = $mask;
}
/**
* @return DocumentMask
*/
public function getMask()
{
return $this->mask;
}
/**
* Starts a new transaction and reads the documents. Defaults to a read-only
* transaction. The new transaction ID will be returned as the first response
* in the stream.
*
* @param TransactionOptions $newTransaction
*/
public function setNewTransaction(TransactionOptions $newTransaction)
{
$this->newTransaction = $newTransaction;
}
/**
* @return TransactionOptions
*/
public function getNewTransaction()
{
return $this->newTransaction;
}
/**
* Reads documents as they were at the given time. This must be a microsecond
* precision timestamp within the past one hour, or if Point-in-Time Recovery
* is enabled, can additionally be a whole minute timestamp within the past 7
* days.
*
* @param string $readTime
*/
public function setReadTime($readTime)
{
$this->readTime = $readTime;
}
/**
* @return string
*/
public function getReadTime()
{
return $this->readTime;
}
/**
* Reads documents in a transaction.
*
* @param string $transaction
*/
public function setTransaction($transaction)
{
$this->transaction = $transaction;
}
/**
* @return string
*/
public function getTransaction()
{
return $this->transaction;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchGetDocumentsRequest::class, 'Google_Service_Firestore_BatchGetDocumentsRequest');

View File

@@ -0,0 +1,120 @@
<?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 BatchGetDocumentsResponse extends \Google\Model
{
protected $foundType = Document::class;
protected $foundDataType = '';
/**
* A document name that was requested but does not exist. In the format:
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*
* @var string
*/
public $missing;
/**
* The time at which the document was read. This may be monotically
* increasing, in this case the previous documents in the result stream are
* guaranteed not to have changed between their read_time and this one.
*
* @var string
*/
public $readTime;
/**
* The transaction that was started as part of this request. Will only be set
* in the first response, and only if BatchGetDocumentsRequest.new_transaction
* was set in the request.
*
* @var string
*/
public $transaction;
/**
* A document that was requested.
*
* @param Document $found
*/
public function setFound(Document $found)
{
$this->found = $found;
}
/**
* @return Document
*/
public function getFound()
{
return $this->found;
}
/**
* A document name that was requested but does not exist. In the format:
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*
* @param string $missing
*/
public function setMissing($missing)
{
$this->missing = $missing;
}
/**
* @return string
*/
public function getMissing()
{
return $this->missing;
}
/**
* The time at which the document was read. This may be monotically
* increasing, in this case the previous documents in the result stream are
* guaranteed not to have changed between their read_time and this one.
*
* @param string $readTime
*/
public function setReadTime($readTime)
{
$this->readTime = $readTime;
}
/**
* @return string
*/
public function getReadTime()
{
return $this->readTime;
}
/**
* The transaction that was started as part of this request. Will only be set
* in the first response, and only if BatchGetDocumentsRequest.new_transaction
* was set in the request.
*
* @param string $transaction
*/
public function setTransaction($transaction)
{
$this->transaction = $transaction;
}
/**
* @return string
*/
public function getTransaction()
{
return $this->transaction;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchGetDocumentsResponse::class, 'Google_Service_Firestore_BatchGetDocumentsResponse');

View File

@@ -0,0 +1,69 @@
<?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 BatchWriteRequest extends \Google\Collection
{
protected $collection_key = 'writes';
/**
* Labels associated with this batch write.
*
* @var string[]
*/
public $labels;
protected $writesType = Write::class;
protected $writesDataType = 'array';
/**
* Labels associated with this batch write.
*
* @param string[] $labels
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return string[]
*/
public function getLabels()
{
return $this->labels;
}
/**
* The writes to apply. Method does not apply writes atomically and does not
* guarantee ordering. Each write succeeds or fails independently. You cannot
* write to the same document more than once per request.
*
* @param Write[] $writes
*/
public function setWrites($writes)
{
$this->writes = $writes;
}
/**
* @return Write[]
*/
public function getWrites()
{
return $this->writes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchWriteRequest::class, 'Google_Service_Firestore_BatchWriteRequest');

View File

@@ -0,0 +1,65 @@
<?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 BatchWriteResponse extends \Google\Collection
{
protected $collection_key = 'writeResults';
protected $statusType = Status::class;
protected $statusDataType = 'array';
protected $writeResultsType = WriteResult::class;
protected $writeResultsDataType = 'array';
/**
* The status of applying the writes. This i-th write status corresponds to
* the i-th write in the request.
*
* @param Status[] $status
*/
public function setStatus($status)
{
$this->status = $status;
}
/**
* @return Status[]
*/
public function getStatus()
{
return $this->status;
}
/**
* 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(BatchWriteResponse::class, 'Google_Service_Firestore_BatchWriteResponse');

View File

@@ -0,0 +1,44 @@
<?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 BeginTransactionRequest extends \Google\Model
{
protected $optionsType = TransactionOptions::class;
protected $optionsDataType = '';
/**
* The options for the transaction. Defaults to a read-write transaction.
*
* @param TransactionOptions $options
*/
public function setOptions(TransactionOptions $options)
{
$this->options = $options;
}
/**
* @return TransactionOptions
*/
public function getOptions()
{
return $this->options;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BeginTransactionRequest::class, 'Google_Service_Firestore_BeginTransactionRequest');

View File

@@ -0,0 +1,48 @@
<?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 BeginTransactionResponse extends \Google\Model
{
/**
* The transaction that was started.
*
* @var string
*/
public $transaction;
/**
* The transaction that was started.
*
* @param string $transaction
*/
public function setTransaction($transaction)
{
$this->transaction = $transaction;
}
/**
* @return string
*/
public function getTransaction()
{
return $this->transaction;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BeginTransactionResponse::class, 'Google_Service_Firestore_BeginTransactionResponse');

View File

@@ -0,0 +1,74 @@
<?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 BitSequence extends \Google\Model
{
/**
* The bytes that encode the bit sequence. May have a length of zero.
*
* @var string
*/
public $bitmap;
/**
* The number of bits of the last byte in `bitmap` to ignore as "padding". If
* the length of `bitmap` is zero, then this value must be `0`. Otherwise,
* this value must be between 0 and 7, inclusive.
*
* @var int
*/
public $padding;
/**
* The bytes that encode the bit sequence. May have a length of zero.
*
* @param string $bitmap
*/
public function setBitmap($bitmap)
{
$this->bitmap = $bitmap;
}
/**
* @return string
*/
public function getBitmap()
{
return $this->bitmap;
}
/**
* The number of bits of the last byte in `bitmap` to ignore as "padding". If
* the length of `bitmap` is zero, then this value must be `0`. Otherwise,
* this value must be between 0 and 7, inclusive.
*
* @param int $padding
*/
public function setPadding($padding)
{
$this->padding = $padding;
}
/**
* @return int
*/
public function getPadding()
{
return $this->padding;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BitSequence::class, 'Google_Service_Firestore_BitSequence');

View File

@@ -0,0 +1,66 @@
<?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 BloomFilter extends \Google\Model
{
protected $bitsType = BitSequence::class;
protected $bitsDataType = '';
/**
* The number of hashes used by the algorithm.
*
* @var int
*/
public $hashCount;
/**
* The bloom filter data.
*
* @param BitSequence $bits
*/
public function setBits(BitSequence $bits)
{
$this->bits = $bits;
}
/**
* @return BitSequence
*/
public function getBits()
{
return $this->bits;
}
/**
* The number of hashes used by the algorithm.
*
* @param int $hashCount
*/
public function setHashCount($hashCount)
{
$this->hashCount = $hashCount;
}
/**
* @return int
*/
public function getHashCount()
{
return $this->hashCount;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BloomFilter::class, 'Google_Service_Firestore_BloomFilter');

View File

@@ -0,0 +1,74 @@
<?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 CollectionSelector extends \Google\Model
{
/**
* When false, selects only collections that are immediate children of the
* `parent` specified in the containing `RunQueryRequest`. When true, selects
* all descendant collections.
*
* @var bool
*/
public $allDescendants;
/**
* The collection ID. When set, selects only collections with this ID.
*
* @var string
*/
public $collectionId;
/**
* When false, selects only collections that are immediate children of the
* `parent` specified in the containing `RunQueryRequest`. When true, selects
* all descendant collections.
*
* @param bool $allDescendants
*/
public function setAllDescendants($allDescendants)
{
$this->allDescendants = $allDescendants;
}
/**
* @return bool
*/
public function getAllDescendants()
{
return $this->allDescendants;
}
/**
* The collection ID. When set, selects only collections with this ID.
*
* @param string $collectionId
*/
public function setCollectionId($collectionId)
{
$this->collectionId = $collectionId;
}
/**
* @return string
*/
public function getCollectionId()
{
return $this->collectionId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CollectionSelector::class, 'Google_Service_Firestore_CollectionSelector');

View File

@@ -0,0 +1,67 @@
<?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 CommitRequest extends \Google\Collection
{
protected $collection_key = 'writes';
/**
* If set, applies all writes in this transaction, and commits it.
*
* @var string
*/
public $transaction;
protected $writesType = Write::class;
protected $writesDataType = 'array';
/**
* If set, applies all writes in this transaction, and commits it.
*
* @param string $transaction
*/
public function setTransaction($transaction)
{
$this->transaction = $transaction;
}
/**
* @return string
*/
public function getTransaction()
{
return $this->transaction;
}
/**
* The writes to apply. Always executed atomically and in order.
*
* @param Write[] $writes
*/
public function setWrites($writes)
{
$this->writes = $writes;
}
/**
* @return Write[]
*/
public function getWrites()
{
return $this->writes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CommitRequest::class, 'Google_Service_Firestore_CommitRequest');

View File

@@ -0,0 +1,70 @@
<?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 CommitResponse 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 commit.
*
* @var string
*/
public $commitTime;
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 commit.
*
* @param string $commitTime
*/
public function setCommitTime($commitTime)
{
$this->commitTime = $commitTime;
}
/**
* @return string
*/
public function getCommitTime()
{
return $this->commitTime;
}
/**
* 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(CommitResponse::class, 'Google_Service_Firestore_CommitResponse');

View File

@@ -0,0 +1,81 @@
<?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 CompositeFilter extends \Google\Collection
{
/**
* Unspecified. This value must not be used.
*/
public const OP_OPERATOR_UNSPECIFIED = 'OPERATOR_UNSPECIFIED';
/**
* Documents are required to satisfy all of the combined filters.
*/
public const OP_AND = 'AND';
/**
* Documents are required to satisfy at least one of the combined filters.
*/
public const OP_OR = 'OR';
protected $collection_key = 'filters';
protected $filtersType = Filter::class;
protected $filtersDataType = 'array';
/**
* The operator for combining multiple filters.
*
* @var string
*/
public $op;
/**
* The list of filters to combine. Requires: * At least one filter is present.
*
* @param Filter[] $filters
*/
public function setFilters($filters)
{
$this->filters = $filters;
}
/**
* @return Filter[]
*/
public function getFilters()
{
return $this->filters;
}
/**
* The operator for combining multiple filters.
*
* Accepted values: OPERATOR_UNSPECIFIED, AND, OR
*
* @param self::OP_* $op
*/
public function setOp($op)
{
$this->op = $op;
}
/**
* @return self::OP_*
*/
public function getOp()
{
return $this->op;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CompositeFilter::class, 'Google_Service_Firestore_CompositeFilter');

View File

@@ -0,0 +1,56 @@
<?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 Count extends \Google\Model
{
/**
* Optional. Optional constraint on the maximum number of documents to count.
* This provides a way to set an upper bound on the number of documents to
* scan, limiting latency, and cost. Unspecified is interpreted as no bound.
* High-Level Example: ``` AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k
* ); ``` Requires: * Must be greater than zero when present.
*
* @var string
*/
public $upTo;
/**
* Optional. Optional constraint on the maximum number of documents to count.
* This provides a way to set an upper bound on the number of documents to
* scan, limiting latency, and cost. Unspecified is interpreted as no bound.
* High-Level Example: ``` AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k
* ); ``` Requires: * Must be greater than zero when present.
*
* @param string $upTo
*/
public function setUpTo($upTo)
{
$this->upTo = $upTo;
}
/**
* @return string
*/
public function getUpTo()
{
return $this->upTo;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Count::class, 'Google_Service_Firestore_Count');

View File

@@ -0,0 +1,71 @@
<?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 Cursor extends \Google\Collection
{
protected $collection_key = 'values';
/**
* If the position is just before or just after the given values, relative to
* the sort order defined by the query.
*
* @var bool
*/
public $before;
protected $valuesType = Value::class;
protected $valuesDataType = 'array';
/**
* If the position is just before or just after the given values, relative to
* the sort order defined by the query.
*
* @param bool $before
*/
public function setBefore($before)
{
$this->before = $before;
}
/**
* @return bool
*/
public function getBefore()
{
return $this->before;
}
/**
* The values that represent a position, in the order they appear in the order
* by clause of a query. Can contain fewer values than specified in the order
* by clause.
*
* @param Value[] $values
*/
public function setValues($values)
{
$this->values = $values;
}
/**
* @return Value[]
*/
public function getValues()
{
return $this->values;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Cursor::class, 'Google_Service_Firestore_Cursor');

View File

@@ -0,0 +1,138 @@
<?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 Document extends \Google\Model
{
/**
* Output only. The time at which the document was created. This value
* increases monotonically when a document is deleted then recreated. It can
* also be compared to values from other documents and the `read_time` of a
* query.
*
* @var string
*/
public $createTime;
protected $fieldsType = Value::class;
protected $fieldsDataType = 'map';
/**
* The resource name of the document, for example
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*
* @var string
*/
public $name;
/**
* Output only. The time at which the document was last changed. This value is
* initially set to the `create_time` then increases monotonically with each
* change to the document. It can also be compared to values from other
* documents and the `read_time` of a query.
*
* @var string
*/
public $updateTime;
/**
* Output only. The time at which the document was created. This value
* increases monotonically when a document is deleted then recreated. It can
* also be compared to values from other documents and the `read_time` of a
* query.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* The document's fields. The map keys represent field names. Field names
* matching the regular expression `__.*__` are reserved. Reserved field names
* are forbidden except in certain documented contexts. The field names,
* represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
* Field paths may be used in other contexts to refer to structured fields
* defined here. For `map_value`, the field path is represented by a dot-
* delimited (`.`) string of segments. Each segment is either a simple field
* name (defined below) or a quoted field name. For example, the structured
* field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be
* represented by the field path `` foo.`x&y` ``. A simple field name contains
* only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not
* start with `0` to `9`. For example, `foo_bar_17`. A quoted field name
* starts and ends with `` ` `` and may contain any character. Some
* characters, including `` ` ``, must be escaped using a `\`. For example, ``
* `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
*
* @param Value[] $fields
*/
public function setFields($fields)
{
$this->fields = $fields;
}
/**
* @return Value[]
*/
public function getFields()
{
return $this->fields;
}
/**
* The resource name of the document, for example
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. The time at which the document was last changed. This value is
* initially set to the `create_time` then increases monotonically with each
* change to the document. It can also be compared to values from other
* documents and the `read_time` of a query.
*
* @param string $updateTime
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Document::class, 'Google_Service_Firestore_Document');

View File

@@ -0,0 +1,90 @@
<?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 DocumentChange extends \Google\Collection
{
protected $collection_key = 'targetIds';
protected $documentType = Document::class;
protected $documentDataType = '';
/**
* A set of target IDs for targets that no longer match this document.
*
* @var int[]
*/
public $removedTargetIds;
/**
* A set of target IDs of targets that match this document.
*
* @var int[]
*/
public $targetIds;
/**
* The new state of the Document. If `mask` is set, contains only fields that
* were updated or added.
*
* @param Document $document
*/
public function setDocument(Document $document)
{
$this->document = $document;
}
/**
* @return Document
*/
public function getDocument()
{
return $this->document;
}
/**
* A set of target IDs for targets that no longer match this document.
*
* @param int[] $removedTargetIds
*/
public function setRemovedTargetIds($removedTargetIds)
{
$this->removedTargetIds = $removedTargetIds;
}
/**
* @return int[]
*/
public function getRemovedTargetIds()
{
return $this->removedTargetIds;
}
/**
* A set of target IDs of targets that match this document.
*
* @param int[] $targetIds
*/
public function setTargetIds($targetIds)
{
$this->targetIds = $targetIds;
}
/**
* @return int[]
*/
public function getTargetIds()
{
return $this->targetIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DocumentChange::class, 'Google_Service_Firestore_DocumentChange');

View File

@@ -0,0 +1,95 @@
<?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 DocumentDelete extends \Google\Collection
{
protected $collection_key = 'removedTargetIds';
/**
* The resource name of the Document that was deleted.
*
* @var string
*/
public $document;
/**
* The read timestamp at which the delete was observed. Greater or equal to
* the `commit_time` of the delete.
*
* @var string
*/
public $readTime;
/**
* A set of target IDs for targets that previously matched this entity.
*
* @var int[]
*/
public $removedTargetIds;
/**
* The resource name of the Document that was deleted.
*
* @param string $document
*/
public function setDocument($document)
{
$this->document = $document;
}
/**
* @return string
*/
public function getDocument()
{
return $this->document;
}
/**
* The read timestamp at which the delete was observed. Greater or equal to
* the `commit_time` of the delete.
*
* @param string $readTime
*/
public function setReadTime($readTime)
{
$this->readTime = $readTime;
}
/**
* @return string
*/
public function getReadTime()
{
return $this->readTime;
}
/**
* A set of target IDs for targets that previously matched this entity.
*
* @param int[] $removedTargetIds
*/
public function setRemovedTargetIds($removedTargetIds)
{
$this->removedTargetIds = $removedTargetIds;
}
/**
* @return int[]
*/
public function getRemovedTargetIds()
{
return $this->removedTargetIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DocumentDelete::class, 'Google_Service_Firestore_DocumentDelete');

View File

@@ -0,0 +1,51 @@
<?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 DocumentMask extends \Google\Collection
{
protected $collection_key = 'fieldPaths';
/**
* The list of field paths in the mask. See Document.fields for a field path
* syntax reference.
*
* @var string[]
*/
public $fieldPaths;
/**
* The list of field paths in the mask. See Document.fields for a field path
* syntax reference.
*
* @param string[] $fieldPaths
*/
public function setFieldPaths($fieldPaths)
{
$this->fieldPaths = $fieldPaths;
}
/**
* @return string[]
*/
public function getFieldPaths()
{
return $this->fieldPaths;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DocumentMask::class, 'Google_Service_Firestore_DocumentMask');

View File

@@ -0,0 +1,95 @@
<?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 DocumentRemove extends \Google\Collection
{
protected $collection_key = 'removedTargetIds';
/**
* The resource name of the Document that has gone out of view.
*
* @var string
*/
public $document;
/**
* The read timestamp at which the remove was observed. Greater or equal to
* the `commit_time` of the change/delete/remove.
*
* @var string
*/
public $readTime;
/**
* A set of target IDs for targets that previously matched this document.
*
* @var int[]
*/
public $removedTargetIds;
/**
* The resource name of the Document that has gone out of view.
*
* @param string $document
*/
public function setDocument($document)
{
$this->document = $document;
}
/**
* @return string
*/
public function getDocument()
{
return $this->document;
}
/**
* The read timestamp at which the remove was observed. Greater or equal to
* the `commit_time` of the change/delete/remove.
*
* @param string $readTime
*/
public function setReadTime($readTime)
{
$this->readTime = $readTime;
}
/**
* @return string
*/
public function getReadTime()
{
return $this->readTime;
}
/**
* A set of target IDs for targets that previously matched this document.
*
* @param int[] $removedTargetIds
*/
public function setRemovedTargetIds($removedTargetIds)
{
$this->removedTargetIds = $removedTargetIds;
}
/**
* @return int[]
*/
public function getRemovedTargetIds()
{
return $this->removedTargetIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DocumentRemove::class, 'Google_Service_Firestore_DocumentRemove');

View File

@@ -0,0 +1,68 @@
<?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 DocumentTransform extends \Google\Collection
{
protected $collection_key = 'fieldTransforms';
/**
* The name of the document to transform.
*
* @var string
*/
public $document;
protected $fieldTransformsType = FieldTransform::class;
protected $fieldTransformsDataType = 'array';
/**
* The name of the document to transform.
*
* @param string $document
*/
public function setDocument($document)
{
$this->document = $document;
}
/**
* @return string
*/
public function getDocument()
{
return $this->document;
}
/**
* The list of transformations to apply to the fields of the document, in
* order. This must not be empty.
*
* @param FieldTransform[] $fieldTransforms
*/
public function setFieldTransforms($fieldTransforms)
{
$this->fieldTransforms = $fieldTransforms;
}
/**
* @return FieldTransform[]
*/
public function getFieldTransforms()
{
return $this->fieldTransforms;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DocumentTransform::class, 'Google_Service_Firestore_DocumentTransform');

View File

@@ -0,0 +1,55 @@
<?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 DocumentsTarget extends \Google\Collection
{
protected $collection_key = 'documents';
/**
* The names of the documents to retrieve. In the format:
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
* The request will fail if any of the document is not a child resource of the
* given `database`. Duplicate names will be elided.
*
* @var string[]
*/
public $documents;
/**
* The names of the documents to retrieve. In the format:
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
* The request will fail if any of the document is not a child resource of the
* given `database`. Duplicate names will be elided.
*
* @param string[] $documents
*/
public function setDocuments($documents)
{
$this->documents = $documents;
}
/**
* @return string[]
*/
public function getDocuments()
{
return $this->documents;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DocumentsTarget::class, 'Google_Service_Firestore_DocumentsTarget');

View File

@@ -0,0 +1,116 @@
<?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 ExecutePipelineRequest extends \Google\Model
{
protected $newTransactionType = TransactionOptions::class;
protected $newTransactionDataType = '';
/**
* Execute the pipeline in a snapshot transaction at the given time. This must
* be a microsecond precision timestamp within the past one hour, or if Point-
* in-Time Recovery is enabled, can additionally be a whole minute timestamp
* within the past 7 days.
*
* @var string
*/
public $readTime;
protected $structuredPipelineType = StructuredPipeline::class;
protected $structuredPipelineDataType = '';
/**
* Run the query within an already active transaction. The value here is the
* opaque transaction ID to execute the query in.
*
* @var string
*/
public $transaction;
/**
* Execute the pipeline in a new transaction. The identifier of the newly
* created transaction will be returned in the first response on the stream.
* This defaults to a read-only transaction.
*
* @param TransactionOptions $newTransaction
*/
public function setNewTransaction(TransactionOptions $newTransaction)
{
$this->newTransaction = $newTransaction;
}
/**
* @return TransactionOptions
*/
public function getNewTransaction()
{
return $this->newTransaction;
}
/**
* Execute the pipeline in a snapshot transaction at the given time. This must
* be a microsecond precision timestamp within the past one hour, or if Point-
* in-Time Recovery is enabled, can additionally be a whole minute timestamp
* within the past 7 days.
*
* @param string $readTime
*/
public function setReadTime($readTime)
{
$this->readTime = $readTime;
}
/**
* @return string
*/
public function getReadTime()
{
return $this->readTime;
}
/**
* A pipelined operation.
*
* @param StructuredPipeline $structuredPipeline
*/
public function setStructuredPipeline(StructuredPipeline $structuredPipeline)
{
$this->structuredPipeline = $structuredPipeline;
}
/**
* @return StructuredPipeline
*/
public function getStructuredPipeline()
{
return $this->structuredPipeline;
}
/**
* Run the query within an already active transaction. The value here is the
* opaque transaction ID to execute the query in.
*
* @param string $transaction
*/
public function setTransaction($transaction)
{
$this->transaction = $transaction;
}
/**
* @return string
*/
public function getTransaction()
{
return $this->transaction;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ExecutePipelineRequest::class, 'Google_Service_Firestore_ExecutePipelineRequest');

View File

@@ -0,0 +1,132 @@
<?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 ExecutePipelineResponse extends \Google\Collection
{
protected $collection_key = 'results';
/**
* The time at which the results are valid. This is a (not strictly)
* monotonically increasing value across multiple responses in the same
* stream. The API guarantees that all previously returned results are still
* valid at the latest `execution_time`. This allows the API consumer to treat
* the query if it ran at the latest `execution_time` returned. If the query
* returns no results, a response with `execution_time` and no `results` will
* be sent, and this represents the time at which the operation was run.
*
* @var string
*/
public $executionTime;
protected $explainStatsType = ExplainStats::class;
protected $explainStatsDataType = '';
protected $resultsType = Document::class;
protected $resultsDataType = 'array';
/**
* Newly created transaction identifier. This field is only specified as part
* of the first response from the server, alongside the `results` field when
* the original request specified ExecuteRequest.new_transaction.
*
* @var string
*/
public $transaction;
/**
* The time at which the results are valid. This is a (not strictly)
* monotonically increasing value across multiple responses in the same
* stream. The API guarantees that all previously returned results are still
* valid at the latest `execution_time`. This allows the API consumer to treat
* the query if it ran at the latest `execution_time` returned. If the query
* returns no results, a response with `execution_time` and no `results` will
* be sent, and this represents the time at which the operation was run.
*
* @param string $executionTime
*/
public function setExecutionTime($executionTime)
{
$this->executionTime = $executionTime;
}
/**
* @return string
*/
public function getExecutionTime()
{
return $this->executionTime;
}
/**
* Query explain stats. This is present on the **last** response if the
* request configured explain to run in 'analyze' or 'explain' mode in the
* pipeline options. If the query does not return any results, a response with
* `explain_stats` and no `results` will still be sent.
*
* @param ExplainStats $explainStats
*/
public function setExplainStats(ExplainStats $explainStats)
{
$this->explainStats = $explainStats;
}
/**
* @return ExplainStats
*/
public function getExplainStats()
{
return $this->explainStats;
}
/**
* An ordered batch of results returned executing a pipeline. The batch size
* is variable, and can even be zero for when only a partial progress message
* is returned. The fields present in the returned documents are only those
* that were explicitly requested in the pipeline, this includes those like
* `__name__` and `__update_time__`. This is explicitly a divergence from
* `Firestore.RunQuery` / `Firestore.GetDocument` RPCs which always return
* such fields even when they are not specified in the `mask`.
*
* @param Document[] $results
*/
public function setResults($results)
{
$this->results = $results;
}
/**
* @return Document[]
*/
public function getResults()
{
return $this->results;
}
/**
* Newly created transaction identifier. This field is only specified as part
* of the first response from the server, alongside the `results` field when
* the original request specified ExecuteRequest.new_transaction.
*
* @param string $transaction
*/
public function setTransaction($transaction)
{
$this->transaction = $transaction;
}
/**
* @return string
*/
public function getTransaction()
{
return $this->transaction;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ExecutePipelineResponse::class, 'Google_Service_Firestore_ExecutePipelineResponse');

View File

@@ -0,0 +1,124 @@
<?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 ExecutionStats extends \Google\Model
{
/**
* Debugging statistics from the execution of the query. Note that the
* debugging stats are subject to change as Firestore evolves. It could
* include: { "indexes_entries_scanned": "1000", "documents_scanned": "20",
* "billing_details" : { "documents_billable": "20", "index_entries_billable":
* "1000", "min_query_cost": "0" } }
*
* @var array[]
*/
public $debugStats;
/**
* Total time to execute the query in the backend.
*
* @var string
*/
public $executionDuration;
/**
* Total billable read operations.
*
* @var string
*/
public $readOperations;
/**
* Total number of results returned, including documents, projections,
* aggregation results, keys.
*
* @var string
*/
public $resultsReturned;
/**
* Debugging statistics from the execution of the query. Note that the
* debugging stats are subject to change as Firestore evolves. It could
* include: { "indexes_entries_scanned": "1000", "documents_scanned": "20",
* "billing_details" : { "documents_billable": "20", "index_entries_billable":
* "1000", "min_query_cost": "0" } }
*
* @param array[] $debugStats
*/
public function setDebugStats($debugStats)
{
$this->debugStats = $debugStats;
}
/**
* @return array[]
*/
public function getDebugStats()
{
return $this->debugStats;
}
/**
* Total time to execute the query in the backend.
*
* @param string $executionDuration
*/
public function setExecutionDuration($executionDuration)
{
$this->executionDuration = $executionDuration;
}
/**
* @return string
*/
public function getExecutionDuration()
{
return $this->executionDuration;
}
/**
* Total billable read operations.
*
* @param string $readOperations
*/
public function setReadOperations($readOperations)
{
$this->readOperations = $readOperations;
}
/**
* @return string
*/
public function getReadOperations()
{
return $this->readOperations;
}
/**
* Total number of results returned, including documents, projections,
* aggregation results, keys.
*
* @param string $resultsReturned
*/
public function setResultsReturned($resultsReturned)
{
$this->resultsReturned = $resultsReturned;
}
/**
* @return string
*/
public function getResultsReturned()
{
return $this->resultsReturned;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ExecutionStats::class, 'Google_Service_Firestore_ExecutionStats');

View File

@@ -0,0 +1,106 @@
<?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 ExistenceFilter extends \Google\Model
{
/**
* The total count of documents that match target_id. If different from the
* count of documents in the client that match, the client must manually
* determine which documents no longer match the target. The client can use
* the `unchanged_names` bloom filter to assist with this determination by
* testing ALL the document names against the filter; if the document name is
* NOT in the filter, it means the document no longer matches the target.
*
* @var int
*/
public $count;
/**
* The target ID to which this filter applies.
*
* @var int
*/
public $targetId;
protected $unchangedNamesType = BloomFilter::class;
protected $unchangedNamesDataType = '';
/**
* The total count of documents that match target_id. If different from the
* count of documents in the client that match, the client must manually
* determine which documents no longer match the target. The client can use
* the `unchanged_names` bloom filter to assist with this determination by
* testing ALL the document names against the filter; if the document name is
* NOT in the filter, it means the document no longer matches the target.
*
* @param int $count
*/
public function setCount($count)
{
$this->count = $count;
}
/**
* @return int
*/
public function getCount()
{
return $this->count;
}
/**
* The target ID to which this filter applies.
*
* @param int $targetId
*/
public function setTargetId($targetId)
{
$this->targetId = $targetId;
}
/**
* @return int
*/
public function getTargetId()
{
return $this->targetId;
}
/**
* A bloom filter that, despite its name, contains the UTF-8 byte encodings of
* the resource names of ALL the documents that match target_id, in the form
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
* This bloom filter may be omitted at the server's discretion, such as if it
* is deemed that the client will not make use of it or if it is too
* computationally expensive to calculate or transmit. Clients must gracefully
* handle this field being absent by falling back to the logic used before
* this field existed; that is, re-add the target without a resume token to
* figure out which documents in the client's cache are out of sync.
*
* @param BloomFilter $unchangedNames
*/
public function setUnchangedNames(BloomFilter $unchangedNames)
{
$this->unchangedNames = $unchangedNames;
}
/**
* @return BloomFilter
*/
public function getUnchangedNames()
{
return $this->unchangedNames;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ExistenceFilter::class, 'Google_Service_Firestore_ExistenceFilter');

View File

@@ -0,0 +1,63 @@
<?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 ExplainMetrics extends \Google\Model
{
protected $executionStatsType = ExecutionStats::class;
protected $executionStatsDataType = '';
protected $planSummaryType = PlanSummary::class;
protected $planSummaryDataType = '';
/**
* Aggregated stats from the execution of the query. Only present when
* ExplainOptions.analyze is set to true.
*
* @param ExecutionStats $executionStats
*/
public function setExecutionStats(ExecutionStats $executionStats)
{
$this->executionStats = $executionStats;
}
/**
* @return ExecutionStats
*/
public function getExecutionStats()
{
return $this->executionStats;
}
/**
* Planning phase information for the query.
*
* @param PlanSummary $planSummary
*/
public function setPlanSummary(PlanSummary $planSummary)
{
$this->planSummary = $planSummary;
}
/**
* @return PlanSummary
*/
public function getPlanSummary()
{
return $this->planSummary;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ExplainMetrics::class, 'Google_Service_Firestore_ExplainMetrics');

View File

@@ -0,0 +1,54 @@
<?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 ExplainOptions extends \Google\Model
{
/**
* Optional. Whether to execute this query. When false (the default), the
* query will be planned, returning only metrics from the planning stages.
* When true, the query will be planned and executed, returning the full query
* results along with both planning and execution stage metrics.
*
* @var bool
*/
public $analyze;
/**
* Optional. Whether to execute this query. When false (the default), the
* query will be planned, returning only metrics from the planning stages.
* When true, the query will be planned and executed, returning the full query
* results along with both planning and execution stage metrics.
*
* @param bool $analyze
*/
public function setAnalyze($analyze)
{
$this->analyze = $analyze;
}
/**
* @return bool
*/
public function getAnalyze()
{
return $this->analyze;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ExplainOptions::class, 'Google_Service_Firestore_ExplainOptions');

View File

@@ -0,0 +1,52 @@
<?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 ExplainStats extends \Google\Model
{
/**
* The format depends on the `output_format` options in the request. Currently
* there are two supported options: `TEXT` and `JSON`. Both supply a
* `google.protobuf.StringValue`.
*
* @var array[]
*/
public $data;
/**
* The format depends on the `output_format` options in the request. Currently
* there are two supported options: `TEXT` and `JSON`. Both supply a
* `google.protobuf.StringValue`.
*
* @param array[] $data
*/
public function setData($data)
{
$this->data = $data;
}
/**
* @return array[]
*/
public function getData()
{
return $this->data;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ExplainStats::class, 'Google_Service_Firestore_ExplainStats');

View File

@@ -0,0 +1,146 @@
<?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 FieldFilter extends \Google\Model
{
/**
* Unspecified. This value must not be used.
*/
public const OP_OPERATOR_UNSPECIFIED = 'OPERATOR_UNSPECIFIED';
/**
* The given `field` is less than the given `value`. Requires: * That `field`
* come first in `order_by`.
*/
public const OP_LESS_THAN = 'LESS_THAN';
/**
* The given `field` is less than or equal to the given `value`. Requires: *
* That `field` come first in `order_by`.
*/
public const OP_LESS_THAN_OR_EQUAL = 'LESS_THAN_OR_EQUAL';
/**
* The given `field` is greater than the given `value`. Requires: * That
* `field` come first in `order_by`.
*/
public const OP_GREATER_THAN = 'GREATER_THAN';
/**
* The given `field` is greater than or equal to the given `value`. Requires:
* * That `field` come first in `order_by`.
*/
public const OP_GREATER_THAN_OR_EQUAL = 'GREATER_THAN_OR_EQUAL';
/**
* The given `field` is equal to the given `value`.
*/
public const OP_EQUAL = 'EQUAL';
/**
* The given `field` is not equal to the given `value`. Requires: * No other
* `NOT_EQUAL`, `NOT_IN`, `IS_NOT_NULL`, or `IS_NOT_NAN`. * That `field` comes
* first in the `order_by`.
*/
public const OP_NOT_EQUAL = 'NOT_EQUAL';
/**
* The given `field` is an array that contains the given `value`.
*/
public const OP_ARRAY_CONTAINS = 'ARRAY_CONTAINS';
/**
* The given `field` is equal to at least one value in the given array.
* Requires: * That `value` is a non-empty `ArrayValue`, subject to
* disjunction limits. * No `NOT_IN` filters in the same query.
*/
public const OP_IN = 'IN';
/**
* The given `field` is an array that contains any of the values in the given
* array. Requires: * That `value` is a non-empty `ArrayValue`, subject to
* disjunction limits. * No other `ARRAY_CONTAINS_ANY` filters within the same
* disjunction. * No `NOT_IN` filters in the same query.
*/
public const OP_ARRAY_CONTAINS_ANY = 'ARRAY_CONTAINS_ANY';
/**
* The value of the `field` is not in the given array. Requires: * That
* `value` is a non-empty `ArrayValue` with at most 10 values. * No other
* `OR`, `IN`, `ARRAY_CONTAINS_ANY`, `NOT_IN`, `NOT_EQUAL`, `IS_NOT_NULL`, or
* `IS_NOT_NAN`. * That `field` comes first in the `order_by`.
*/
public const OP_NOT_IN = 'NOT_IN';
protected $fieldType = FieldReference::class;
protected $fieldDataType = '';
/**
* The operator to filter by.
*
* @var string
*/
public $op;
protected $valueType = Value::class;
protected $valueDataType = '';
/**
* The field to filter by.
*
* @param FieldReference $field
*/
public function setField(FieldReference $field)
{
$this->field = $field;
}
/**
* @return FieldReference
*/
public function getField()
{
return $this->field;
}
/**
* The operator to filter by.
*
* Accepted values: OPERATOR_UNSPECIFIED, LESS_THAN, LESS_THAN_OR_EQUAL,
* GREATER_THAN, GREATER_THAN_OR_EQUAL, EQUAL, NOT_EQUAL, ARRAY_CONTAINS, IN,
* ARRAY_CONTAINS_ANY, NOT_IN
*
* @param self::OP_* $op
*/
public function setOp($op)
{
$this->op = $op;
}
/**
* @return self::OP_*
*/
public function getOp()
{
return $this->op;
}
/**
* The value to compare to.
*
* @param Value $value
*/
public function setValue(Value $value)
{
$this->value = $value;
}
/**
* @return Value
*/
public function getValue()
{
return $this->value;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FieldFilter::class, 'Google_Service_Firestore_FieldFilter');

View File

@@ -0,0 +1,52 @@
<?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 FieldReference extends \Google\Model
{
/**
* A reference to a field in a document. Requires: * MUST be a dot-delimited
* (`.`) string of segments, where each segment conforms to document field
* name limitations.
*
* @var string
*/
public $fieldPath;
/**
* A reference to a field in a document. Requires: * MUST be a dot-delimited
* (`.`) string of segments, where each segment conforms to document field
* name limitations.
*
* @param string $fieldPath
*/
public function setFieldPath($fieldPath)
{
$this->fieldPath = $fieldPath;
}
/**
* @return string
*/
public function getFieldPath()
{
return $this->fieldPath;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FieldReference::class, 'Google_Service_Firestore_FieldReference');

View File

@@ -0,0 +1,211 @@
<?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 FieldTransform extends \Google\Model
{
/**
* Unspecified. This value must not be used.
*/
public const SET_TO_SERVER_VALUE_SERVER_VALUE_UNSPECIFIED = 'SERVER_VALUE_UNSPECIFIED';
/**
* The time at which the server processed the request, with millisecond
* precision. If used on multiple fields (same or different documents) in a
* transaction, all the fields will get the same server timestamp.
*/
public const SET_TO_SERVER_VALUE_REQUEST_TIME = 'REQUEST_TIME';
protected $appendMissingElementsType = ArrayValue::class;
protected $appendMissingElementsDataType = '';
/**
* The path of the field. See Document.fields for the field path syntax
* reference.
*
* @var string
*/
public $fieldPath;
protected $incrementType = Value::class;
protected $incrementDataType = '';
protected $maximumType = Value::class;
protected $maximumDataType = '';
protected $minimumType = Value::class;
protected $minimumDataType = '';
protected $removeAllFromArrayType = ArrayValue::class;
protected $removeAllFromArrayDataType = '';
/**
* Sets the field to the given server value.
*
* @var string
*/
public $setToServerValue;
/**
* Append the given elements in order if they are not already present in the
* current field value. If the field is not an array, or if the field does not
* yet exist, it is first set to the empty array. Equivalent numbers of
* different types (e.g. 3L and 3.0) are considered equal when checking if a
* value is missing. NaN is equal to NaN, and Null is equal to Null. If the
* input contains multiple equivalent values, only the first will be
* considered. The corresponding transform_result will be the null value.
*
* @param ArrayValue $appendMissingElements
*/
public function setAppendMissingElements(ArrayValue $appendMissingElements)
{
$this->appendMissingElements = $appendMissingElements;
}
/**
* @return ArrayValue
*/
public function getAppendMissingElements()
{
return $this->appendMissingElements;
}
/**
* The path of the field. See Document.fields for the field path syntax
* reference.
*
* @param string $fieldPath
*/
public function setFieldPath($fieldPath)
{
$this->fieldPath = $fieldPath;
}
/**
* @return string
*/
public function getFieldPath()
{
return $this->fieldPath;
}
/**
* Adds the given value to the field's current value. This must be an integer
* or a double value. If the field is not an integer or double, or if the
* field does not yet exist, the transformation will set the field to the
* given value. If either of the given value or the current field value are
* doubles, both values will be interpreted as doubles. Double arithmetic and
* representation of double values follow IEEE 754 semantics. If there is
* positive/negative integer overflow, the field is resolved to the largest
* magnitude positive/negative integer.
*
* @param Value $increment
*/
public function setIncrement(Value $increment)
{
$this->increment = $increment;
}
/**
* @return Value
*/
public function getIncrement()
{
return $this->increment;
}
/**
* Sets the field to the maximum of its current value and the given value.
* This must be an integer or a double value. If the field is not an integer
* or double, or if the field does not yet exist, the transformation will set
* the field to the given value. If a maximum operation is applied where the
* field and the input value are of mixed types (that is - one is an integer
* and one is a double) the field takes on the type of the larger operand. If
* the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0,
* 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero
* input value is always the stored value. The maximum of any numeric value x
* and NaN is NaN.
*
* @param Value $maximum
*/
public function setMaximum(Value $maximum)
{
$this->maximum = $maximum;
}
/**
* @return Value
*/
public function getMaximum()
{
return $this->maximum;
}
/**
* Sets the field to the minimum of its current value and the given value.
* This must be an integer or a double value. If the field is not an integer
* or double, or if the field does not yet exist, the transformation will set
* the field to the input value. If a minimum operation is applied where the
* field and the input value are of mixed types (that is - one is an integer
* and one is a double) the field takes on the type of the smaller operand. If
* the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0,
* 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero
* input value is always the stored value. The minimum of any numeric value x
* and NaN is NaN.
*
* @param Value $minimum
*/
public function setMinimum(Value $minimum)
{
$this->minimum = $minimum;
}
/**
* @return Value
*/
public function getMinimum()
{
return $this->minimum;
}
/**
* Remove all of the given elements from the array in the field. If the field
* is not an array, or if the field does not yet exist, it is set to the empty
* array. Equivalent numbers of the different types (e.g. 3L and 3.0) are
* considered equal when deciding whether an element should be removed. NaN is
* equal to NaN, and Null is equal to Null. This will remove all equivalent
* values if there are duplicates. The corresponding transform_result will be
* the null value.
*
* @param ArrayValue $removeAllFromArray
*/
public function setRemoveAllFromArray(ArrayValue $removeAllFromArray)
{
$this->removeAllFromArray = $removeAllFromArray;
}
/**
* @return ArrayValue
*/
public function getRemoveAllFromArray()
{
return $this->removeAllFromArray;
}
/**
* Sets the field to the given server value.
*
* Accepted values: SERVER_VALUE_UNSPECIFIED, REQUEST_TIME
*
* @param self::SET_TO_SERVER_VALUE_* $setToServerValue
*/
public function setSetToServerValue($setToServerValue)
{
$this->setToServerValue = $setToServerValue;
}
/**
* @return self::SET_TO_SERVER_VALUE_*
*/
public function getSetToServerValue()
{
return $this->setToServerValue;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FieldTransform::class, 'Google_Service_Firestore_FieldTransform');

View File

@@ -0,0 +1,80 @@
<?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 Filter extends \Google\Model
{
protected $compositeFilterType = CompositeFilter::class;
protected $compositeFilterDataType = '';
protected $fieldFilterType = FieldFilter::class;
protected $fieldFilterDataType = '';
protected $unaryFilterType = UnaryFilter::class;
protected $unaryFilterDataType = '';
/**
* A composite filter.
*
* @param CompositeFilter $compositeFilter
*/
public function setCompositeFilter(CompositeFilter $compositeFilter)
{
$this->compositeFilter = $compositeFilter;
}
/**
* @return CompositeFilter
*/
public function getCompositeFilter()
{
return $this->compositeFilter;
}
/**
* A filter on a document field.
*
* @param FieldFilter $fieldFilter
*/
public function setFieldFilter(FieldFilter $fieldFilter)
{
$this->fieldFilter = $fieldFilter;
}
/**
* @return FieldFilter
*/
public function getFieldFilter()
{
return $this->fieldFilter;
}
/**
* A filter that takes exactly one argument.
*
* @param UnaryFilter $unaryFilter
*/
public function setUnaryFilter(UnaryFilter $unaryFilter)
{
$this->unaryFilter = $unaryFilter;
}
/**
* @return UnaryFilter
*/
public function getUnaryFilter()
{
return $this->unaryFilter;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Filter::class, 'Google_Service_Firestore_Filter');

View File

@@ -0,0 +1,184 @@
<?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 FindNearest extends \Google\Model
{
/**
* Should not be set.
*/
public const DISTANCE_MEASURE_DISTANCE_MEASURE_UNSPECIFIED = 'DISTANCE_MEASURE_UNSPECIFIED';
/**
* Measures the EUCLIDEAN distance between the vectors. See
* [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn
* more. The resulting distance decreases the more similar two vectors are.
*/
public const DISTANCE_MEASURE_EUCLIDEAN = 'EUCLIDEAN';
/**
* COSINE distance compares vectors based on the angle between them, which
* allows you to measure similarity that isn't based on the vectors magnitude.
* We recommend using DOT_PRODUCT with unit normalized vectors instead of
* COSINE distance, which is mathematically equivalent with better
* performance. See [Cosine
* Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn more
* about COSINE similarity and COSINE distance. The resulting COSINE distance
* decreases the more similar two vectors are.
*/
public const DISTANCE_MEASURE_COSINE = 'COSINE';
/**
* Similar to cosine but is affected by the magnitude of the vectors. See [Dot
* Product](https://en.wikipedia.org/wiki/Dot_product) to learn more. The
* resulting distance increases the more similar two vectors are.
*/
public const DISTANCE_MEASURE_DOT_PRODUCT = 'DOT_PRODUCT';
/**
* Required. The distance measure to use, required.
*
* @var string
*/
public $distanceMeasure;
/**
* Optional. Optional name of the field to output the result of the vector
* distance calculation. Must conform to document field name limitations.
*
* @var string
*/
public $distanceResultField;
/**
* Optional. Option to specify a threshold for which no less similar documents
* will be returned. The behavior of the specified `distance_measure` will
* affect the meaning of the distance threshold. Since DOT_PRODUCT distances
* increase when the vectors are more similar, the comparison is inverted. *
* For EUCLIDEAN, COSINE: `WHERE distance <= distance_threshold` * For
* DOT_PRODUCT: `WHERE distance >= distance_threshold`
*
* @var
*/
public $distanceThreshold;
/**
* Required. The number of nearest neighbors to return. Must be a positive
* integer of no more than 1000.
*
* @var int
*/
public $limit;
protected $queryVectorType = Value::class;
protected $queryVectorDataType = '';
protected $vectorFieldType = FieldReference::class;
protected $vectorFieldDataType = '';
/**
* Required. The distance measure to use, required.
*
* Accepted values: DISTANCE_MEASURE_UNSPECIFIED, EUCLIDEAN, COSINE,
* DOT_PRODUCT
*
* @param self::DISTANCE_MEASURE_* $distanceMeasure
*/
public function setDistanceMeasure($distanceMeasure)
{
$this->distanceMeasure = $distanceMeasure;
}
/**
* @return self::DISTANCE_MEASURE_*
*/
public function getDistanceMeasure()
{
return $this->distanceMeasure;
}
/**
* Optional. Optional name of the field to output the result of the vector
* distance calculation. Must conform to document field name limitations.
*
* @param string $distanceResultField
*/
public function setDistanceResultField($distanceResultField)
{
$this->distanceResultField = $distanceResultField;
}
/**
* @return string
*/
public function getDistanceResultField()
{
return $this->distanceResultField;
}
public function setDistanceThreshold($distanceThreshold)
{
$this->distanceThreshold = $distanceThreshold;
}
public function getDistanceThreshold()
{
return $this->distanceThreshold;
}
/**
* Required. The number of nearest neighbors to return. Must be a positive
* integer of no more than 1000.
*
* @param int $limit
*/
public function setLimit($limit)
{
$this->limit = $limit;
}
/**
* @return int
*/
public function getLimit()
{
return $this->limit;
}
/**
* Required. The query vector that we are searching on. Must be a vector of no
* more than 2048 dimensions.
*
* @param Value $queryVector
*/
public function setQueryVector(Value $queryVector)
{
$this->queryVector = $queryVector;
}
/**
* @return Value
*/
public function getQueryVector()
{
return $this->queryVector;
}
/**
* Required. An indexed vector field to search upon. Only documents which
* contain vectors whose dimensionality match the query_vector can be
* returned.
*
* @param FieldReference $vectorField
*/
public function setVectorField(FieldReference $vectorField)
{
$this->vectorField = $vectorField;
}
/**
* @return FieldReference
*/
public function getVectorField()
{
return $this->vectorField;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FindNearest::class, 'Google_Service_Firestore_FindNearest');

View File

@@ -0,0 +1,25 @@
<?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 FirestoreEmpty extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FirestoreEmpty::class, 'Google_Service_Firestore_FirestoreEmpty');

View File

@@ -0,0 +1,87 @@
<?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 FirestoreFunction extends \Google\Collection
{
protected $collection_key = 'args';
protected $argsType = Value::class;
protected $argsDataType = 'array';
/**
* Required. The name of the function to evaluate. **Requires:** * must be in
* snake case (lower case with underscore separator).
*
* @var string
*/
public $name;
protected $optionsType = Value::class;
protected $optionsDataType = 'map';
/**
* Optional. Ordered list of arguments the given function expects.
*
* @param Value[] $args
*/
public function setArgs($args)
{
$this->args = $args;
}
/**
* @return Value[]
*/
public function getArgs()
{
return $this->args;
}
/**
* Required. The name of the function to evaluate. **Requires:** * must be in
* snake case (lower case with underscore separator).
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Optional. Optional named arguments that certain functions may support.
*
* @param Value[] $options
*/
public function setOptions($options)
{
$this->options = $options;
}
/**
* @return Value[]
*/
public function getOptions()
{
return $this->options;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FirestoreFunction::class, 'Google_Service_Firestore_FirestoreFunction');

View File

@@ -0,0 +1,54 @@
<?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 FirestoreReadOnly extends \Google\Model
{
/**
* Reads documents at the given time. This must be a microsecond precision
* timestamp within the past one hour, or if Point-in-Time Recovery is
* enabled, can additionally be a whole minute timestamp within the past 7
* days.
*
* @var string
*/
public $readTime;
/**
* Reads documents at the given time. This must be a microsecond precision
* timestamp within the past one hour, or if Point-in-Time Recovery is
* enabled, can additionally be a whole minute timestamp within the past 7
* days.
*
* @param string $readTime
*/
public function setReadTime($readTime)
{
$this->readTime = $readTime;
}
/**
* @return string
*/
public function getReadTime()
{
return $this->readTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FirestoreReadOnly::class, 'Google_Service_Firestore_FirestoreReadOnly');

View File

@@ -0,0 +1,205 @@
<?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 GoogleFirestoreAdminV1Backup extends \Google\Model
{
/**
* The state is unspecified.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The pending backup is still being created. Operations on the backup will be
* rejected in this state.
*/
public const STATE_CREATING = 'CREATING';
/**
* The backup is complete and ready to use.
*/
public const STATE_READY = 'READY';
/**
* The backup is not available at this moment.
*/
public const STATE_NOT_AVAILABLE = 'NOT_AVAILABLE';
/**
* Output only. Name of the Firestore database that the backup is from. Format
* is `projects/{project}/databases/{database}`.
*
* @var string
*/
public $database;
/**
* Output only. The system-generated UUID4 for the Firestore database that the
* backup is from.
*
* @var string
*/
public $databaseUid;
/**
* Output only. The timestamp at which this backup expires.
*
* @var string
*/
public $expireTime;
/**
* Output only. The unique resource name of the Backup. Format is
* `projects/{project}/locations/{location}/backups/{backup}`.
*
* @var string
*/
public $name;
/**
* Output only. The backup contains an externally consistent copy of the
* database at this time.
*
* @var string
*/
public $snapshotTime;
/**
* Output only. The current state of the backup.
*
* @var string
*/
public $state;
protected $statsType = GoogleFirestoreAdminV1Stats::class;
protected $statsDataType = '';
/**
* Output only. Name of the Firestore database that the backup is from. Format
* is `projects/{project}/databases/{database}`.
*
* @param string $database
*/
public function setDatabase($database)
{
$this->database = $database;
}
/**
* @return string
*/
public function getDatabase()
{
return $this->database;
}
/**
* Output only. The system-generated UUID4 for the Firestore database that the
* backup is from.
*
* @param string $databaseUid
*/
public function setDatabaseUid($databaseUid)
{
$this->databaseUid = $databaseUid;
}
/**
* @return string
*/
public function getDatabaseUid()
{
return $this->databaseUid;
}
/**
* Output only. The timestamp at which this backup expires.
*
* @param string $expireTime
*/
public function setExpireTime($expireTime)
{
$this->expireTime = $expireTime;
}
/**
* @return string
*/
public function getExpireTime()
{
return $this->expireTime;
}
/**
* Output only. The unique resource name of the Backup. Format is
* `projects/{project}/locations/{location}/backups/{backup}`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. The backup contains an externally consistent copy of the
* database at this time.
*
* @param string $snapshotTime
*/
public function setSnapshotTime($snapshotTime)
{
$this->snapshotTime = $snapshotTime;
}
/**
* @return string
*/
public function getSnapshotTime()
{
return $this->snapshotTime;
}
/**
* Output only. The current state of the backup.
*
* Accepted values: STATE_UNSPECIFIED, CREATING, READY, NOT_AVAILABLE
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Output only. Statistics about the backup. This data only becomes available
* after the backup is fully materialized to secondary storage. This field
* will be empty till then.
*
* @param GoogleFirestoreAdminV1Stats $stats
*/
public function setStats(GoogleFirestoreAdminV1Stats $stats)
{
$this->stats = $stats;
}
/**
* @return GoogleFirestoreAdminV1Stats
*/
public function getStats()
{
return $this->stats;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1Backup::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1Backup');

View File

@@ -0,0 +1,166 @@
<?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 GoogleFirestoreAdminV1BackupSchedule extends \Google\Model
{
/**
* Output only. The timestamp at which this backup schedule was created and
* effective since. No backups will be created for this schedule before this
* time.
*
* @var string
*/
public $createTime;
protected $dailyRecurrenceType = GoogleFirestoreAdminV1DailyRecurrence::class;
protected $dailyRecurrenceDataType = '';
/**
* Output only. The unique backup schedule identifier across all locations and
* databases for the given project. This will be auto-assigned. Format is
* `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
*
* @var string
*/
public $name;
/**
* At what relative time in the future, compared to its creation time, the
* backup should be deleted, e.g. keep backups for 7 days. The maximum
* supported retention period is 14 weeks.
*
* @var string
*/
public $retention;
/**
* Output only. The timestamp at which this backup schedule was most recently
* updated. When a backup schedule is first created, this is the same as
* create_time.
*
* @var string
*/
public $updateTime;
protected $weeklyRecurrenceType = GoogleFirestoreAdminV1WeeklyRecurrence::class;
protected $weeklyRecurrenceDataType = '';
/**
* Output only. The timestamp at which this backup schedule was created and
* effective since. No backups will be created for this schedule before this
* time.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* For a schedule that runs daily.
*
* @param GoogleFirestoreAdminV1DailyRecurrence $dailyRecurrence
*/
public function setDailyRecurrence(GoogleFirestoreAdminV1DailyRecurrence $dailyRecurrence)
{
$this->dailyRecurrence = $dailyRecurrence;
}
/**
* @return GoogleFirestoreAdminV1DailyRecurrence
*/
public function getDailyRecurrence()
{
return $this->dailyRecurrence;
}
/**
* Output only. The unique backup schedule identifier across all locations and
* databases for the given project. This will be auto-assigned. Format is
* `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* At what relative time in the future, compared to its creation time, the
* backup should be deleted, e.g. keep backups for 7 days. The maximum
* supported retention period is 14 weeks.
*
* @param string $retention
*/
public function setRetention($retention)
{
$this->retention = $retention;
}
/**
* @return string
*/
public function getRetention()
{
return $this->retention;
}
/**
* Output only. The timestamp at which this backup schedule was most recently
* updated. When a backup schedule is first created, this is the same as
* create_time.
*
* @param string $updateTime
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
/**
* For a schedule that runs weekly on a specific day.
*
* @param GoogleFirestoreAdminV1WeeklyRecurrence $weeklyRecurrence
*/
public function setWeeklyRecurrence(GoogleFirestoreAdminV1WeeklyRecurrence $weeklyRecurrence)
{
$this->weeklyRecurrence = $weeklyRecurrence;
}
/**
* @return GoogleFirestoreAdminV1WeeklyRecurrence
*/
public function getWeeklyRecurrence()
{
return $this->weeklyRecurrence;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1BackupSchedule::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1BackupSchedule');

View File

@@ -0,0 +1,50 @@
<?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 GoogleFirestoreAdminV1BackupSource extends \Google\Model
{
/**
* The resource name of the backup that was used to restore this database.
* Format: `projects/{project}/locations/{location}/backups/{backup}`.
*
* @var string
*/
public $backup;
/**
* The resource name of the backup that was used to restore this database.
* Format: `projects/{project}/locations/{location}/backups/{backup}`.
*
* @param string $backup
*/
public function setBackup($backup)
{
$this->backup = $backup;
}
/**
* @return string
*/
public function getBackup()
{
return $this->backup;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1BackupSource::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1BackupSource');

View File

@@ -0,0 +1,240 @@
<?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 GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata extends \Google\Collection
{
/**
* Unspecified.
*/
public const OPERATION_STATE_OPERATION_STATE_UNSPECIFIED = 'OPERATION_STATE_UNSPECIFIED';
/**
* Request is being prepared for processing.
*/
public const OPERATION_STATE_INITIALIZING = 'INITIALIZING';
/**
* Request is actively being processed.
*/
public const OPERATION_STATE_PROCESSING = 'PROCESSING';
/**
* Request is in the process of being cancelled after user called
* google.longrunning.Operations.CancelOperation on the operation.
*/
public const OPERATION_STATE_CANCELLING = 'CANCELLING';
/**
* Request has been processed and is in its finalization stage.
*/
public const OPERATION_STATE_FINALIZING = 'FINALIZING';
/**
* Request has completed successfully.
*/
public const OPERATION_STATE_SUCCESSFUL = 'SUCCESSFUL';
/**
* Request has finished being processed, but encountered an error.
*/
public const OPERATION_STATE_FAILED = 'FAILED';
/**
* Request has finished being cancelled after user called
* google.longrunning.Operations.CancelOperation.
*/
public const OPERATION_STATE_CANCELLED = 'CANCELLED';
protected $collection_key = 'namespaceIds';
/**
* The IDs of the collection groups that are being deleted.
*
* @var string[]
*/
public $collectionIds;
/**
* The time this operation completed. Will be unset if operation still in
* progress.
*
* @var string
*/
public $endTime;
/**
* Which namespace IDs are being deleted.
*
* @var string[]
*/
public $namespaceIds;
/**
* The state of the operation.
*
* @var string
*/
public $operationState;
protected $progressBytesType = GoogleFirestoreAdminV1Progress::class;
protected $progressBytesDataType = '';
protected $progressDocumentsType = GoogleFirestoreAdminV1Progress::class;
protected $progressDocumentsDataType = '';
/**
* The timestamp that corresponds to the version of the database that is being
* read to get the list of documents to delete. This time can also be used as
* the timestamp of PITR in case of disaster recovery (subject to PITR window
* limit).
*
* @var string
*/
public $snapshotTime;
/**
* The time this operation started.
*
* @var string
*/
public $startTime;
/**
* The IDs of the collection groups that are being deleted.
*
* @param string[] $collectionIds
*/
public function setCollectionIds($collectionIds)
{
$this->collectionIds = $collectionIds;
}
/**
* @return string[]
*/
public function getCollectionIds()
{
return $this->collectionIds;
}
/**
* The time this operation completed. Will be unset if operation still in
* progress.
*
* @param string $endTime
*/
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
/**
* @return string
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* Which namespace IDs are being deleted.
*
* @param string[] $namespaceIds
*/
public function setNamespaceIds($namespaceIds)
{
$this->namespaceIds = $namespaceIds;
}
/**
* @return string[]
*/
public function getNamespaceIds()
{
return $this->namespaceIds;
}
/**
* The state of the operation.
*
* Accepted values: OPERATION_STATE_UNSPECIFIED, INITIALIZING, PROCESSING,
* CANCELLING, FINALIZING, SUCCESSFUL, FAILED, CANCELLED
*
* @param self::OPERATION_STATE_* $operationState
*/
public function setOperationState($operationState)
{
$this->operationState = $operationState;
}
/**
* @return self::OPERATION_STATE_*
*/
public function getOperationState()
{
return $this->operationState;
}
/**
* The progress, in bytes, of this operation.
*
* @param GoogleFirestoreAdminV1Progress $progressBytes
*/
public function setProgressBytes(GoogleFirestoreAdminV1Progress $progressBytes)
{
$this->progressBytes = $progressBytes;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressBytes()
{
return $this->progressBytes;
}
/**
* The progress, in documents, of this operation.
*
* @param GoogleFirestoreAdminV1Progress $progressDocuments
*/
public function setProgressDocuments(GoogleFirestoreAdminV1Progress $progressDocuments)
{
$this->progressDocuments = $progressDocuments;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressDocuments()
{
return $this->progressDocuments;
}
/**
* The timestamp that corresponds to the version of the database that is being
* read to get the list of documents to delete. This time can also be used as
* the timestamp of PITR in case of disaster recovery (subject to PITR window
* limit).
*
* @param string $snapshotTime
*/
public function setSnapshotTime($snapshotTime)
{
$this->snapshotTime = $snapshotTime;
}
/**
* @return string
*/
public function getSnapshotTime()
{
return $this->snapshotTime;
}
/**
* The time this operation started.
*
* @param string $startTime
*/
public function setStartTime($startTime)
{
$this->startTime = $startTime;
}
/**
* @return string
*/
public function getStartTime()
{
return $this->startTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata');

View File

@@ -0,0 +1,81 @@
<?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 GoogleFirestoreAdminV1BulkDeleteDocumentsRequest extends \Google\Collection
{
protected $collection_key = 'namespaceIds';
/**
* Optional. IDs of the collection groups to delete. Unspecified means all
* collection groups. Each collection group in this list must be unique.
*
* @var string[]
*/
public $collectionIds;
/**
* Optional. Namespaces to delete. An empty list means all namespaces. This is
* the recommended usage for databases that don't use namespaces. An empty
* string element represents the default namespace. This should be used if the
* database has data in non-default namespaces, but doesn't want to delete
* from them. Each namespace in this list must be unique.
*
* @var string[]
*/
public $namespaceIds;
/**
* Optional. IDs of the collection groups to delete. Unspecified means all
* collection groups. Each collection group in this list must be unique.
*
* @param string[] $collectionIds
*/
public function setCollectionIds($collectionIds)
{
$this->collectionIds = $collectionIds;
}
/**
* @return string[]
*/
public function getCollectionIds()
{
return $this->collectionIds;
}
/**
* Optional. Namespaces to delete. An empty list means all namespaces. This is
* the recommended usage for databases that don't use namespaces. An empty
* string element represents the default namespace. This should be used if the
* database has data in non-default namespaces, but doesn't want to delete
* from them. Each namespace in this list must be unique.
*
* @param string[] $namespaceIds
*/
public function setNamespaceIds($namespaceIds)
{
$this->namespaceIds = $namespaceIds;
}
/**
* @return string[]
*/
public function getNamespaceIds()
{
return $this->namespaceIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1BulkDeleteDocumentsRequest::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1BulkDeleteDocumentsRequest');

View File

@@ -0,0 +1,187 @@
<?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 GoogleFirestoreAdminV1CloneDatabaseMetadata extends \Google\Model
{
/**
* Unspecified.
*/
public const OPERATION_STATE_OPERATION_STATE_UNSPECIFIED = 'OPERATION_STATE_UNSPECIFIED';
/**
* Request is being prepared for processing.
*/
public const OPERATION_STATE_INITIALIZING = 'INITIALIZING';
/**
* Request is actively being processed.
*/
public const OPERATION_STATE_PROCESSING = 'PROCESSING';
/**
* Request is in the process of being cancelled after user called
* google.longrunning.Operations.CancelOperation on the operation.
*/
public const OPERATION_STATE_CANCELLING = 'CANCELLING';
/**
* Request has been processed and is in its finalization stage.
*/
public const OPERATION_STATE_FINALIZING = 'FINALIZING';
/**
* Request has completed successfully.
*/
public const OPERATION_STATE_SUCCESSFUL = 'SUCCESSFUL';
/**
* Request has finished being processed, but encountered an error.
*/
public const OPERATION_STATE_FAILED = 'FAILED';
/**
* Request has finished being cancelled after user called
* google.longrunning.Operations.CancelOperation.
*/
public const OPERATION_STATE_CANCELLED = 'CANCELLED';
/**
* The name of the database being cloned to.
*
* @var string
*/
public $database;
/**
* The time the clone finished, unset for ongoing clones.
*
* @var string
*/
public $endTime;
/**
* The operation state of the clone.
*
* @var string
*/
public $operationState;
protected $pitrSnapshotType = GoogleFirestoreAdminV1PitrSnapshot::class;
protected $pitrSnapshotDataType = '';
protected $progressPercentageType = GoogleFirestoreAdminV1Progress::class;
protected $progressPercentageDataType = '';
/**
* The time the clone was started.
*
* @var string
*/
public $startTime;
/**
* The name of the database being cloned to.
*
* @param string $database
*/
public function setDatabase($database)
{
$this->database = $database;
}
/**
* @return string
*/
public function getDatabase()
{
return $this->database;
}
/**
* The time the clone finished, unset for ongoing clones.
*
* @param string $endTime
*/
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
/**
* @return string
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* The operation state of the clone.
*
* Accepted values: OPERATION_STATE_UNSPECIFIED, INITIALIZING, PROCESSING,
* CANCELLING, FINALIZING, SUCCESSFUL, FAILED, CANCELLED
*
* @param self::OPERATION_STATE_* $operationState
*/
public function setOperationState($operationState)
{
$this->operationState = $operationState;
}
/**
* @return self::OPERATION_STATE_*
*/
public function getOperationState()
{
return $this->operationState;
}
/**
* The snapshot from which this database was cloned.
*
* @param GoogleFirestoreAdminV1PitrSnapshot $pitrSnapshot
*/
public function setPitrSnapshot(GoogleFirestoreAdminV1PitrSnapshot $pitrSnapshot)
{
$this->pitrSnapshot = $pitrSnapshot;
}
/**
* @return GoogleFirestoreAdminV1PitrSnapshot
*/
public function getPitrSnapshot()
{
return $this->pitrSnapshot;
}
/**
* How far along the clone is as an estimated percentage of remaining time.
*
* @param GoogleFirestoreAdminV1Progress $progressPercentage
*/
public function setProgressPercentage(GoogleFirestoreAdminV1Progress $progressPercentage)
{
$this->progressPercentage = $progressPercentage;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressPercentage()
{
return $this->progressPercentage;
}
/**
* The time the clone was started.
*
* @param string $startTime
*/
public function setStartTime($startTime)
{
$this->startTime = $startTime;
}
/**
* @return string
*/
public function getStartTime()
{
return $this->startTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1CloneDatabaseMetadata::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1CloneDatabaseMetadata');

View File

@@ -0,0 +1,126 @@
<?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 GoogleFirestoreAdminV1CloneDatabaseRequest extends \Google\Model
{
/**
* Required. The ID to use for the database, which will become the final
* component of the database's resource name. This database ID must not be
* associated with an existing database. This value should be 4-63 characters.
* Valid characters are /a-z-/ with first character a letter and the last a
* letter or a number. Must not be UUID-like
* /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is
* also valid if the database is Standard edition.
*
* @var string
*/
public $databaseId;
protected $encryptionConfigType = GoogleFirestoreAdminV1EncryptionConfig::class;
protected $encryptionConfigDataType = '';
protected $pitrSnapshotType = GoogleFirestoreAdminV1PitrSnapshot::class;
protected $pitrSnapshotDataType = '';
/**
* Optional. Immutable. Tags to be bound to the cloned database. The tags
* should be provided in the format of `tagKeys/{tag_key_id} ->
* tagValues/{tag_value_id}`.
*
* @var string[]
*/
public $tags;
/**
* Required. The ID to use for the database, which will become the final
* component of the database's resource name. This database ID must not be
* associated with an existing database. This value should be 4-63 characters.
* Valid characters are /a-z-/ with first character a letter and the last a
* letter or a number. Must not be UUID-like
* /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is
* also valid if the database is Standard edition.
*
* @param string $databaseId
*/
public function setDatabaseId($databaseId)
{
$this->databaseId = $databaseId;
}
/**
* @return string
*/
public function getDatabaseId()
{
return $this->databaseId;
}
/**
* Optional. Encryption configuration for the cloned database. If this field
* is not specified, the cloned database will use the same encryption
* configuration as the source database, namely use_source_encryption.
*
* @param GoogleFirestoreAdminV1EncryptionConfig $encryptionConfig
*/
public function setEncryptionConfig(GoogleFirestoreAdminV1EncryptionConfig $encryptionConfig)
{
$this->encryptionConfig = $encryptionConfig;
}
/**
* @return GoogleFirestoreAdminV1EncryptionConfig
*/
public function getEncryptionConfig()
{
return $this->encryptionConfig;
}
/**
* Required. Specification of the PITR data to clone from. The source database
* must exist. The cloned database will be created in the same location as the
* source database.
*
* @param GoogleFirestoreAdminV1PitrSnapshot $pitrSnapshot
*/
public function setPitrSnapshot(GoogleFirestoreAdminV1PitrSnapshot $pitrSnapshot)
{
$this->pitrSnapshot = $pitrSnapshot;
}
/**
* @return GoogleFirestoreAdminV1PitrSnapshot
*/
public function getPitrSnapshot()
{
return $this->pitrSnapshot;
}
/**
* Optional. Immutable. Tags to be bound to the cloned database. The tags
* should be provided in the format of `tagKeys/{tag_key_id} ->
* tagValues/{tag_value_id}`.
*
* @param string[] $tags
*/
public function setTags($tags)
{
$this->tags = $tags;
}
/**
* @return string[]
*/
public function getTags()
{
return $this->tags;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1CloneDatabaseRequest::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1CloneDatabaseRequest');

View File

@@ -0,0 +1,95 @@
<?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 GoogleFirestoreAdminV1CmekConfig extends \Google\Collection
{
protected $collection_key = 'activeKeyVersion';
/**
* Output only. Currently in-use [KMS key
* versions](https://cloud.google.com/kms/docs/resource-
* hierarchy#key_versions). During [key
* rotation](https://cloud.google.com/kms/docs/key-rotation), there can be
* multiple in-use key versions. The expected format is `projects/{project_id}
* /locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/crypt
* oKeyVersions/{key_version}`.
*
* @var string[]
*/
public $activeKeyVersion;
/**
* Required. Only keys in the same location as this database are allowed to be
* used for encryption. For Firestore's nam5 multi-region, this corresponds to
* Cloud KMS multi-region us. For Firestore's eur3 multi-region, this
* corresponds to Cloud KMS multi-region europe. See
* https://cloud.google.com/kms/docs/locations. The expected format is `projec
* ts/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{cr
* ypto_key}`.
*
* @var string
*/
public $kmsKeyName;
/**
* Output only. Currently in-use [KMS key
* versions](https://cloud.google.com/kms/docs/resource-
* hierarchy#key_versions). During [key
* rotation](https://cloud.google.com/kms/docs/key-rotation), there can be
* multiple in-use key versions. The expected format is `projects/{project_id}
* /locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/crypt
* oKeyVersions/{key_version}`.
*
* @param string[] $activeKeyVersion
*/
public function setActiveKeyVersion($activeKeyVersion)
{
$this->activeKeyVersion = $activeKeyVersion;
}
/**
* @return string[]
*/
public function getActiveKeyVersion()
{
return $this->activeKeyVersion;
}
/**
* Required. Only keys in the same location as this database are allowed to be
* used for encryption. For Firestore's nam5 multi-region, this corresponds to
* Cloud KMS multi-region us. For Firestore's eur3 multi-region, this
* corresponds to Cloud KMS multi-region europe. See
* https://cloud.google.com/kms/docs/locations. The expected format is `projec
* ts/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{cr
* ypto_key}`.
*
* @param string $kmsKeyName
*/
public function setKmsKeyName($kmsKeyName)
{
$this->kmsKeyName = $kmsKeyName;
}
/**
* @return string
*/
public function getKmsKeyName()
{
return $this->kmsKeyName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1CmekConfig::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1CmekConfig');

View File

@@ -0,0 +1,25 @@
<?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 GoogleFirestoreAdminV1CreateDatabaseMetadata extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1CreateDatabaseMetadata::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1CreateDatabaseMetadata');

View File

@@ -0,0 +1,60 @@
<?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 GoogleFirestoreAdminV1CustomerManagedEncryptionOptions extends \Google\Model
{
/**
* Required. Only keys in the same location as the database are allowed to be
* used for encryption. For Firestore's nam5 multi-region, this corresponds to
* Cloud KMS multi-region us. For Firestore's eur3 multi-region, this
* corresponds to Cloud KMS multi-region europe. See
* https://cloud.google.com/kms/docs/locations. The expected format is `projec
* ts/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{cr
* ypto_key}`.
*
* @var string
*/
public $kmsKeyName;
/**
* Required. Only keys in the same location as the database are allowed to be
* used for encryption. For Firestore's nam5 multi-region, this corresponds to
* Cloud KMS multi-region us. For Firestore's eur3 multi-region, this
* corresponds to Cloud KMS multi-region europe. See
* https://cloud.google.com/kms/docs/locations. The expected format is `projec
* ts/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{cr
* ypto_key}`.
*
* @param string $kmsKeyName
*/
public function setKmsKeyName($kmsKeyName)
{
$this->kmsKeyName = $kmsKeyName;
}
/**
* @return string
*/
public function getKmsKeyName()
{
return $this->kmsKeyName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1CustomerManagedEncryptionOptions::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1CustomerManagedEncryptionOptions');

View File

@@ -0,0 +1,25 @@
<?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 GoogleFirestoreAdminV1DailyRecurrence extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1DailyRecurrence::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1DailyRecurrence');

View File

@@ -0,0 +1,782 @@
<?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 GoogleFirestoreAdminV1Database extends \Google\Model
{
/**
* Not used.
*/
public const APP_ENGINE_INTEGRATION_MODE_APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED = 'APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED';
/**
* If an App Engine application exists in the same region as this database,
* App Engine configuration will impact this database. This includes disabling
* of the application & database, as well as disabling writes to the database.
*/
public const APP_ENGINE_INTEGRATION_MODE_ENABLED = 'ENABLED';
/**
* App Engine has no effect on the ability of this database to serve requests.
* This is the default setting for databases created with the Firestore API.
*/
public const APP_ENGINE_INTEGRATION_MODE_DISABLED = 'DISABLED';
/**
* Not used.
*/
public const CONCURRENCY_MODE_CONCURRENCY_MODE_UNSPECIFIED = 'CONCURRENCY_MODE_UNSPECIFIED';
/**
* Use optimistic concurrency control by default. This mode is available for
* Cloud Firestore databases. This is the default setting for Cloud Firestore
* Enterprise Edition databases.
*/
public const CONCURRENCY_MODE_OPTIMISTIC = 'OPTIMISTIC';
/**
* Use pessimistic concurrency control by default. This mode is available for
* Cloud Firestore databases. This is the default setting for Cloud Firestore
* Standard Edition databases.
*/
public const CONCURRENCY_MODE_PESSIMISTIC = 'PESSIMISTIC';
/**
* Use optimistic concurrency control with entity groups by default. This mode
* is enabled for some databases that were automatically upgraded from Cloud
* Datastore to Cloud Firestore with Datastore Mode. It is not recommended for
* any new databases, and not supported for Firestore Native databases.
*/
public const CONCURRENCY_MODE_OPTIMISTIC_WITH_ENTITY_GROUPS = 'OPTIMISTIC_WITH_ENTITY_GROUPS';
/**
* Not used.
*/
public const DATABASE_EDITION_DATABASE_EDITION_UNSPECIFIED = 'DATABASE_EDITION_UNSPECIFIED';
/**
* Standard edition. This is the default setting if not specified.
*/
public const DATABASE_EDITION_STANDARD = 'STANDARD';
/**
* Enterprise edition.
*/
public const DATABASE_EDITION_ENTERPRISE = 'ENTERPRISE';
/**
* The default value. Delete protection type is not specified
*/
public const DELETE_PROTECTION_STATE_DELETE_PROTECTION_STATE_UNSPECIFIED = 'DELETE_PROTECTION_STATE_UNSPECIFIED';
/**
* Delete protection is disabled
*/
public const DELETE_PROTECTION_STATE_DELETE_PROTECTION_DISABLED = 'DELETE_PROTECTION_DISABLED';
/**
* Delete protection is enabled
*/
public const DELETE_PROTECTION_STATE_DELETE_PROTECTION_ENABLED = 'DELETE_PROTECTION_ENABLED';
/**
* Not Used.
*/
public const FIRESTORE_DATA_ACCESS_MODE_DATA_ACCESS_MODE_UNSPECIFIED = 'DATA_ACCESS_MODE_UNSPECIFIED';
/**
* Accessing the database through the API is allowed.
*/
public const FIRESTORE_DATA_ACCESS_MODE_DATA_ACCESS_MODE_ENABLED = 'DATA_ACCESS_MODE_ENABLED';
/**
* Accessing the database through the API is disallowed.
*/
public const FIRESTORE_DATA_ACCESS_MODE_DATA_ACCESS_MODE_DISABLED = 'DATA_ACCESS_MODE_DISABLED';
/**
* Not Used.
*/
public const MONGODB_COMPATIBLE_DATA_ACCESS_MODE_DATA_ACCESS_MODE_UNSPECIFIED = 'DATA_ACCESS_MODE_UNSPECIFIED';
/**
* Accessing the database through the API is allowed.
*/
public const MONGODB_COMPATIBLE_DATA_ACCESS_MODE_DATA_ACCESS_MODE_ENABLED = 'DATA_ACCESS_MODE_ENABLED';
/**
* Accessing the database through the API is disallowed.
*/
public const MONGODB_COMPATIBLE_DATA_ACCESS_MODE_DATA_ACCESS_MODE_DISABLED = 'DATA_ACCESS_MODE_DISABLED';
/**
* Not used.
*/
public const POINT_IN_TIME_RECOVERY_ENABLEMENT_POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED = 'POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED';
/**
* Reads are supported on selected versions of the data from within the past 7
* days: * Reads against any timestamp within the past hour * Reads against
* 1-minute snapshots beyond 1 hour and within 7 days
* `version_retention_period` and `earliest_version_time` can be used to
* determine the supported versions.
*/
public const POINT_IN_TIME_RECOVERY_ENABLEMENT_POINT_IN_TIME_RECOVERY_ENABLED = 'POINT_IN_TIME_RECOVERY_ENABLED';
/**
* Reads are supported on any version of the data from within the past 1 hour.
*/
public const POINT_IN_TIME_RECOVERY_ENABLEMENT_POINT_IN_TIME_RECOVERY_DISABLED = 'POINT_IN_TIME_RECOVERY_DISABLED';
/**
* The Realtime Updates feature is not specified.
*/
public const REALTIME_UPDATES_MODE_REALTIME_UPDATES_MODE_UNSPECIFIED = 'REALTIME_UPDATES_MODE_UNSPECIFIED';
/**
* The Realtime Updates feature is enabled by default. This could potentially
* degrade write performance for the database.
*/
public const REALTIME_UPDATES_MODE_REALTIME_UPDATES_MODE_ENABLED = 'REALTIME_UPDATES_MODE_ENABLED';
/**
* The Realtime Updates feature is disabled by default.
*/
public const REALTIME_UPDATES_MODE_REALTIME_UPDATES_MODE_DISABLED = 'REALTIME_UPDATES_MODE_DISABLED';
/**
* Not used.
*/
public const TYPE_DATABASE_TYPE_UNSPECIFIED = 'DATABASE_TYPE_UNSPECIFIED';
/**
* Firestore Native Mode
*/
public const TYPE_FIRESTORE_NATIVE = 'FIRESTORE_NATIVE';
/**
* Firestore in Datastore Mode.
*/
public const TYPE_DATASTORE_MODE = 'DATASTORE_MODE';
/**
* The App Engine integration mode to use for this database.
*
* @var string
*/
public $appEngineIntegrationMode;
protected $cmekConfigType = GoogleFirestoreAdminV1CmekConfig::class;
protected $cmekConfigDataType = '';
/**
* The concurrency control mode to use for this database. If unspecified in a
* CreateDatabase request, this will default based on the database edition:
* Optimistic for Enterprise and Pessimistic for all other databases.
*
* @var string
*/
public $concurrencyMode;
/**
* Output only. The timestamp at which this database was created. Databases
* created before 2016 do not populate create_time.
*
* @var string
*/
public $createTime;
/**
* Immutable. The edition of the database.
*
* @var string
*/
public $databaseEdition;
/**
* State of delete protection for the database.
*
* @var string
*/
public $deleteProtectionState;
/**
* Output only. The timestamp at which this database was deleted. Only set if
* the database has been deleted.
*
* @var string
*/
public $deleteTime;
/**
* Output only. The earliest timestamp at which older versions of the data can
* be read from the database. See [version_retention_period] above; this field
* is populated with `now - version_retention_period`. This value is
* continuously updated, and becomes stale the moment it is queried. If you
* are using this value to recover data, make sure to account for the time
* from the moment when the value is queried to the moment when you initiate
* the recovery.
*
* @var string
*/
public $earliestVersionTime;
/**
* This checksum is computed by the server based on the value of other fields,
* and may be sent on update and delete requests to ensure the client has an
* up-to-date value before proceeding.
*
* @var string
*/
public $etag;
/**
* Optional. The Firestore API data access mode to use for this database. If
* not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for
* Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for
* Standard Edition.
*
* @var string
*/
public $firestoreDataAccessMode;
/**
* Output only. Background: Free tier is the ability of a Firestore database
* to use a small amount of resources every day without being charged. Once
* usage exceeds the free tier limit further usage is charged. Whether this
* database can make use of the free tier. Only one database per project can
* be eligible for the free tier. The first (or next) database that is created
* in a project without a free tier database will be marked as eligible for
* the free tier. Databases that are created while there is a free tier
* database will not be eligible for the free tier.
*
* @var bool
*/
public $freeTier;
/**
* Output only. The key_prefix for this database. This key_prefix is used, in
* combination with the project ID ("~") to construct the application ID that
* is returned from the Cloud Datastore APIs in Google App Engine first
* generation runtimes. This value may be empty in which case the appid to use
* for URL-encoded keys is the project_id (eg: foo instead of v~foo).
*
* @var string
*/
public $keyPrefix;
/**
* The location of the database. Available locations are listed at
* https://cloud.google.com/firestore/docs/locations.
*
* @var string
*/
public $locationId;
/**
* Optional. The MongoDB compatible API data access mode to use for this
* database. If not set on write, the default value is
* DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always
* DATA_ACCESS_MODE_DISABLED for Standard Edition.
*
* @var string
*/
public $mongodbCompatibleDataAccessMode;
/**
* The resource name of the Database. Format:
* `projects/{project}/databases/{database}`
*
* @var string
*/
public $name;
/**
* Whether to enable the PITR feature on this database.
*
* @var string
*/
public $pointInTimeRecoveryEnablement;
/**
* Output only. The database resource's prior database ID. This field is only
* populated for deleted databases.
*
* @var string
*/
public $previousId;
/**
* Immutable. The default Realtime Updates mode to use for this database.
*
* @var string
*/
public $realtimeUpdatesMode;
protected $sourceInfoType = GoogleFirestoreAdminV1SourceInfo::class;
protected $sourceInfoDataType = '';
/**
* Optional. Input only. Immutable. Tag keys/values directly bound to this
* resource. For example: "123/environment": "production", "123/costCenter":
* "marketing"
*
* @var string[]
*/
public $tags;
/**
* The type of the database. See
* https://cloud.google.com/datastore/docs/firestore-or-datastore for
* information about how to choose.
*
* @var string
*/
public $type;
/**
* Output only. The system-generated UUID4 for this Database.
*
* @var string
*/
public $uid;
/**
* Output only. The timestamp at which this database was most recently
* updated. Note this only includes updates to the database resource and not
* data contained by the database.
*
* @var string
*/
public $updateTime;
/**
* Output only. The period during which past versions of data are retained in
* the database. Any read or query can specify a `read_time` within this
* window, and will read the state of the database at that time. If the PITR
* feature is enabled, the retention period is 7 days. Otherwise, the
* retention period is 1 hour.
*
* @var string
*/
public $versionRetentionPeriod;
/**
* The App Engine integration mode to use for this database.
*
* Accepted values: APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED, ENABLED, DISABLED
*
* @param self::APP_ENGINE_INTEGRATION_MODE_* $appEngineIntegrationMode
*/
public function setAppEngineIntegrationMode($appEngineIntegrationMode)
{
$this->appEngineIntegrationMode = $appEngineIntegrationMode;
}
/**
* @return self::APP_ENGINE_INTEGRATION_MODE_*
*/
public function getAppEngineIntegrationMode()
{
return $this->appEngineIntegrationMode;
}
/**
* Optional. Presence indicates CMEK is enabled for this database.
*
* @param GoogleFirestoreAdminV1CmekConfig $cmekConfig
*/
public function setCmekConfig(GoogleFirestoreAdminV1CmekConfig $cmekConfig)
{
$this->cmekConfig = $cmekConfig;
}
/**
* @return GoogleFirestoreAdminV1CmekConfig
*/
public function getCmekConfig()
{
return $this->cmekConfig;
}
/**
* The concurrency control mode to use for this database. If unspecified in a
* CreateDatabase request, this will default based on the database edition:
* Optimistic for Enterprise and Pessimistic for all other databases.
*
* Accepted values: CONCURRENCY_MODE_UNSPECIFIED, OPTIMISTIC, PESSIMISTIC,
* OPTIMISTIC_WITH_ENTITY_GROUPS
*
* @param self::CONCURRENCY_MODE_* $concurrencyMode
*/
public function setConcurrencyMode($concurrencyMode)
{
$this->concurrencyMode = $concurrencyMode;
}
/**
* @return self::CONCURRENCY_MODE_*
*/
public function getConcurrencyMode()
{
return $this->concurrencyMode;
}
/**
* Output only. The timestamp at which this database was created. Databases
* created before 2016 do not populate create_time.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* Immutable. The edition of the database.
*
* Accepted values: DATABASE_EDITION_UNSPECIFIED, STANDARD, ENTERPRISE
*
* @param self::DATABASE_EDITION_* $databaseEdition
*/
public function setDatabaseEdition($databaseEdition)
{
$this->databaseEdition = $databaseEdition;
}
/**
* @return self::DATABASE_EDITION_*
*/
public function getDatabaseEdition()
{
return $this->databaseEdition;
}
/**
* State of delete protection for the database.
*
* Accepted values: DELETE_PROTECTION_STATE_UNSPECIFIED,
* DELETE_PROTECTION_DISABLED, DELETE_PROTECTION_ENABLED
*
* @param self::DELETE_PROTECTION_STATE_* $deleteProtectionState
*/
public function setDeleteProtectionState($deleteProtectionState)
{
$this->deleteProtectionState = $deleteProtectionState;
}
/**
* @return self::DELETE_PROTECTION_STATE_*
*/
public function getDeleteProtectionState()
{
return $this->deleteProtectionState;
}
/**
* Output only. The timestamp at which this database was deleted. Only set if
* the database has been deleted.
*
* @param string $deleteTime
*/
public function setDeleteTime($deleteTime)
{
$this->deleteTime = $deleteTime;
}
/**
* @return string
*/
public function getDeleteTime()
{
return $this->deleteTime;
}
/**
* Output only. The earliest timestamp at which older versions of the data can
* be read from the database. See [version_retention_period] above; this field
* is populated with `now - version_retention_period`. This value is
* continuously updated, and becomes stale the moment it is queried. If you
* are using this value to recover data, make sure to account for the time
* from the moment when the value is queried to the moment when you initiate
* the recovery.
*
* @param string $earliestVersionTime
*/
public function setEarliestVersionTime($earliestVersionTime)
{
$this->earliestVersionTime = $earliestVersionTime;
}
/**
* @return string
*/
public function getEarliestVersionTime()
{
return $this->earliestVersionTime;
}
/**
* This checksum is computed by the server based on the value of other fields,
* and may be sent on update and delete requests to ensure the client has an
* up-to-date value before proceeding.
*
* @param string $etag
*/
public function setEtag($etag)
{
$this->etag = $etag;
}
/**
* @return string
*/
public function getEtag()
{
return $this->etag;
}
/**
* Optional. The Firestore API data access mode to use for this database. If
* not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for
* Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for
* Standard Edition.
*
* Accepted values: DATA_ACCESS_MODE_UNSPECIFIED, DATA_ACCESS_MODE_ENABLED,
* DATA_ACCESS_MODE_DISABLED
*
* @param self::FIRESTORE_DATA_ACCESS_MODE_* $firestoreDataAccessMode
*/
public function setFirestoreDataAccessMode($firestoreDataAccessMode)
{
$this->firestoreDataAccessMode = $firestoreDataAccessMode;
}
/**
* @return self::FIRESTORE_DATA_ACCESS_MODE_*
*/
public function getFirestoreDataAccessMode()
{
return $this->firestoreDataAccessMode;
}
/**
* Output only. Background: Free tier is the ability of a Firestore database
* to use a small amount of resources every day without being charged. Once
* usage exceeds the free tier limit further usage is charged. Whether this
* database can make use of the free tier. Only one database per project can
* be eligible for the free tier. The first (or next) database that is created
* in a project without a free tier database will be marked as eligible for
* the free tier. Databases that are created while there is a free tier
* database will not be eligible for the free tier.
*
* @param bool $freeTier
*/
public function setFreeTier($freeTier)
{
$this->freeTier = $freeTier;
}
/**
* @return bool
*/
public function getFreeTier()
{
return $this->freeTier;
}
/**
* Output only. The key_prefix for this database. This key_prefix is used, in
* combination with the project ID ("~") to construct the application ID that
* is returned from the Cloud Datastore APIs in Google App Engine first
* generation runtimes. This value may be empty in which case the appid to use
* for URL-encoded keys is the project_id (eg: foo instead of v~foo).
*
* @param string $keyPrefix
*/
public function setKeyPrefix($keyPrefix)
{
$this->keyPrefix = $keyPrefix;
}
/**
* @return string
*/
public function getKeyPrefix()
{
return $this->keyPrefix;
}
/**
* The location of the database. Available locations are listed at
* https://cloud.google.com/firestore/docs/locations.
*
* @param string $locationId
*/
public function setLocationId($locationId)
{
$this->locationId = $locationId;
}
/**
* @return string
*/
public function getLocationId()
{
return $this->locationId;
}
/**
* Optional. The MongoDB compatible API data access mode to use for this
* database. If not set on write, the default value is
* DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always
* DATA_ACCESS_MODE_DISABLED for Standard Edition.
*
* Accepted values: DATA_ACCESS_MODE_UNSPECIFIED, DATA_ACCESS_MODE_ENABLED,
* DATA_ACCESS_MODE_DISABLED
*
* @param self::MONGODB_COMPATIBLE_DATA_ACCESS_MODE_* $mongodbCompatibleDataAccessMode
*/
public function setMongodbCompatibleDataAccessMode($mongodbCompatibleDataAccessMode)
{
$this->mongodbCompatibleDataAccessMode = $mongodbCompatibleDataAccessMode;
}
/**
* @return self::MONGODB_COMPATIBLE_DATA_ACCESS_MODE_*
*/
public function getMongodbCompatibleDataAccessMode()
{
return $this->mongodbCompatibleDataAccessMode;
}
/**
* The resource name of the Database. Format:
* `projects/{project}/databases/{database}`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Whether to enable the PITR feature on this database.
*
* Accepted values: POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED,
* POINT_IN_TIME_RECOVERY_ENABLED, POINT_IN_TIME_RECOVERY_DISABLED
*
* @param self::POINT_IN_TIME_RECOVERY_ENABLEMENT_* $pointInTimeRecoveryEnablement
*/
public function setPointInTimeRecoveryEnablement($pointInTimeRecoveryEnablement)
{
$this->pointInTimeRecoveryEnablement = $pointInTimeRecoveryEnablement;
}
/**
* @return self::POINT_IN_TIME_RECOVERY_ENABLEMENT_*
*/
public function getPointInTimeRecoveryEnablement()
{
return $this->pointInTimeRecoveryEnablement;
}
/**
* Output only. The database resource's prior database ID. This field is only
* populated for deleted databases.
*
* @param string $previousId
*/
public function setPreviousId($previousId)
{
$this->previousId = $previousId;
}
/**
* @return string
*/
public function getPreviousId()
{
return $this->previousId;
}
/**
* Immutable. The default Realtime Updates mode to use for this database.
*
* Accepted values: REALTIME_UPDATES_MODE_UNSPECIFIED,
* REALTIME_UPDATES_MODE_ENABLED, REALTIME_UPDATES_MODE_DISABLED
*
* @param self::REALTIME_UPDATES_MODE_* $realtimeUpdatesMode
*/
public function setRealtimeUpdatesMode($realtimeUpdatesMode)
{
$this->realtimeUpdatesMode = $realtimeUpdatesMode;
}
/**
* @return self::REALTIME_UPDATES_MODE_*
*/
public function getRealtimeUpdatesMode()
{
return $this->realtimeUpdatesMode;
}
/**
* Output only. Information about the provenance of this database.
*
* @param GoogleFirestoreAdminV1SourceInfo $sourceInfo
*/
public function setSourceInfo(GoogleFirestoreAdminV1SourceInfo $sourceInfo)
{
$this->sourceInfo = $sourceInfo;
}
/**
* @return GoogleFirestoreAdminV1SourceInfo
*/
public function getSourceInfo()
{
return $this->sourceInfo;
}
/**
* Optional. Input only. Immutable. Tag keys/values directly bound to this
* resource. For example: "123/environment": "production", "123/costCenter":
* "marketing"
*
* @param string[] $tags
*/
public function setTags($tags)
{
$this->tags = $tags;
}
/**
* @return string[]
*/
public function getTags()
{
return $this->tags;
}
/**
* The type of the database. See
* https://cloud.google.com/datastore/docs/firestore-or-datastore for
* information about how to choose.
*
* Accepted values: DATABASE_TYPE_UNSPECIFIED, FIRESTORE_NATIVE,
* DATASTORE_MODE
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
/**
* Output only. The system-generated UUID4 for this Database.
*
* @param string $uid
*/
public function setUid($uid)
{
$this->uid = $uid;
}
/**
* @return string
*/
public function getUid()
{
return $this->uid;
}
/**
* Output only. The timestamp at which this database was most recently
* updated. Note this only includes updates to the database resource and not
* data contained by the database.
*
* @param string $updateTime
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
/**
* Output only. The period during which past versions of data are retained in
* the database. Any read or query can specify a `read_time` within this
* window, and will read the state of the database at that time. If the PITR
* feature is enabled, the retention period is 7 days. Otherwise, the
* retention period is 1 hour.
*
* @param string $versionRetentionPeriod
*/
public function setVersionRetentionPeriod($versionRetentionPeriod)
{
$this->versionRetentionPeriod = $versionRetentionPeriod;
}
/**
* @return string
*/
public function getVersionRetentionPeriod()
{
return $this->versionRetentionPeriod;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1Database::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1Database');

View File

@@ -0,0 +1,62 @@
<?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 GoogleFirestoreAdminV1DatabaseSnapshot extends \Google\Model
{
/**
* @var string
*/
public $database;
/**
* @var string
*/
public $snapshotTime;
/**
* @param string
*/
public function setDatabase($database)
{
$this->database = $database;
}
/**
* @return string
*/
public function getDatabase()
{
return $this->database;
}
/**
* @param string
*/
public function setSnapshotTime($snapshotTime)
{
$this->snapshotTime = $snapshotTime;
}
/**
* @return string
*/
public function getSnapshotTime()
{
return $this->snapshotTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1DatabaseSnapshot::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1DatabaseSnapshot');

View File

@@ -0,0 +1,25 @@
<?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 GoogleFirestoreAdminV1DeleteDatabaseMetadata extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1DeleteDatabaseMetadata::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1DeleteDatabaseMetadata');

View File

@@ -0,0 +1,25 @@
<?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 GoogleFirestoreAdminV1DisableUserCredsRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1DisableUserCredsRequest::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1DisableUserCredsRequest');

View File

@@ -0,0 +1,25 @@
<?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 GoogleFirestoreAdminV1EnableUserCredsRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1EnableUserCredsRequest::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1EnableUserCredsRequest');

View File

@@ -0,0 +1,80 @@
<?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 GoogleFirestoreAdminV1EncryptionConfig extends \Google\Model
{
protected $customerManagedEncryptionType = GoogleFirestoreAdminV1CustomerManagedEncryptionOptions::class;
protected $customerManagedEncryptionDataType = '';
protected $googleDefaultEncryptionType = GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions::class;
protected $googleDefaultEncryptionDataType = '';
protected $useSourceEncryptionType = GoogleFirestoreAdminV1SourceEncryptionOptions::class;
protected $useSourceEncryptionDataType = '';
/**
* Use Customer Managed Encryption Keys (CMEK) for encryption.
*
* @param GoogleFirestoreAdminV1CustomerManagedEncryptionOptions $customerManagedEncryption
*/
public function setCustomerManagedEncryption(GoogleFirestoreAdminV1CustomerManagedEncryptionOptions $customerManagedEncryption)
{
$this->customerManagedEncryption = $customerManagedEncryption;
}
/**
* @return GoogleFirestoreAdminV1CustomerManagedEncryptionOptions
*/
public function getCustomerManagedEncryption()
{
return $this->customerManagedEncryption;
}
/**
* Use Google default encryption.
*
* @param GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions $googleDefaultEncryption
*/
public function setGoogleDefaultEncryption(GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions $googleDefaultEncryption)
{
$this->googleDefaultEncryption = $googleDefaultEncryption;
}
/**
* @return GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions
*/
public function getGoogleDefaultEncryption()
{
return $this->googleDefaultEncryption;
}
/**
* The database will use the same encryption configuration as the source.
*
* @param GoogleFirestoreAdminV1SourceEncryptionOptions $useSourceEncryption
*/
public function setUseSourceEncryption(GoogleFirestoreAdminV1SourceEncryptionOptions $useSourceEncryption)
{
$this->useSourceEncryption = $useSourceEncryption;
}
/**
* @return GoogleFirestoreAdminV1SourceEncryptionOptions
*/
public function getUseSourceEncryption()
{
return $this->useSourceEncryption;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1EncryptionConfig::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1EncryptionConfig');

View File

@@ -0,0 +1,260 @@
<?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 GoogleFirestoreAdminV1ExportDocumentsMetadata extends \Google\Collection
{
/**
* Unspecified.
*/
public const OPERATION_STATE_OPERATION_STATE_UNSPECIFIED = 'OPERATION_STATE_UNSPECIFIED';
/**
* Request is being prepared for processing.
*/
public const OPERATION_STATE_INITIALIZING = 'INITIALIZING';
/**
* Request is actively being processed.
*/
public const OPERATION_STATE_PROCESSING = 'PROCESSING';
/**
* Request is in the process of being cancelled after user called
* google.longrunning.Operations.CancelOperation on the operation.
*/
public const OPERATION_STATE_CANCELLING = 'CANCELLING';
/**
* Request has been processed and is in its finalization stage.
*/
public const OPERATION_STATE_FINALIZING = 'FINALIZING';
/**
* Request has completed successfully.
*/
public const OPERATION_STATE_SUCCESSFUL = 'SUCCESSFUL';
/**
* Request has finished being processed, but encountered an error.
*/
public const OPERATION_STATE_FAILED = 'FAILED';
/**
* Request has finished being cancelled after user called
* google.longrunning.Operations.CancelOperation.
*/
public const OPERATION_STATE_CANCELLED = 'CANCELLED';
protected $collection_key = 'namespaceIds';
/**
* Which collection IDs are being exported.
*
* @var string[]
*/
public $collectionIds;
/**
* The time this operation completed. Will be unset if operation still in
* progress.
*
* @var string
*/
public $endTime;
/**
* Which namespace IDs are being exported.
*
* @var string[]
*/
public $namespaceIds;
/**
* The state of the export operation.
*
* @var string
*/
public $operationState;
/**
* Where the documents are being exported to.
*
* @var string
*/
public $outputUriPrefix;
protected $progressBytesType = GoogleFirestoreAdminV1Progress::class;
protected $progressBytesDataType = '';
protected $progressDocumentsType = GoogleFirestoreAdminV1Progress::class;
protected $progressDocumentsDataType = '';
/**
* The timestamp that corresponds to the version of the database that is being
* exported. If unspecified, there are no guarantees about the consistency of
* the documents being exported.
*
* @var string
*/
public $snapshotTime;
/**
* The time this operation started.
*
* @var string
*/
public $startTime;
/**
* Which collection IDs are being exported.
*
* @param string[] $collectionIds
*/
public function setCollectionIds($collectionIds)
{
$this->collectionIds = $collectionIds;
}
/**
* @return string[]
*/
public function getCollectionIds()
{
return $this->collectionIds;
}
/**
* The time this operation completed. Will be unset if operation still in
* progress.
*
* @param string $endTime
*/
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
/**
* @return string
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* Which namespace IDs are being exported.
*
* @param string[] $namespaceIds
*/
public function setNamespaceIds($namespaceIds)
{
$this->namespaceIds = $namespaceIds;
}
/**
* @return string[]
*/
public function getNamespaceIds()
{
return $this->namespaceIds;
}
/**
* The state of the export operation.
*
* Accepted values: OPERATION_STATE_UNSPECIFIED, INITIALIZING, PROCESSING,
* CANCELLING, FINALIZING, SUCCESSFUL, FAILED, CANCELLED
*
* @param self::OPERATION_STATE_* $operationState
*/
public function setOperationState($operationState)
{
$this->operationState = $operationState;
}
/**
* @return self::OPERATION_STATE_*
*/
public function getOperationState()
{
return $this->operationState;
}
/**
* Where the documents are being exported to.
*
* @param string $outputUriPrefix
*/
public function setOutputUriPrefix($outputUriPrefix)
{
$this->outputUriPrefix = $outputUriPrefix;
}
/**
* @return string
*/
public function getOutputUriPrefix()
{
return $this->outputUriPrefix;
}
/**
* The progress, in bytes, of this operation.
*
* @param GoogleFirestoreAdminV1Progress $progressBytes
*/
public function setProgressBytes(GoogleFirestoreAdminV1Progress $progressBytes)
{
$this->progressBytes = $progressBytes;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressBytes()
{
return $this->progressBytes;
}
/**
* The progress, in documents, of this operation.
*
* @param GoogleFirestoreAdminV1Progress $progressDocuments
*/
public function setProgressDocuments(GoogleFirestoreAdminV1Progress $progressDocuments)
{
$this->progressDocuments = $progressDocuments;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressDocuments()
{
return $this->progressDocuments;
}
/**
* The timestamp that corresponds to the version of the database that is being
* exported. If unspecified, there are no guarantees about the consistency of
* the documents being exported.
*
* @param string $snapshotTime
*/
public function setSnapshotTime($snapshotTime)
{
$this->snapshotTime = $snapshotTime;
}
/**
* @return string
*/
public function getSnapshotTime()
{
return $this->snapshotTime;
}
/**
* The time this operation started.
*
* @param string $startTime
*/
public function setStartTime($startTime)
{
$this->startTime = $startTime;
}
/**
* @return string
*/
public function getStartTime()
{
return $this->startTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ExportDocumentsMetadata::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ExportDocumentsMetadata');

View File

@@ -0,0 +1,149 @@
<?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 GoogleFirestoreAdminV1ExportDocumentsRequest extends \Google\Collection
{
protected $collection_key = 'namespaceIds';
/**
* IDs of the collection groups to export. Unspecified means all collection
* groups. Each collection group in this list must be unique.
*
* @var string[]
*/
public $collectionIds;
/**
* An empty list represents all namespaces. This is the preferred usage for
* databases that don't use namespaces. An empty string element represents the
* default namespace. This should be used if the database has data in non-
* default namespaces, but doesn't want to include them. Each namespace in
* this list must be unique.
*
* @var string[]
*/
public $namespaceIds;
/**
* The output URI. Currently only supports Google Cloud Storage URIs of the
* form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
* of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
* Google Cloud Storage namespace path. When choosing a name, be sure to
* consider Google Cloud Storage naming guidelines:
* https://cloud.google.com/storage/docs/naming. If the URI is a bucket
* (without a namespace path), a prefix will be generated based on the start
* time.
*
* @var string
*/
public $outputUriPrefix;
/**
* The timestamp that corresponds to the version of the database to be
* exported. The timestamp must be in the past, rounded to the minute and not
* older than earliestVersionTime. If specified, then the exported documents
* will represent a consistent view of the database at the provided time.
* Otherwise, there are no guarantees about the consistency of the exported
* documents.
*
* @var string
*/
public $snapshotTime;
/**
* IDs of the collection groups to export. Unspecified means all collection
* groups. Each collection group in this list must be unique.
*
* @param string[] $collectionIds
*/
public function setCollectionIds($collectionIds)
{
$this->collectionIds = $collectionIds;
}
/**
* @return string[]
*/
public function getCollectionIds()
{
return $this->collectionIds;
}
/**
* An empty list represents all namespaces. This is the preferred usage for
* databases that don't use namespaces. An empty string element represents the
* default namespace. This should be used if the database has data in non-
* default namespaces, but doesn't want to include them. Each namespace in
* this list must be unique.
*
* @param string[] $namespaceIds
*/
public function setNamespaceIds($namespaceIds)
{
$this->namespaceIds = $namespaceIds;
}
/**
* @return string[]
*/
public function getNamespaceIds()
{
return $this->namespaceIds;
}
/**
* The output URI. Currently only supports Google Cloud Storage URIs of the
* form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
* of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
* Google Cloud Storage namespace path. When choosing a name, be sure to
* consider Google Cloud Storage naming guidelines:
* https://cloud.google.com/storage/docs/naming. If the URI is a bucket
* (without a namespace path), a prefix will be generated based on the start
* time.
*
* @param string $outputUriPrefix
*/
public function setOutputUriPrefix($outputUriPrefix)
{
$this->outputUriPrefix = $outputUriPrefix;
}
/**
* @return string
*/
public function getOutputUriPrefix()
{
return $this->outputUriPrefix;
}
/**
* The timestamp that corresponds to the version of the database to be
* exported. The timestamp must be in the past, rounded to the minute and not
* older than earliestVersionTime. If specified, then the exported documents
* will represent a consistent view of the database at the provided time.
* Otherwise, there are no guarantees about the consistency of the exported
* documents.
*
* @param string $snapshotTime
*/
public function setSnapshotTime($snapshotTime)
{
$this->snapshotTime = $snapshotTime;
}
/**
* @return string
*/
public function getSnapshotTime()
{
return $this->snapshotTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ExportDocumentsRequest::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ExportDocumentsRequest');

View File

@@ -0,0 +1,52 @@
<?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 GoogleFirestoreAdminV1ExportDocumentsResponse extends \Google\Model
{
/**
* Location of the output files. This can be used to begin an import into
* Cloud Firestore (this project or another project) after the operation
* completes successfully.
*
* @var string
*/
public $outputUriPrefix;
/**
* Location of the output files. This can be used to begin an import into
* Cloud Firestore (this project or another project) after the operation
* completes successfully.
*
* @param string $outputUriPrefix
*/
public function setOutputUriPrefix($outputUriPrefix)
{
$this->outputUriPrefix = $outputUriPrefix;
}
/**
* @return string
*/
public function getOutputUriPrefix()
{
return $this->outputUriPrefix;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ExportDocumentsResponse::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ExportDocumentsResponse');

View File

@@ -0,0 +1,118 @@
<?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 GoogleFirestoreAdminV1Field extends \Google\Model
{
protected $indexConfigType = GoogleFirestoreAdminV1IndexConfig::class;
protected $indexConfigDataType = '';
/**
* Required. A field name of the form: `projects/{project_id}/databases/{datab
* ase_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path
* can be a simple field name, e.g. `address` or a path to fields within
* `map_value` , e.g. `address.city`, or a special field path. The only valid
* special field is `*`, which represents any field. Field paths can be quoted
* using `` ` `` (backtick). The only character that must be escaped within a
* quoted field path is the backtick character itself, escaped using a
* backslash. Special characters in field paths that must be quoted include:
* `*`, `.`, `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic
* characters. Examples: `` `address.city` `` represents a field named
* `address.city`, not the map key `city` in the field `address`. `` `*` ``
* represents a field named `*`, not any field. A special `Field` contains the
* default indexing settings for all fields. This field's resource name is: `p
* rojects/{project_id}/databases/{database_id}/collectionGroups/__default__/f
* ields` Indexes defined on this `Field` will be applied to all fields which
* do not have their own `Field` index configuration.
*
* @var string
*/
public $name;
protected $ttlConfigType = GoogleFirestoreAdminV1TtlConfig::class;
protected $ttlConfigDataType = '';
/**
* The index configuration for this field. If unset, field indexing will
* revert to the configuration defined by the `ancestor_field`. To explicitly
* remove all indexes for this field, specify an index config with an empty
* list of indexes.
*
* @param GoogleFirestoreAdminV1IndexConfig $indexConfig
*/
public function setIndexConfig(GoogleFirestoreAdminV1IndexConfig $indexConfig)
{
$this->indexConfig = $indexConfig;
}
/**
* @return GoogleFirestoreAdminV1IndexConfig
*/
public function getIndexConfig()
{
return $this->indexConfig;
}
/**
* Required. A field name of the form: `projects/{project_id}/databases/{datab
* ase_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path
* can be a simple field name, e.g. `address` or a path to fields within
* `map_value` , e.g. `address.city`, or a special field path. The only valid
* special field is `*`, which represents any field. Field paths can be quoted
* using `` ` `` (backtick). The only character that must be escaped within a
* quoted field path is the backtick character itself, escaped using a
* backslash. Special characters in field paths that must be quoted include:
* `*`, `.`, `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic
* characters. Examples: `` `address.city` `` represents a field named
* `address.city`, not the map key `city` in the field `address`. `` `*` ``
* represents a field named `*`, not any field. A special `Field` contains the
* default indexing settings for all fields. This field's resource name is: `p
* rojects/{project_id}/databases/{database_id}/collectionGroups/__default__/f
* ields` Indexes defined on this `Field` will be applied to all fields which
* do not have their own `Field` index configuration.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The TTL configuration for this `Field`. Setting or unsetting this will
* enable or disable the TTL for documents that have this `Field`.
*
* @param GoogleFirestoreAdminV1TtlConfig $ttlConfig
*/
public function setTtlConfig(GoogleFirestoreAdminV1TtlConfig $ttlConfig)
{
$this->ttlConfig = $ttlConfig;
}
/**
* @return GoogleFirestoreAdminV1TtlConfig
*/
public function getTtlConfig()
{
return $this->ttlConfig;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1Field::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1Field');

View File

@@ -0,0 +1,230 @@
<?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 GoogleFirestoreAdminV1FieldOperationMetadata extends \Google\Collection
{
/**
* Unspecified.
*/
public const STATE_OPERATION_STATE_UNSPECIFIED = 'OPERATION_STATE_UNSPECIFIED';
/**
* Request is being prepared for processing.
*/
public const STATE_INITIALIZING = 'INITIALIZING';
/**
* Request is actively being processed.
*/
public const STATE_PROCESSING = 'PROCESSING';
/**
* Request is in the process of being cancelled after user called
* google.longrunning.Operations.CancelOperation on the operation.
*/
public const STATE_CANCELLING = 'CANCELLING';
/**
* Request has been processed and is in its finalization stage.
*/
public const STATE_FINALIZING = 'FINALIZING';
/**
* Request has completed successfully.
*/
public const STATE_SUCCESSFUL = 'SUCCESSFUL';
/**
* Request has finished being processed, but encountered an error.
*/
public const STATE_FAILED = 'FAILED';
/**
* Request has finished being cancelled after user called
* google.longrunning.Operations.CancelOperation.
*/
public const STATE_CANCELLED = 'CANCELLED';
protected $collection_key = 'indexConfigDeltas';
/**
* The time this operation completed. Will be unset if operation still in
* progress.
*
* @var string
*/
public $endTime;
/**
* The field resource that this operation is acting on. For example: `projects
* /{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fiel
* ds/{field_path}`
*
* @var string
*/
public $field;
protected $indexConfigDeltasType = GoogleFirestoreAdminV1IndexConfigDelta::class;
protected $indexConfigDeltasDataType = 'array';
protected $progressBytesType = GoogleFirestoreAdminV1Progress::class;
protected $progressBytesDataType = '';
protected $progressDocumentsType = GoogleFirestoreAdminV1Progress::class;
protected $progressDocumentsDataType = '';
/**
* The time this operation started.
*
* @var string
*/
public $startTime;
/**
* The state of the operation.
*
* @var string
*/
public $state;
protected $ttlConfigDeltaType = GoogleFirestoreAdminV1TtlConfigDelta::class;
protected $ttlConfigDeltaDataType = '';
/**
* The time this operation completed. Will be unset if operation still in
* progress.
*
* @param string $endTime
*/
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
/**
* @return string
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* The field resource that this operation is acting on. For example: `projects
* /{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fiel
* ds/{field_path}`
*
* @param string $field
*/
public function setField($field)
{
$this->field = $field;
}
/**
* @return string
*/
public function getField()
{
return $this->field;
}
/**
* A list of IndexConfigDelta, which describe the intent of this operation.
*
* @param GoogleFirestoreAdminV1IndexConfigDelta[] $indexConfigDeltas
*/
public function setIndexConfigDeltas($indexConfigDeltas)
{
$this->indexConfigDeltas = $indexConfigDeltas;
}
/**
* @return GoogleFirestoreAdminV1IndexConfigDelta[]
*/
public function getIndexConfigDeltas()
{
return $this->indexConfigDeltas;
}
/**
* The progress, in bytes, of this operation.
*
* @param GoogleFirestoreAdminV1Progress $progressBytes
*/
public function setProgressBytes(GoogleFirestoreAdminV1Progress $progressBytes)
{
$this->progressBytes = $progressBytes;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressBytes()
{
return $this->progressBytes;
}
/**
* The progress, in documents, of this operation.
*
* @param GoogleFirestoreAdminV1Progress $progressDocuments
*/
public function setProgressDocuments(GoogleFirestoreAdminV1Progress $progressDocuments)
{
$this->progressDocuments = $progressDocuments;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressDocuments()
{
return $this->progressDocuments;
}
/**
* The time this operation started.
*
* @param string $startTime
*/
public function setStartTime($startTime)
{
$this->startTime = $startTime;
}
/**
* @return string
*/
public function getStartTime()
{
return $this->startTime;
}
/**
* The state of the operation.
*
* Accepted values: OPERATION_STATE_UNSPECIFIED, INITIALIZING, PROCESSING,
* CANCELLING, FINALIZING, SUCCESSFUL, FAILED, CANCELLED
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Describes the deltas of TTL configuration.
*
* @param GoogleFirestoreAdminV1TtlConfigDelta $ttlConfigDelta
*/
public function setTtlConfigDelta(GoogleFirestoreAdminV1TtlConfigDelta $ttlConfigDelta)
{
$this->ttlConfigDelta = $ttlConfigDelta;
}
/**
* @return GoogleFirestoreAdminV1TtlConfigDelta
*/
public function getTtlConfigDelta()
{
return $this->ttlConfigDelta;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1FieldOperationMetadata::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1FieldOperationMetadata');

View File

@@ -0,0 +1,25 @@
<?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 GoogleFirestoreAdminV1FlatIndex extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1FlatIndex::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1FlatIndex');

View File

@@ -0,0 +1,25 @@
<?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 GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions');

View File

@@ -0,0 +1,234 @@
<?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 GoogleFirestoreAdminV1ImportDocumentsMetadata extends \Google\Collection
{
/**
* Unspecified.
*/
public const OPERATION_STATE_OPERATION_STATE_UNSPECIFIED = 'OPERATION_STATE_UNSPECIFIED';
/**
* Request is being prepared for processing.
*/
public const OPERATION_STATE_INITIALIZING = 'INITIALIZING';
/**
* Request is actively being processed.
*/
public const OPERATION_STATE_PROCESSING = 'PROCESSING';
/**
* Request is in the process of being cancelled after user called
* google.longrunning.Operations.CancelOperation on the operation.
*/
public const OPERATION_STATE_CANCELLING = 'CANCELLING';
/**
* Request has been processed and is in its finalization stage.
*/
public const OPERATION_STATE_FINALIZING = 'FINALIZING';
/**
* Request has completed successfully.
*/
public const OPERATION_STATE_SUCCESSFUL = 'SUCCESSFUL';
/**
* Request has finished being processed, but encountered an error.
*/
public const OPERATION_STATE_FAILED = 'FAILED';
/**
* Request has finished being cancelled after user called
* google.longrunning.Operations.CancelOperation.
*/
public const OPERATION_STATE_CANCELLED = 'CANCELLED';
protected $collection_key = 'namespaceIds';
/**
* Which collection IDs are being imported.
*
* @var string[]
*/
public $collectionIds;
/**
* The time this operation completed. Will be unset if operation still in
* progress.
*
* @var string
*/
public $endTime;
/**
* The location of the documents being imported.
*
* @var string
*/
public $inputUriPrefix;
/**
* Which namespace IDs are being imported.
*
* @var string[]
*/
public $namespaceIds;
/**
* The state of the import operation.
*
* @var string
*/
public $operationState;
protected $progressBytesType = GoogleFirestoreAdminV1Progress::class;
protected $progressBytesDataType = '';
protected $progressDocumentsType = GoogleFirestoreAdminV1Progress::class;
protected $progressDocumentsDataType = '';
/**
* The time this operation started.
*
* @var string
*/
public $startTime;
/**
* Which collection IDs are being imported.
*
* @param string[] $collectionIds
*/
public function setCollectionIds($collectionIds)
{
$this->collectionIds = $collectionIds;
}
/**
* @return string[]
*/
public function getCollectionIds()
{
return $this->collectionIds;
}
/**
* The time this operation completed. Will be unset if operation still in
* progress.
*
* @param string $endTime
*/
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
/**
* @return string
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* The location of the documents being imported.
*
* @param string $inputUriPrefix
*/
public function setInputUriPrefix($inputUriPrefix)
{
$this->inputUriPrefix = $inputUriPrefix;
}
/**
* @return string
*/
public function getInputUriPrefix()
{
return $this->inputUriPrefix;
}
/**
* Which namespace IDs are being imported.
*
* @param string[] $namespaceIds
*/
public function setNamespaceIds($namespaceIds)
{
$this->namespaceIds = $namespaceIds;
}
/**
* @return string[]
*/
public function getNamespaceIds()
{
return $this->namespaceIds;
}
/**
* The state of the import operation.
*
* Accepted values: OPERATION_STATE_UNSPECIFIED, INITIALIZING, PROCESSING,
* CANCELLING, FINALIZING, SUCCESSFUL, FAILED, CANCELLED
*
* @param self::OPERATION_STATE_* $operationState
*/
public function setOperationState($operationState)
{
$this->operationState = $operationState;
}
/**
* @return self::OPERATION_STATE_*
*/
public function getOperationState()
{
return $this->operationState;
}
/**
* The progress, in bytes, of this operation.
*
* @param GoogleFirestoreAdminV1Progress $progressBytes
*/
public function setProgressBytes(GoogleFirestoreAdminV1Progress $progressBytes)
{
$this->progressBytes = $progressBytes;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressBytes()
{
return $this->progressBytes;
}
/**
* The progress, in documents, of this operation.
*
* @param GoogleFirestoreAdminV1Progress $progressDocuments
*/
public function setProgressDocuments(GoogleFirestoreAdminV1Progress $progressDocuments)
{
$this->progressDocuments = $progressDocuments;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressDocuments()
{
return $this->progressDocuments;
}
/**
* The time this operation started.
*
* @param string $startTime
*/
public function setStartTime($startTime)
{
$this->startTime = $startTime;
}
/**
* @return string
*/
public function getStartTime()
{
return $this->startTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ImportDocumentsMetadata::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ImportDocumentsMetadata');

View File

@@ -0,0 +1,109 @@
<?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 GoogleFirestoreAdminV1ImportDocumentsRequest extends \Google\Collection
{
protected $collection_key = 'namespaceIds';
/**
* IDs of the collection groups to import. Unspecified means all collection
* groups that were included in the export. Each collection group in this list
* must be unique.
*
* @var string[]
*/
public $collectionIds;
/**
* Location of the exported files. This must match the output_uri_prefix of an
* ExportDocumentsResponse from an export that has completed successfully.
* See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
*
* @var string
*/
public $inputUriPrefix;
/**
* An empty list represents all namespaces. This is the preferred usage for
* databases that don't use namespaces. An empty string element represents the
* default namespace. This should be used if the database has data in non-
* default namespaces, but doesn't want to include them. Each namespace in
* this list must be unique.
*
* @var string[]
*/
public $namespaceIds;
/**
* IDs of the collection groups to import. Unspecified means all collection
* groups that were included in the export. Each collection group in this list
* must be unique.
*
* @param string[] $collectionIds
*/
public function setCollectionIds($collectionIds)
{
$this->collectionIds = $collectionIds;
}
/**
* @return string[]
*/
public function getCollectionIds()
{
return $this->collectionIds;
}
/**
* Location of the exported files. This must match the output_uri_prefix of an
* ExportDocumentsResponse from an export that has completed successfully.
* See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
*
* @param string $inputUriPrefix
*/
public function setInputUriPrefix($inputUriPrefix)
{
$this->inputUriPrefix = $inputUriPrefix;
}
/**
* @return string
*/
public function getInputUriPrefix()
{
return $this->inputUriPrefix;
}
/**
* An empty list represents all namespaces. This is the preferred usage for
* databases that don't use namespaces. An empty string element represents the
* default namespace. This should be used if the database has data in non-
* default namespaces, but doesn't want to include them. Each namespace in
* this list must be unique.
*
* @param string[] $namespaceIds
*/
public function setNamespaceIds($namespaceIds)
{
$this->namespaceIds = $namespaceIds;
}
/**
* @return string[]
*/
public function getNamespaceIds()
{
return $this->namespaceIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ImportDocumentsRequest::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ImportDocumentsRequest');

View File

@@ -0,0 +1,363 @@
<?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 GoogleFirestoreAdminV1Index extends \Google\Collection
{
/**
* The index can only be used by the Firestore Native query API. This is the
* default.
*/
public const API_SCOPE_ANY_API = 'ANY_API';
/**
* The index can only be used by the Firestore in Datastore Mode query API.
*/
public const API_SCOPE_DATASTORE_MODE_API = 'DATASTORE_MODE_API';
/**
* The index can only be used by the MONGODB_COMPATIBLE_API.
*/
public const API_SCOPE_MONGODB_COMPATIBLE_API = 'MONGODB_COMPATIBLE_API';
/**
* Unspecified. It will use database default setting. This value is input
* only.
*/
public const DENSITY_DENSITY_UNSPECIFIED = 'DENSITY_UNSPECIFIED';
/**
* An index entry will only exist if ALL fields are present in the document.
* This is both the default and only allowed value for Standard Edition
* databases (for both Cloud Firestore `ANY_API` and Cloud Datastore
* `DATASTORE_MODE_API`). Take for example the following document: ``` {
* "__name__": "...", "a": 1, "b": 2, "c": 3 } ``` an index on `(a ASC, b ASC,
* c ASC, __name__ ASC)` will generate an index entry for this document since
* `a`, 'b', `c`, and `__name__` are all present but an index of `(a ASC, d
* ASC, __name__ ASC)` will not generate an index entry for this document
* since `d` is missing. This means that such indexes can only be used to
* serve a query when the query has either implicit or explicit requirements
* that all fields from the index are present.
*/
public const DENSITY_SPARSE_ALL = 'SPARSE_ALL';
/**
* An index entry will exist if ANY field are present in the document. This is
* used as the definition of a sparse index for Enterprise Edition databases.
* Take for example the following document: ``` { "__name__": "...", "a": 1,
* "b": 2, "c": 3 } ``` an index on `(a ASC, d ASC)` will generate an index
* entry for this document since `a` is present, and will fill in an `unset`
* value for `d`. An index on `(d ASC, e ASC)` will not generate any index
* entry as neither `d` nor `e` are present. An index that contains `__name__`
* will generate an index entry for all documents since Firestore guarantees
* that all documents have a `__name__` field.
*/
public const DENSITY_SPARSE_ANY = 'SPARSE_ANY';
/**
* An index entry will exist regardless of if the fields are present or not.
* This is the default density for an Enterprise Edition database. The index
* will store `unset` values for fields that are not present in the document.
*/
public const DENSITY_DENSE = 'DENSE';
/**
* The query scope is unspecified. Not a valid option.
*/
public const QUERY_SCOPE_QUERY_SCOPE_UNSPECIFIED = 'QUERY_SCOPE_UNSPECIFIED';
/**
* Indexes with a collection query scope specified allow queries against a
* collection that is the child of a specific document, specified at query
* time, and that has the collection ID specified by the index.
*/
public const QUERY_SCOPE_COLLECTION = 'COLLECTION';
/**
* Indexes with a collection group query scope specified allow queries against
* all collections that has the collection ID specified by the index.
*/
public const QUERY_SCOPE_COLLECTION_GROUP = 'COLLECTION_GROUP';
/**
* Include all the collections's ancestor in the index. Only available for
* Datastore Mode databases.
*/
public const QUERY_SCOPE_COLLECTION_RECURSIVE = 'COLLECTION_RECURSIVE';
/**
* The state is unspecified.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The index is being created. There is an active long-running operation for
* the index. The index is updated when writing a document. Some index data
* may exist.
*/
public const STATE_CREATING = 'CREATING';
/**
* The index is ready to be used. The index is updated when writing a
* document. The index is fully populated from all stored documents it applies
* to.
*/
public const STATE_READY = 'READY';
/**
* The index was being created, but something went wrong. There is no active
* long-running operation for the index, and the most recently finished long-
* running operation failed. The index is not updated when writing a document.
* Some index data may exist. Use the google.longrunning.Operations API to
* determine why the operation that last attempted to create this index
* failed, then re-create the index.
*/
public const STATE_NEEDS_REPAIR = 'NEEDS_REPAIR';
protected $collection_key = 'fields';
/**
* The API scope supported by this index.
*
* @var string
*/
public $apiScope;
/**
* Immutable. The density configuration of the index.
*
* @var string
*/
public $density;
protected $fieldsType = GoogleFirestoreAdminV1IndexField::class;
protected $fieldsDataType = 'array';
/**
* Optional. Whether the index is multikey. By default, the index is not
* multikey. For non-multikey indexes, none of the paths in the index
* definition reach or traverse an array, except via an explicit array index.
* For multikey indexes, at most one of the paths in the index definition
* reach or traverse an array, except via an explicit array index. Violations
* will result in errors. Note this field only applies to index with
* MONGODB_COMPATIBLE_API ApiScope.
*
* @var bool
*/
public $multikey;
/**
* Output only. A server defined name for this index. The form of this name
* for composite indexes will be: `projects/{project_id}/databases/{database_i
* d}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For
* single field indexes, this field will be empty.
*
* @var string
*/
public $name;
/**
* Indexes with a collection query scope specified allow queries against a
* collection that is the child of a specific document, specified at query
* time, and that has the same collection ID. Indexes with a collection group
* query scope specified allow queries against all collections descended from
* a specific document, specified at query time, and that have the same
* collection ID as this index.
*
* @var string
*/
public $queryScope;
/**
* Optional. The number of shards for the index.
*
* @var int
*/
public $shardCount;
/**
* Output only. The serving state of the index.
*
* @var string
*/
public $state;
/**
* Optional. Whether it is an unique index. Unique index ensures all values
* for the indexed field(s) are unique across documents.
*
* @var bool
*/
public $unique;
/**
* The API scope supported by this index.
*
* Accepted values: ANY_API, DATASTORE_MODE_API, MONGODB_COMPATIBLE_API
*
* @param self::API_SCOPE_* $apiScope
*/
public function setApiScope($apiScope)
{
$this->apiScope = $apiScope;
}
/**
* @return self::API_SCOPE_*
*/
public function getApiScope()
{
return $this->apiScope;
}
/**
* Immutable. The density configuration of the index.
*
* Accepted values: DENSITY_UNSPECIFIED, SPARSE_ALL, SPARSE_ANY, DENSE
*
* @param self::DENSITY_* $density
*/
public function setDensity($density)
{
$this->density = $density;
}
/**
* @return self::DENSITY_*
*/
public function getDensity()
{
return $this->density;
}
/**
* The fields supported by this index. For composite indexes, this requires a
* minimum of 2 and a maximum of 100 fields. The last field entry is always
* for the field path `__name__`. If, on creation, `__name__` was not
* specified as the last field, it will be added automatically with the same
* direction as that of the last field defined. If the final field in a
* composite index is not directional, the `__name__` will be ordered
* ASCENDING (unless explicitly specified). For single field indexes, this
* will always be exactly one entry with a field path equal to the field path
* of the associated field.
*
* @param GoogleFirestoreAdminV1IndexField[] $fields
*/
public function setFields($fields)
{
$this->fields = $fields;
}
/**
* @return GoogleFirestoreAdminV1IndexField[]
*/
public function getFields()
{
return $this->fields;
}
/**
* Optional. Whether the index is multikey. By default, the index is not
* multikey. For non-multikey indexes, none of the paths in the index
* definition reach or traverse an array, except via an explicit array index.
* For multikey indexes, at most one of the paths in the index definition
* reach or traverse an array, except via an explicit array index. Violations
* will result in errors. Note this field only applies to index with
* MONGODB_COMPATIBLE_API ApiScope.
*
* @param bool $multikey
*/
public function setMultikey($multikey)
{
$this->multikey = $multikey;
}
/**
* @return bool
*/
public function getMultikey()
{
return $this->multikey;
}
/**
* Output only. A server defined name for this index. The form of this name
* for composite indexes will be: `projects/{project_id}/databases/{database_i
* d}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For
* single field indexes, this field will be empty.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Indexes with a collection query scope specified allow queries against a
* collection that is the child of a specific document, specified at query
* time, and that has the same collection ID. Indexes with a collection group
* query scope specified allow queries against all collections descended from
* a specific document, specified at query time, and that have the same
* collection ID as this index.
*
* Accepted values: QUERY_SCOPE_UNSPECIFIED, COLLECTION, COLLECTION_GROUP,
* COLLECTION_RECURSIVE
*
* @param self::QUERY_SCOPE_* $queryScope
*/
public function setQueryScope($queryScope)
{
$this->queryScope = $queryScope;
}
/**
* @return self::QUERY_SCOPE_*
*/
public function getQueryScope()
{
return $this->queryScope;
}
/**
* Optional. The number of shards for the index.
*
* @param int $shardCount
*/
public function setShardCount($shardCount)
{
$this->shardCount = $shardCount;
}
/**
* @return int
*/
public function getShardCount()
{
return $this->shardCount;
}
/**
* Output only. The serving state of the index.
*
* Accepted values: STATE_UNSPECIFIED, CREATING, READY, NEEDS_REPAIR
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Optional. Whether it is an unique index. Unique index ensures all values
* for the indexed field(s) are unique across documents.
*
* @param bool $unique
*/
public function setUnique($unique)
{
$this->unique = $unique;
}
/**
* @return bool
*/
public function getUnique()
{
return $this->unique;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1Index::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1Index');

View File

@@ -0,0 +1,127 @@
<?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 GoogleFirestoreAdminV1IndexConfig extends \Google\Collection
{
protected $collection_key = 'indexes';
/**
* Output only. Specifies the resource name of the `Field` from which this
* field's index configuration is set (when `uses_ancestor_config` is true),
* or from which it *would* be set if this field had no index configuration
* (when `uses_ancestor_config` is false).
*
* @var string
*/
public $ancestorField;
protected $indexesType = GoogleFirestoreAdminV1Index::class;
protected $indexesDataType = 'array';
/**
* Output only When true, the `Field`'s index configuration is in the process
* of being reverted. Once complete, the index config will transition to the
* same state as the field specified by `ancestor_field`, at which point
* `uses_ancestor_config` will be `true` and `reverting` will be `false`.
*
* @var bool
*/
public $reverting;
/**
* Output only. When true, the `Field`'s index configuration is set from the
* configuration specified by the `ancestor_field`. When false, the `Field`'s
* index configuration is defined explicitly.
*
* @var bool
*/
public $usesAncestorConfig;
/**
* Output only. Specifies the resource name of the `Field` from which this
* field's index configuration is set (when `uses_ancestor_config` is true),
* or from which it *would* be set if this field had no index configuration
* (when `uses_ancestor_config` is false).
*
* @param string $ancestorField
*/
public function setAncestorField($ancestorField)
{
$this->ancestorField = $ancestorField;
}
/**
* @return string
*/
public function getAncestorField()
{
return $this->ancestorField;
}
/**
* The indexes supported for this field.
*
* @param GoogleFirestoreAdminV1Index[] $indexes
*/
public function setIndexes($indexes)
{
$this->indexes = $indexes;
}
/**
* @return GoogleFirestoreAdminV1Index[]
*/
public function getIndexes()
{
return $this->indexes;
}
/**
* Output only When true, the `Field`'s index configuration is in the process
* of being reverted. Once complete, the index config will transition to the
* same state as the field specified by `ancestor_field`, at which point
* `uses_ancestor_config` will be `true` and `reverting` will be `false`.
*
* @param bool $reverting
*/
public function setReverting($reverting)
{
$this->reverting = $reverting;
}
/**
* @return bool
*/
public function getReverting()
{
return $this->reverting;
}
/**
* Output only. When true, the `Field`'s index configuration is set from the
* configuration specified by the `ancestor_field`. When false, the `Field`'s
* index configuration is defined explicitly.
*
* @param bool $usesAncestorConfig
*/
public function setUsesAncestorConfig($usesAncestorConfig)
{
$this->usesAncestorConfig = $usesAncestorConfig;
}
/**
* @return bool
*/
public function getUsesAncestorConfig()
{
return $this->usesAncestorConfig;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1IndexConfig::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1IndexConfig');

View File

@@ -0,0 +1,80 @@
<?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 GoogleFirestoreAdminV1IndexConfigDelta extends \Google\Model
{
/**
* The type of change is not specified or known.
*/
public const CHANGE_TYPE_CHANGE_TYPE_UNSPECIFIED = 'CHANGE_TYPE_UNSPECIFIED';
/**
* The single field index is being added.
*/
public const CHANGE_TYPE_ADD = 'ADD';
/**
* The single field index is being removed.
*/
public const CHANGE_TYPE_REMOVE = 'REMOVE';
/**
* Specifies how the index is changing.
*
* @var string
*/
public $changeType;
protected $indexType = GoogleFirestoreAdminV1Index::class;
protected $indexDataType = '';
/**
* Specifies how the index is changing.
*
* Accepted values: CHANGE_TYPE_UNSPECIFIED, ADD, REMOVE
*
* @param self::CHANGE_TYPE_* $changeType
*/
public function setChangeType($changeType)
{
$this->changeType = $changeType;
}
/**
* @return self::CHANGE_TYPE_*
*/
public function getChangeType()
{
return $this->changeType;
}
/**
* The index being changed.
*
* @param GoogleFirestoreAdminV1Index $index
*/
public function setIndex(GoogleFirestoreAdminV1Index $index)
{
$this->index = $index;
}
/**
* @return GoogleFirestoreAdminV1Index
*/
public function getIndex()
{
return $this->index;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1IndexConfigDelta::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1IndexConfigDelta');

View File

@@ -0,0 +1,139 @@
<?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 GoogleFirestoreAdminV1IndexField extends \Google\Model
{
/**
* The index does not support additional array queries.
*/
public const ARRAY_CONFIG_ARRAY_CONFIG_UNSPECIFIED = 'ARRAY_CONFIG_UNSPECIFIED';
/**
* The index supports array containment queries.
*/
public const ARRAY_CONFIG_CONTAINS = 'CONTAINS';
/**
* The ordering is unspecified. Not a valid option.
*/
public const ORDER_ORDER_UNSPECIFIED = 'ORDER_UNSPECIFIED';
/**
* The field is ordered by ascending field value.
*/
public const ORDER_ASCENDING = 'ASCENDING';
/**
* The field is ordered by descending field value.
*/
public const ORDER_DESCENDING = 'DESCENDING';
/**
* Indicates that this field supports operations on `array_value`s.
*
* @var string
*/
public $arrayConfig;
/**
* Can be __name__. For single field indexes, this must match the name of the
* field or may be omitted.
*
* @var string
*/
public $fieldPath;
/**
* Indicates that this field supports ordering by the specified order or
* comparing using =, !=, <, <=, >, >=.
*
* @var string
*/
public $order;
protected $vectorConfigType = GoogleFirestoreAdminV1VectorConfig::class;
protected $vectorConfigDataType = '';
/**
* Indicates that this field supports operations on `array_value`s.
*
* Accepted values: ARRAY_CONFIG_UNSPECIFIED, CONTAINS
*
* @param self::ARRAY_CONFIG_* $arrayConfig
*/
public function setArrayConfig($arrayConfig)
{
$this->arrayConfig = $arrayConfig;
}
/**
* @return self::ARRAY_CONFIG_*
*/
public function getArrayConfig()
{
return $this->arrayConfig;
}
/**
* Can be __name__. For single field indexes, this must match the name of the
* field or may be omitted.
*
* @param string $fieldPath
*/
public function setFieldPath($fieldPath)
{
$this->fieldPath = $fieldPath;
}
/**
* @return string
*/
public function getFieldPath()
{
return $this->fieldPath;
}
/**
* Indicates that this field supports ordering by the specified order or
* comparing using =, !=, <, <=, >, >=.
*
* Accepted values: ORDER_UNSPECIFIED, ASCENDING, DESCENDING
*
* @param self::ORDER_* $order
*/
public function setOrder($order)
{
$this->order = $order;
}
/**
* @return self::ORDER_*
*/
public function getOrder()
{
return $this->order;
}
/**
* Indicates that this field supports nearest neighbor and distance operations
* on vector.
*
* @param GoogleFirestoreAdminV1VectorConfig $vectorConfig
*/
public function setVectorConfig(GoogleFirestoreAdminV1VectorConfig $vectorConfig)
{
$this->vectorConfig = $vectorConfig;
}
/**
* @return GoogleFirestoreAdminV1VectorConfig
*/
public function getVectorConfig()
{
return $this->vectorConfig;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1IndexField::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1IndexField');

View File

@@ -0,0 +1,193 @@
<?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 GoogleFirestoreAdminV1IndexOperationMetadata extends \Google\Model
{
/**
* Unspecified.
*/
public const STATE_OPERATION_STATE_UNSPECIFIED = 'OPERATION_STATE_UNSPECIFIED';
/**
* Request is being prepared for processing.
*/
public const STATE_INITIALIZING = 'INITIALIZING';
/**
* Request is actively being processed.
*/
public const STATE_PROCESSING = 'PROCESSING';
/**
* Request is in the process of being cancelled after user called
* google.longrunning.Operations.CancelOperation on the operation.
*/
public const STATE_CANCELLING = 'CANCELLING';
/**
* Request has been processed and is in its finalization stage.
*/
public const STATE_FINALIZING = 'FINALIZING';
/**
* Request has completed successfully.
*/
public const STATE_SUCCESSFUL = 'SUCCESSFUL';
/**
* Request has finished being processed, but encountered an error.
*/
public const STATE_FAILED = 'FAILED';
/**
* Request has finished being cancelled after user called
* google.longrunning.Operations.CancelOperation.
*/
public const STATE_CANCELLED = 'CANCELLED';
/**
* The time this operation completed. Will be unset if operation still in
* progress.
*
* @var string
*/
public $endTime;
/**
* The index resource that this operation is acting on. For example: `projects
* /{project_id}/databases/{database_id}/collectionGroups/{collection_id}/inde
* xes/{index_id}`
*
* @var string
*/
public $index;
protected $progressBytesType = GoogleFirestoreAdminV1Progress::class;
protected $progressBytesDataType = '';
protected $progressDocumentsType = GoogleFirestoreAdminV1Progress::class;
protected $progressDocumentsDataType = '';
/**
* The time this operation started.
*
* @var string
*/
public $startTime;
/**
* The state of the operation.
*
* @var string
*/
public $state;
/**
* The time this operation completed. Will be unset if operation still in
* progress.
*
* @param string $endTime
*/
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
/**
* @return string
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* The index resource that this operation is acting on. For example: `projects
* /{project_id}/databases/{database_id}/collectionGroups/{collection_id}/inde
* xes/{index_id}`
*
* @param string $index
*/
public function setIndex($index)
{
$this->index = $index;
}
/**
* @return string
*/
public function getIndex()
{
return $this->index;
}
/**
* The progress, in bytes, of this operation.
*
* @param GoogleFirestoreAdminV1Progress $progressBytes
*/
public function setProgressBytes(GoogleFirestoreAdminV1Progress $progressBytes)
{
$this->progressBytes = $progressBytes;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressBytes()
{
return $this->progressBytes;
}
/**
* The progress, in documents, of this operation.
*
* @param GoogleFirestoreAdminV1Progress $progressDocuments
*/
public function setProgressDocuments(GoogleFirestoreAdminV1Progress $progressDocuments)
{
$this->progressDocuments = $progressDocuments;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressDocuments()
{
return $this->progressDocuments;
}
/**
* The time this operation started.
*
* @param string $startTime
*/
public function setStartTime($startTime)
{
$this->startTime = $startTime;
}
/**
* @return string
*/
public function getStartTime()
{
return $this->startTime;
}
/**
* The state of the operation.
*
* Accepted values: OPERATION_STATE_UNSPECIFIED, INITIALIZING, PROCESSING,
* CANCELLING, FINALIZING, SUCCESSFUL, FAILED, CANCELLED
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1IndexOperationMetadata::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1IndexOperationMetadata');

View File

@@ -0,0 +1,45 @@
<?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 GoogleFirestoreAdminV1ListBackupSchedulesResponse extends \Google\Collection
{
protected $collection_key = 'backupSchedules';
protected $backupSchedulesType = GoogleFirestoreAdminV1BackupSchedule::class;
protected $backupSchedulesDataType = 'array';
/**
* List of all backup schedules.
*
* @param GoogleFirestoreAdminV1BackupSchedule[] $backupSchedules
*/
public function setBackupSchedules($backupSchedules)
{
$this->backupSchedules = $backupSchedules;
}
/**
* @return GoogleFirestoreAdminV1BackupSchedule[]
*/
public function getBackupSchedules()
{
return $this->backupSchedules;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ListBackupSchedulesResponse::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ListBackupSchedulesResponse');

View File

@@ -0,0 +1,75 @@
<?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 GoogleFirestoreAdminV1ListBackupsResponse extends \Google\Collection
{
protected $collection_key = 'unreachable';
protected $backupsType = GoogleFirestoreAdminV1Backup::class;
protected $backupsDataType = 'array';
/**
* List of locations that existing backups were not able to be fetched from.
* Instead of failing the entire requests when a single location is
* unreachable, this response returns a partial result set and list of
* locations unable to be reached here. The request can be retried against a
* single location to get a concrete error.
*
* @var string[]
*/
public $unreachable;
/**
* List of all backups for the project.
*
* @param GoogleFirestoreAdminV1Backup[] $backups
*/
public function setBackups($backups)
{
$this->backups = $backups;
}
/**
* @return GoogleFirestoreAdminV1Backup[]
*/
public function getBackups()
{
return $this->backups;
}
/**
* List of locations that existing backups were not able to be fetched from.
* Instead of failing the entire requests when a single location is
* unreachable, this response returns a partial result set and list of
* locations unable to be reached here. The request can be retried against a
* single location to get a concrete error.
*
* @param string[] $unreachable
*/
public function setUnreachable($unreachable)
{
$this->unreachable = $unreachable;
}
/**
* @return string[]
*/
public function getUnreachable()
{
return $this->unreachable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ListBackupsResponse::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ListBackupsResponse');

View File

@@ -0,0 +1,81 @@
<?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 GoogleFirestoreAdminV1ListDatabasesResponse extends \Google\Collection
{
protected $collection_key = 'unreachable';
protected $databasesType = GoogleFirestoreAdminV1Database::class;
protected $databasesDataType = 'array';
/**
* In the event that data about individual databases cannot be listed they
* will be recorded here. An example entry might be:
* projects/some_project/locations/some_location This can happen if the Cloud
* Region that the Database resides in is currently unavailable. In this case
* we can't fetch all the details about the database. You may be able to get a
* more detailed error message (or possibly fetch the resource) by sending a
* 'Get' request for the resource or a 'List' request for the specific
* location.
*
* @var string[]
*/
public $unreachable;
/**
* The databases in the project.
*
* @param GoogleFirestoreAdminV1Database[] $databases
*/
public function setDatabases($databases)
{
$this->databases = $databases;
}
/**
* @return GoogleFirestoreAdminV1Database[]
*/
public function getDatabases()
{
return $this->databases;
}
/**
* In the event that data about individual databases cannot be listed they
* will be recorded here. An example entry might be:
* projects/some_project/locations/some_location This can happen if the Cloud
* Region that the Database resides in is currently unavailable. In this case
* we can't fetch all the details about the database. You may be able to get a
* more detailed error message (or possibly fetch the resource) by sending a
* 'Get' request for the resource or a 'List' request for the specific
* location.
*
* @param string[] $unreachable
*/
public function setUnreachable($unreachable)
{
$this->unreachable = $unreachable;
}
/**
* @return string[]
*/
public function getUnreachable()
{
return $this->unreachable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ListDatabasesResponse::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ListDatabasesResponse');

View File

@@ -0,0 +1,69 @@
<?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 GoogleFirestoreAdminV1ListFieldsResponse extends \Google\Collection
{
protected $collection_key = 'fields';
protected $fieldsType = GoogleFirestoreAdminV1Field::class;
protected $fieldsDataType = 'array';
/**
* A page token that may be used to request another page of results. If blank,
* this is the last page.
*
* @var string
*/
public $nextPageToken;
/**
* The requested fields.
*
* @param GoogleFirestoreAdminV1Field[] $fields
*/
public function setFields($fields)
{
$this->fields = $fields;
}
/**
* @return GoogleFirestoreAdminV1Field[]
*/
public function getFields()
{
return $this->fields;
}
/**
* A page token that may be used to request another page of results. If blank,
* this is the last page.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ListFieldsResponse::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ListFieldsResponse');

View File

@@ -0,0 +1,69 @@
<?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 GoogleFirestoreAdminV1ListIndexesResponse extends \Google\Collection
{
protected $collection_key = 'indexes';
protected $indexesType = GoogleFirestoreAdminV1Index::class;
protected $indexesDataType = 'array';
/**
* A page token that may be used to request another page of results. If blank,
* this is the last page.
*
* @var string
*/
public $nextPageToken;
/**
* The requested indexes.
*
* @param GoogleFirestoreAdminV1Index[] $indexes
*/
public function setIndexes($indexes)
{
$this->indexes = $indexes;
}
/**
* @return GoogleFirestoreAdminV1Index[]
*/
public function getIndexes()
{
return $this->indexes;
}
/**
* A page token that may be used to request another page of results. If blank,
* this is the last page.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ListIndexesResponse::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ListIndexesResponse');

View File

@@ -0,0 +1,45 @@
<?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 GoogleFirestoreAdminV1ListUserCredsResponse extends \Google\Collection
{
protected $collection_key = 'userCreds';
protected $userCredsType = GoogleFirestoreAdminV1UserCreds::class;
protected $userCredsDataType = 'array';
/**
* The user creds for the database.
*
* @param GoogleFirestoreAdminV1UserCreds[] $userCreds
*/
public function setUserCreds($userCreds)
{
$this->userCreds = $userCreds;
}
/**
* @return GoogleFirestoreAdminV1UserCreds[]
*/
public function getUserCreds()
{
return $this->userCreds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ListUserCredsResponse::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ListUserCredsResponse');

View File

@@ -0,0 +1,25 @@
<?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 GoogleFirestoreAdminV1LocationMetadata extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1LocationMetadata::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1LocationMetadata');

View File

@@ -0,0 +1,94 @@
<?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 GoogleFirestoreAdminV1PitrSnapshot extends \Google\Model
{
/**
* Required. The name of the database that this was a snapshot of. Format:
* `projects/{project}/databases/{database}`.
*
* @var string
*/
public $database;
/**
* Output only. Public UUID of the database the snapshot was associated with.
*
* @var string
*/
public $databaseUid;
/**
* Required. Snapshot time of the database.
*
* @var string
*/
public $snapshotTime;
/**
* Required. The name of the database that this was a snapshot of. Format:
* `projects/{project}/databases/{database}`.
*
* @param string $database
*/
public function setDatabase($database)
{
$this->database = $database;
}
/**
* @return string
*/
public function getDatabase()
{
return $this->database;
}
/**
* Output only. Public UUID of the database the snapshot was associated with.
*
* @param string $databaseUid
*/
public function setDatabaseUid($databaseUid)
{
$this->databaseUid = $databaseUid;
}
/**
* @return string
*/
public function getDatabaseUid()
{
return $this->databaseUid;
}
/**
* Required. Snapshot time of the database.
*
* @param string $snapshotTime
*/
public function setSnapshotTime($snapshotTime)
{
$this->snapshotTime = $snapshotTime;
}
/**
* @return string
*/
public function getSnapshotTime()
{
return $this->snapshotTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1PitrSnapshot::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1PitrSnapshot');

View File

@@ -0,0 +1,70 @@
<?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 GoogleFirestoreAdminV1Progress extends \Google\Model
{
/**
* The amount of work completed.
*
* @var string
*/
public $completedWork;
/**
* The amount of work estimated.
*
* @var string
*/
public $estimatedWork;
/**
* The amount of work completed.
*
* @param string $completedWork
*/
public function setCompletedWork($completedWork)
{
$this->completedWork = $completedWork;
}
/**
* @return string
*/
public function getCompletedWork()
{
return $this->completedWork;
}
/**
* The amount of work estimated.
*
* @param string $estimatedWork
*/
public function setEstimatedWork($estimatedWork)
{
$this->estimatedWork = $estimatedWork;
}
/**
* @return string
*/
public function getEstimatedWork()
{
return $this->estimatedWork;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1Progress::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1Progress');

View File

@@ -0,0 +1,25 @@
<?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 GoogleFirestoreAdminV1ResetUserPasswordRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ResetUserPasswordRequest::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ResetUserPasswordRequest');

View File

@@ -0,0 +1,50 @@
<?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 GoogleFirestoreAdminV1ResourceIdentity extends \Google\Model
{
/**
* Output only. Principal identifier string. See:
* https://cloud.google.com/iam/docs/principal-identifiers
*
* @var string
*/
public $principal;
/**
* Output only. Principal identifier string. See:
* https://cloud.google.com/iam/docs/principal-identifiers
*
* @param string $principal
*/
public function setPrincipal($principal)
{
$this->principal = $principal;
}
/**
* @return string
*/
public function getPrincipal()
{
return $this->principal;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1ResourceIdentity::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1ResourceIdentity');

View File

@@ -0,0 +1,191 @@
<?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 GoogleFirestoreAdminV1RestoreDatabaseMetadata extends \Google\Model
{
/**
* Unspecified.
*/
public const OPERATION_STATE_OPERATION_STATE_UNSPECIFIED = 'OPERATION_STATE_UNSPECIFIED';
/**
* Request is being prepared for processing.
*/
public const OPERATION_STATE_INITIALIZING = 'INITIALIZING';
/**
* Request is actively being processed.
*/
public const OPERATION_STATE_PROCESSING = 'PROCESSING';
/**
* Request is in the process of being cancelled after user called
* google.longrunning.Operations.CancelOperation on the operation.
*/
public const OPERATION_STATE_CANCELLING = 'CANCELLING';
/**
* Request has been processed and is in its finalization stage.
*/
public const OPERATION_STATE_FINALIZING = 'FINALIZING';
/**
* Request has completed successfully.
*/
public const OPERATION_STATE_SUCCESSFUL = 'SUCCESSFUL';
/**
* Request has finished being processed, but encountered an error.
*/
public const OPERATION_STATE_FAILED = 'FAILED';
/**
* Request has finished being cancelled after user called
* google.longrunning.Operations.CancelOperation.
*/
public const OPERATION_STATE_CANCELLED = 'CANCELLED';
/**
* The name of the backup restoring from.
*
* @var string
*/
public $backup;
/**
* The name of the database being restored to.
*
* @var string
*/
public $database;
/**
* The time the restore finished, unset for ongoing restores.
*
* @var string
*/
public $endTime;
/**
* The operation state of the restore.
*
* @var string
*/
public $operationState;
protected $progressPercentageType = GoogleFirestoreAdminV1Progress::class;
protected $progressPercentageDataType = '';
/**
* The time the restore was started.
*
* @var string
*/
public $startTime;
/**
* The name of the backup restoring from.
*
* @param string $backup
*/
public function setBackup($backup)
{
$this->backup = $backup;
}
/**
* @return string
*/
public function getBackup()
{
return $this->backup;
}
/**
* The name of the database being restored to.
*
* @param string $database
*/
public function setDatabase($database)
{
$this->database = $database;
}
/**
* @return string
*/
public function getDatabase()
{
return $this->database;
}
/**
* The time the restore finished, unset for ongoing restores.
*
* @param string $endTime
*/
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
/**
* @return string
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* The operation state of the restore.
*
* Accepted values: OPERATION_STATE_UNSPECIFIED, INITIALIZING, PROCESSING,
* CANCELLING, FINALIZING, SUCCESSFUL, FAILED, CANCELLED
*
* @param self::OPERATION_STATE_* $operationState
*/
public function setOperationState($operationState)
{
$this->operationState = $operationState;
}
/**
* @return self::OPERATION_STATE_*
*/
public function getOperationState()
{
return $this->operationState;
}
/**
* How far along the restore is as an estimated percentage of remaining time.
*
* @param GoogleFirestoreAdminV1Progress $progressPercentage
*/
public function setProgressPercentage(GoogleFirestoreAdminV1Progress $progressPercentage)
{
$this->progressPercentage = $progressPercentage;
}
/**
* @return GoogleFirestoreAdminV1Progress
*/
public function getProgressPercentage()
{
return $this->progressPercentage;
}
/**
* The time the restore was started.
*
* @param string $startTime
*/
public function setStartTime($startTime)
{
$this->startTime = $startTime;
}
/**
* @return string
*/
public function getStartTime()
{
return $this->startTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1RestoreDatabaseMetadata::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1RestoreDatabaseMetadata');

View File

@@ -0,0 +1,134 @@
<?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 GoogleFirestoreAdminV1RestoreDatabaseRequest extends \Google\Model
{
/**
* Required. Backup to restore from. Must be from the same project as the
* parent. The restored database will be created in the same location as the
* source backup. Format is:
* `projects/{project_id}/locations/{location}/backups/{backup}`
*
* @var string
*/
public $backup;
/**
* Required. The ID to use for the database, which will become the final
* component of the database's resource name. This database ID must not be
* associated with an existing database. This value should be 4-63 characters.
* Valid characters are /a-z-/ with first character a letter and the last a
* letter or a number. Must not be UUID-like
* /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is
* also valid if the database is Standard edition.
*
* @var string
*/
public $databaseId;
protected $encryptionConfigType = GoogleFirestoreAdminV1EncryptionConfig::class;
protected $encryptionConfigDataType = '';
/**
* Optional. Immutable. Tags to be bound to the restored database. The tags
* should be provided in the format of `tagKeys/{tag_key_id} ->
* tagValues/{tag_value_id}`.
*
* @var string[]
*/
public $tags;
/**
* Required. Backup to restore from. Must be from the same project as the
* parent. The restored database will be created in the same location as the
* source backup. Format is:
* `projects/{project_id}/locations/{location}/backups/{backup}`
*
* @param string $backup
*/
public function setBackup($backup)
{
$this->backup = $backup;
}
/**
* @return string
*/
public function getBackup()
{
return $this->backup;
}
/**
* Required. The ID to use for the database, which will become the final
* component of the database's resource name. This database ID must not be
* associated with an existing database. This value should be 4-63 characters.
* Valid characters are /a-z-/ with first character a letter and the last a
* letter or a number. Must not be UUID-like
* /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is
* also valid if the database is Standard edition.
*
* @param string $databaseId
*/
public function setDatabaseId($databaseId)
{
$this->databaseId = $databaseId;
}
/**
* @return string
*/
public function getDatabaseId()
{
return $this->databaseId;
}
/**
* Optional. Encryption configuration for the restored database. If this field
* is not specified, the restored database will use the same encryption
* configuration as the backup, namely use_source_encryption.
*
* @param GoogleFirestoreAdminV1EncryptionConfig $encryptionConfig
*/
public function setEncryptionConfig(GoogleFirestoreAdminV1EncryptionConfig $encryptionConfig)
{
$this->encryptionConfig = $encryptionConfig;
}
/**
* @return GoogleFirestoreAdminV1EncryptionConfig
*/
public function getEncryptionConfig()
{
return $this->encryptionConfig;
}
/**
* Optional. Immutable. Tags to be bound to the restored database. The tags
* should be provided in the format of `tagKeys/{tag_key_id} ->
* tagValues/{tag_value_id}`.
*
* @param string[] $tags
*/
public function setTags($tags)
{
$this->tags = $tags;
}
/**
* @return string[]
*/
public function getTags()
{
return $this->tags;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1RestoreDatabaseRequest::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1RestoreDatabaseRequest');

View File

@@ -0,0 +1,25 @@
<?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 GoogleFirestoreAdminV1SourceEncryptionOptions extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1SourceEncryptionOptions::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1SourceEncryptionOptions');

View File

@@ -0,0 +1,71 @@
<?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 GoogleFirestoreAdminV1SourceInfo extends \Google\Model
{
protected $backupType = GoogleFirestoreAdminV1BackupSource::class;
protected $backupDataType = '';
/**
* The associated long-running operation. This field may not be set after the
* operation has completed. Format:
* `projects/{project}/databases/{database}/operations/{operation}`.
*
* @var string
*/
public $operation;
/**
* If set, this database was restored from the specified backup (or a snapshot
* thereof).
*
* @param GoogleFirestoreAdminV1BackupSource $backup
*/
public function setBackup(GoogleFirestoreAdminV1BackupSource $backup)
{
$this->backup = $backup;
}
/**
* @return GoogleFirestoreAdminV1BackupSource
*/
public function getBackup()
{
return $this->backup;
}
/**
* The associated long-running operation. This field may not be set after the
* operation has completed. Format:
* `projects/{project}/databases/{database}/operations/{operation}`.
*
* @param string $operation
*/
public function setOperation($operation)
{
$this->operation = $operation;
}
/**
* @return string
*/
public function getOperation()
{
return $this->operation;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1SourceInfo::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1SourceInfo');

View File

@@ -0,0 +1,94 @@
<?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 GoogleFirestoreAdminV1Stats extends \Google\Model
{
/**
* Output only. The total number of documents contained in the backup.
*
* @var string
*/
public $documentCount;
/**
* Output only. The total number of index entries contained in the backup.
*
* @var string
*/
public $indexCount;
/**
* Output only. Summation of the size of all documents and index entries in
* the backup, measured in bytes.
*
* @var string
*/
public $sizeBytes;
/**
* Output only. The total number of documents contained in the backup.
*
* @param string $documentCount
*/
public function setDocumentCount($documentCount)
{
$this->documentCount = $documentCount;
}
/**
* @return string
*/
public function getDocumentCount()
{
return $this->documentCount;
}
/**
* Output only. The total number of index entries contained in the backup.
*
* @param string $indexCount
*/
public function setIndexCount($indexCount)
{
$this->indexCount = $indexCount;
}
/**
* @return string
*/
public function getIndexCount()
{
return $this->indexCount;
}
/**
* Output only. Summation of the size of all documents and index entries in
* the backup, measured in bytes.
*
* @param string $sizeBytes
*/
public function setSizeBytes($sizeBytes)
{
$this->sizeBytes = $sizeBytes;
}
/**
* @return string
*/
public function getSizeBytes()
{
return $this->sizeBytes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1Stats::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1Stats');

View File

@@ -0,0 +1,73 @@
<?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 GoogleFirestoreAdminV1TtlConfig extends \Google\Model
{
/**
* The state is unspecified or unknown.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The TTL is being applied. There is an active long-running operation to
* track the change. Newly written documents will have TTLs applied as
* requested. Requested TTLs on existing documents are still being processed.
* When TTLs on all existing documents have been processed, the state will
* move to 'ACTIVE'.
*/
public const STATE_CREATING = 'CREATING';
/**
* The TTL is active for all documents.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* The TTL configuration could not be enabled for all existing documents.
* Newly written documents will continue to have their TTL applied. The LRO
* returned when last attempting to enable TTL for this `Field` has failed,
* and may have more details.
*/
public const STATE_NEEDS_REPAIR = 'NEEDS_REPAIR';
/**
* Output only. The state of the TTL configuration.
*
* @var string
*/
public $state;
/**
* Output only. The state of the TTL configuration.
*
* Accepted values: STATE_UNSPECIFIED, CREATING, ACTIVE, NEEDS_REPAIR
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1TtlConfig::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1TtlConfig');

View File

@@ -0,0 +1,62 @@
<?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 GoogleFirestoreAdminV1TtlConfigDelta extends \Google\Model
{
/**
* The type of change is not specified or known.
*/
public const CHANGE_TYPE_CHANGE_TYPE_UNSPECIFIED = 'CHANGE_TYPE_UNSPECIFIED';
/**
* The TTL config is being added.
*/
public const CHANGE_TYPE_ADD = 'ADD';
/**
* The TTL config is being removed.
*/
public const CHANGE_TYPE_REMOVE = 'REMOVE';
/**
* Specifies how the TTL configuration is changing.
*
* @var string
*/
public $changeType;
/**
* Specifies how the TTL configuration is changing.
*
* Accepted values: CHANGE_TYPE_UNSPECIFIED, ADD, REMOVE
*
* @param self::CHANGE_TYPE_* $changeType
*/
public function setChangeType($changeType)
{
$this->changeType = $changeType;
}
/**
* @return self::CHANGE_TYPE_*
*/
public function getChangeType()
{
return $this->changeType;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1TtlConfigDelta::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1TtlConfigDelta');

View File

@@ -0,0 +1,25 @@
<?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 GoogleFirestoreAdminV1UpdateDatabaseMetadata extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1UpdateDatabaseMetadata::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1UpdateDatabaseMetadata');

View File

@@ -0,0 +1,174 @@
<?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 GoogleFirestoreAdminV1UserCreds extends \Google\Model
{
/**
* The default value. Should not be used.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The user creds are enabled.
*/
public const STATE_ENABLED = 'ENABLED';
/**
* The user creds are disabled.
*/
public const STATE_DISABLED = 'DISABLED';
/**
* Output only. The time the user creds were created.
*
* @var string
*/
public $createTime;
/**
* Identifier. The resource name of the UserCreds. Format:
* `projects/{project}/databases/{database}/userCreds/{user_creds}`
*
* @var string
*/
public $name;
protected $resourceIdentityType = GoogleFirestoreAdminV1ResourceIdentity::class;
protected $resourceIdentityDataType = '';
/**
* Output only. The plaintext server-generated password for the user creds.
* Only populated in responses for CreateUserCreds and ResetUserPassword.
*
* @var string
*/
public $securePassword;
/**
* Output only. Whether the user creds are enabled or disabled. Defaults to
* ENABLED on creation.
*
* @var string
*/
public $state;
/**
* Output only. The time the user creds were last updated.
*
* @var string
*/
public $updateTime;
/**
* Output only. The time the user creds were created.
*
* @param string $createTime
*/
public function setCreateTime($createTime)
{
$this->createTime = $createTime;
}
/**
* @return string
*/
public function getCreateTime()
{
return $this->createTime;
}
/**
* Identifier. The resource name of the UserCreds. Format:
* `projects/{project}/databases/{database}/userCreds/{user_creds}`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Resource Identity descriptor.
*
* @param GoogleFirestoreAdminV1ResourceIdentity $resourceIdentity
*/
public function setResourceIdentity(GoogleFirestoreAdminV1ResourceIdentity $resourceIdentity)
{
$this->resourceIdentity = $resourceIdentity;
}
/**
* @return GoogleFirestoreAdminV1ResourceIdentity
*/
public function getResourceIdentity()
{
return $this->resourceIdentity;
}
/**
* Output only. The plaintext server-generated password for the user creds.
* Only populated in responses for CreateUserCreds and ResetUserPassword.
*
* @param string $securePassword
*/
public function setSecurePassword($securePassword)
{
$this->securePassword = $securePassword;
}
/**
* @return string
*/
public function getSecurePassword()
{
return $this->securePassword;
}
/**
* Output only. Whether the user creds are enabled or disabled. Defaults to
* ENABLED on creation.
*
* Accepted values: STATE_UNSPECIFIED, ENABLED, DISABLED
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Output only. The time the user creds were last updated.
*
* @param string $updateTime
*/
public function setUpdateTime($updateTime)
{
$this->updateTime = $updateTime;
}
/**
* @return string
*/
public function getUpdateTime()
{
return $this->updateTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1UserCreds::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1UserCreds');

View File

@@ -0,0 +1,70 @@
<?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 GoogleFirestoreAdminV1VectorConfig extends \Google\Model
{
/**
* Required. The vector dimension this configuration applies to. The resulting
* index will only include vectors of this dimension, and can be used for
* vector search with the same dimension.
*
* @var int
*/
public $dimension;
protected $flatType = GoogleFirestoreAdminV1FlatIndex::class;
protected $flatDataType = '';
/**
* Required. The vector dimension this configuration applies to. The resulting
* index will only include vectors of this dimension, and can be used for
* vector search with the same dimension.
*
* @param int $dimension
*/
public function setDimension($dimension)
{
$this->dimension = $dimension;
}
/**
* @return int
*/
public function getDimension()
{
return $this->dimension;
}
/**
* Indicates the vector index is a flat index.
*
* @param GoogleFirestoreAdminV1FlatIndex $flat
*/
public function setFlat(GoogleFirestoreAdminV1FlatIndex $flat)
{
$this->flat = $flat;
}
/**
* @return GoogleFirestoreAdminV1FlatIndex
*/
public function getFlat()
{
return $this->flat;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1VectorConfig::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1VectorConfig');

View File

@@ -0,0 +1,83 @@
<?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 GoogleFirestoreAdminV1WeeklyRecurrence extends \Google\Model
{
/**
* The day of the week is unspecified.
*/
public const DAY_DAY_OF_WEEK_UNSPECIFIED = 'DAY_OF_WEEK_UNSPECIFIED';
/**
* Monday
*/
public const DAY_MONDAY = 'MONDAY';
/**
* Tuesday
*/
public const DAY_TUESDAY = 'TUESDAY';
/**
* Wednesday
*/
public const DAY_WEDNESDAY = 'WEDNESDAY';
/**
* Thursday
*/
public const DAY_THURSDAY = 'THURSDAY';
/**
* Friday
*/
public const DAY_FRIDAY = 'FRIDAY';
/**
* Saturday
*/
public const DAY_SATURDAY = 'SATURDAY';
/**
* Sunday
*/
public const DAY_SUNDAY = 'SUNDAY';
/**
* The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
*
* @var string
*/
public $day;
/**
* The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
*
* Accepted values: DAY_OF_WEEK_UNSPECIFIED, MONDAY, TUESDAY, WEDNESDAY,
* THURSDAY, FRIDAY, SATURDAY, SUNDAY
*
* @param self::DAY_* $day
*/
public function setDay($day)
{
$this->day = $day;
}
/**
* @return self::DAY_*
*/
public function getDay()
{
return $this->day;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleFirestoreAdminV1WeeklyRecurrence::class, 'Google_Service_Firestore_GoogleFirestoreAdminV1WeeklyRecurrence');

View File

@@ -0,0 +1,25 @@
<?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 GoogleLongrunningCancelOperationRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleLongrunningCancelOperationRequest::class, 'Google_Service_Firestore_GoogleLongrunningCancelOperationRequest');

View File

@@ -0,0 +1,95 @@
<?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 GoogleLongrunningListOperationsResponse extends \Google\Collection
{
protected $collection_key = 'unreachable';
/**
* The standard List next-page token.
*
* @var string
*/
public $nextPageToken;
protected $operationsType = GoogleLongrunningOperation::class;
protected $operationsDataType = 'array';
/**
* Unordered list. Unreachable resources. Populated when the request sets
* `ListOperationsRequest.return_partial_success` and reads across
* collections. For example, when attempting to list all resources across all
* supported locations.
*
* @var string[]
*/
public $unreachable;
/**
* The standard List next-page token.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* A list of operations that matches the specified filter in the request.
*
* @param GoogleLongrunningOperation[] $operations
*/
public function setOperations($operations)
{
$this->operations = $operations;
}
/**
* @return GoogleLongrunningOperation[]
*/
public function getOperations()
{
return $this->operations;
}
/**
* Unordered list. Unreachable resources. Populated when the request sets
* `ListOperationsRequest.return_partial_success` and reads across
* collections. For example, when attempting to list all resources across all
* supported locations.
*
* @param string[] $unreachable
*/
public function setUnreachable($unreachable)
{
$this->unreachable = $unreachable;
}
/**
* @return string[]
*/
public function getUnreachable()
{
return $this->unreachable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleLongrunningListOperationsResponse::class, 'Google_Service_Firestore_GoogleLongrunningListOperationsResponse');

View File

@@ -0,0 +1,158 @@
<?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 GoogleLongrunningOperation extends \Google\Model
{
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*
* @var bool
*/
public $done;
protected $errorType = Status::class;
protected $errorDataType = '';
/**
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time. Some
* services might not provide such metadata. Any method that returns a long-
* running operation should document the metadata type, if any.
*
* @var array[]
*/
public $metadata;
/**
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the `name`
* should be a resource name ending with `operations/{unique_id}`.
*
* @var string
*/
public $name;
/**
* The normal, successful response of the operation. If the original method
* returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*
* @var array[]
*/
public $response;
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*
* @param bool $done
*/
public function setDone($done)
{
$this->done = $done;
}
/**
* @return bool
*/
public function getDone()
{
return $this->done;
}
/**
* The error result of the operation in case of failure or cancellation.
*
* @param Status $error
*/
public function setError(Status $error)
{
$this->error = $error;
}
/**
* @return Status
*/
public function getError()
{
return $this->error;
}
/**
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time. Some
* services might not provide such metadata. Any method that returns a long-
* running operation should document the metadata type, if any.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* The server-assigned name, which is only unique within the same service that
* originally returns it. If you use the default HTTP mapping, the `name`
* should be a resource name ending with `operations/{unique_id}`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The normal, successful response of the operation. If the original method
* returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*
* @param array[] $response
*/
public function setResponse($response)
{
$this->response = $response;
}
/**
* @return array[]
*/
public function getResponse()
{
return $this->response;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleLongrunningOperation::class, 'Google_Service_Firestore_GoogleLongrunningOperation');

View File

@@ -0,0 +1,54 @@
<?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 LatLng extends \Google\Model
{
/**
* The latitude in degrees. It must be in the range [-90.0, +90.0].
*
* @var
*/
public $latitude;
/**
* The longitude in degrees. It must be in the range [-180.0, +180.0].
*
* @var
*/
public $longitude;
public function setLatitude($latitude)
{
$this->latitude = $latitude;
}
public function getLatitude()
{
return $this->latitude;
}
public function setLongitude($longitude)
{
$this->longitude = $longitude;
}
public function getLongitude()
{
return $this->longitude;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(LatLng::class, 'Google_Service_Firestore_LatLng');

View File

@@ -0,0 +1,98 @@
<?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 ListCollectionIdsRequest extends \Google\Model
{
/**
* The maximum number of results to return.
*
* @var int
*/
public $pageSize;
/**
* A page token. Must be a value from ListCollectionIdsResponse.
*
* @var string
*/
public $pageToken;
/**
* Reads documents as they were at the given time. This must be a microsecond
* precision timestamp within the past one hour, or if Point-in-Time Recovery
* is enabled, can additionally be a whole minute timestamp within the past 7
* days.
*
* @var string
*/
public $readTime;
/**
* The maximum number of results to return.
*
* @param int $pageSize
*/
public function setPageSize($pageSize)
{
$this->pageSize = $pageSize;
}
/**
* @return int
*/
public function getPageSize()
{
return $this->pageSize;
}
/**
* A page token. Must be a value from ListCollectionIdsResponse.
*
* @param string $pageToken
*/
public function setPageToken($pageToken)
{
$this->pageToken = $pageToken;
}
/**
* @return string
*/
public function getPageToken()
{
return $this->pageToken;
}
/**
* Reads documents as they were at the given time. This must be a microsecond
* precision timestamp within the past one hour, or if Point-in-Time Recovery
* is enabled, can additionally be a whole minute timestamp within the past 7
* days.
*
* @param string $readTime
*/
public function setReadTime($readTime)
{
$this->readTime = $readTime;
}
/**
* @return string
*/
public function getReadTime()
{
return $this->readTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListCollectionIdsRequest::class, 'Google_Service_Firestore_ListCollectionIdsRequest');

View File

@@ -0,0 +1,71 @@
<?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 ListCollectionIdsResponse extends \Google\Collection
{
protected $collection_key = 'collectionIds';
/**
* The collection ids.
*
* @var string[]
*/
public $collectionIds;
/**
* A page token that may be used to continue the list.
*
* @var string
*/
public $nextPageToken;
/**
* The collection ids.
*
* @param string[] $collectionIds
*/
public function setCollectionIds($collectionIds)
{
$this->collectionIds = $collectionIds;
}
/**
* @return string[]
*/
public function getCollectionIds()
{
return $this->collectionIds;
}
/**
* A page token that may be used to continue the list.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListCollectionIdsResponse::class, 'Google_Service_Firestore_ListCollectionIdsResponse');

View File

@@ -0,0 +1,69 @@
<?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 ListDocumentsResponse extends \Google\Collection
{
protected $collection_key = 'documents';
protected $documentsType = Document::class;
protected $documentsDataType = 'array';
/**
* A token to retrieve the next page of documents. If this field is omitted,
* there are no subsequent pages.
*
* @var string
*/
public $nextPageToken;
/**
* The Documents found.
*
* @param Document[] $documents
*/
public function setDocuments($documents)
{
$this->documents = $documents;
}
/**
* @return Document[]
*/
public function getDocuments()
{
return $this->documents;
}
/**
* A token to retrieve the next page of documents. If this field is omitted,
* there are no subsequent pages.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListDocumentsResponse::class, 'Google_Service_Firestore_ListDocumentsResponse');

Some files were not shown because too many files have changed in this diff Show More