Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): rename see Google to see \Google #6647

Merged
merged 1 commit into from
Sep 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Bigtable/src/DataUtil.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ public static function isSystemLittleEndian()
}

/**
* Check if {@see Google\Cloud\Bigtable\DataUtil::intToByteString()} and
* {@see Google\Cloud\Bigtable\DataUtil::byteStringToInt()} supported on
* Check if {@see \Google\Cloud\Bigtable\DataUtil::intToByteString()} and
* {@see \Google\Cloud\Bigtable\DataUtil::byteStringToInt()} supported on
* the current platform.
*
* @return bool
Expand Down
28 changes: 14 additions & 14 deletions Bigtable/src/Filter.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
/**
* This class houses static factory methods which can be used to create a
* hierarchy of filters for use with
* {@see Google\Cloud\Bigtable\Table::checkAndMutateRow()} or
* {@see Google\Cloud\Bigtable\Table::readRows()}.
* {@see \Google\Cloud\Bigtable\Table::checkAndMutateRow()} or
* {@see \Google\Cloud\Bigtable\Table::readRows()}.
*
* Filters are used to take an input row and produce an alternate view of the
* row based on the specified rules. For example, a filter might trim down a row
Expand All @@ -51,7 +51,7 @@
*
* True filters alter the input row by excluding some of its cells wholesale
* from the output row. An example of a true filter is
* {@see Google\Cloud\Bigtable\Filter\Builder\ValueFilter::regex()}, which excludes
* {@see \Google\Cloud\Bigtable\Filter\Builder\ValueFilter::regex()}, which excludes
* cells whose values don't match the specified pattern. All regex true filters
* use [RE2 syntax](https://github.com/google/re2/wiki/Syntax) in raw byte mode
* (RE2::Latin1), and are evaluated as full matches. An important point to keep
Expand All @@ -60,7 +60,7 @@
*
* Transformers alter the input row by changing the values of some of its cells
* in the output, without excluding them completely. An example of such a
* transformer is {@see Google\Cloud\Bigtable\Filter\Builder\ValueFilter::strip()}.
* transformer is {@see \Google\Cloud\Bigtable\Filter\Builder\ValueFilter::strip()}.
*
* The total serialized size of a filter message must not
* exceed 4096 bytes, and filters may not be nested within each other
Expand Down Expand Up @@ -92,7 +92,7 @@ class Filter
* Creates an empty chain filter.
*
* Filters can be added to the chain by invoking
* {@see Google\Cloud\Bigtable\Filter\ChainFilter::addFilter()}.
* {@see \Google\Cloud\Bigtable\Filter\ChainFilter::addFilter()}.
*
* The filters are applied in sequence, progressively narrowing the results.
* The full chain is executed atomically.
Expand Down Expand Up @@ -120,7 +120,7 @@ public static function chain()
* Creates an empty interleave filter.
*
* Filters can be added to the interleave by invoking
* {@see Google\Cloud\Bigtable\Filter\InterleaveFilter::addFilter()}.
* {@see \Google\Cloud\Bigtable\Filter\InterleaveFilter::addFilter()}.
*
* The supplied filters all process a copy of the input row, and the
* results are pooled, sorted, and combined into a single output row. If
Expand Down Expand Up @@ -169,19 +169,19 @@ public static function interleave()
* Creates a condition filter.
*
* If the result of predicate filter outputs any cells the filter configured
* by {@see Google\Cloud\Bigtable\Filter\ConditionFilter::then()} will be
* by {@see \Google\Cloud\Bigtable\Filter\ConditionFilter::then()} will be
* applied. Conversely, if the predicate results in no cells, the filter
* configured by
* {@see Google\Cloud\Bigtable\Filter\ConditionFilter::otherwise()} will
* {@see \Google\Cloud\Bigtable\Filter\ConditionFilter::otherwise()} will
* then be applied instead.
*
* IMPORTANT NOTE: The predicate filter does not execute atomically with the
* {@see Google\Cloud\Bigtable\Filter\ConditionFilter::then()}
* and {@see Google\Cloud\Bigtable\Filter\ConditionFilter::otherwise()}
* {@see \Google\Cloud\Bigtable\Filter\ConditionFilter::then()}
* and {@see \Google\Cloud\Bigtable\Filter\ConditionFilter::otherwise()}
* filters, which may lead to inconsistent or unexpected results.
* Additionally, {@see Google\Cloud\Bigtable\Filter\ConditionFilter} may
* Additionally, {@see \Google\Cloud\Bigtable\Filter\ConditionFilter} may
* have poor performance, especially when filters are set for the
* {@see Google\Cloud\Bigtable\Filter\ConditionFilter::otherwise()}.
* {@see \Google\Cloud\Bigtable\Filter\ConditionFilter::otherwise()}.
*
* Example:
* ```
Expand Down Expand Up @@ -397,9 +397,9 @@ public static function sink()
*
* Due to technical limitation, it is not currently possible to apply
* multiple labels to a cell. As a result, a
* {@see Google\Cloud\Bigtable\Filter\ChainFilter} may have no more than one
* {@see \Google\Cloud\Bigtable\Filter\ChainFilter} may have no more than one
* sub-filter which contains a label. It is okay for a
* {@see Google\Cloud\Bigtable\Filter\InterleaveFilter} to contain multiple
* {@see \Google\Cloud\Bigtable\Filter\InterleaveFilter} to contain multiple
* labels, as they will be applied to separate copies of the input. This may
* be relaxed in the future.
*
Expand Down
4 changes: 2 additions & 2 deletions Bigtable/src/Filter/Builder/LimitFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class LimitFilter
/**
* Matches only the first N cells of each row. If duplicate cells are
* present, as is possible when using an
* {@see Google\Cloud\Bigtable\Filter\InterleaveFilter}, each copy of the
* {@see \Google\Cloud\Bigtable\Filter\InterleaveFilter}, each copy of the
* cell is counted separately.
*
* Example:
Expand All @@ -59,7 +59,7 @@ public function cellsPerRow($count)
* timestamps 10 and 9 skip all earlier cells in `foo:bar`, and then begin
* matching again in column `foo:bar2`. If duplicate cells are present, as
* is possible when using an
* {@see Google\Cloud\Bigtable\Filter\InterleaveFilter}, each copy of the
* {@see \Google\Cloud\Bigtable\Filter\InterleaveFilter}, each copy of the
* cell is counted separately.
*
* Example:
Expand Down
2 changes: 1 addition & 1 deletion Bigtable/src/Filter/Builder/OffsetFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class OffsetFilter
/**
* Skips the first N cells of each row, matching all subsequent cells. If
* duplicate cells are present, as is possible when using an
* {@see Google\Cloud\Bigtable\Filter\InterleaveFilter}, each copy of the
* {@see \Google\Cloud\Bigtable\Filter\InterleaveFilter}, each copy of the
* cell is counted separately.
*
* Example:
Expand Down
2 changes: 1 addition & 1 deletion Bigtable/src/Filter/SimpleFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

/**
* A simple filter. Instead of constructing this class manually please
* utilize the static builders found in {@see Google\Cloud\Bigtable\Filter}.
* utilize the static builders found in {@see \Google\Cloud\Bigtable\Filter}.
*
* @internal
*/
Expand Down
2 changes: 1 addition & 1 deletion Bigtable/src/ReadModifyWriteRowRules.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* the specified rows contents are to be transformed into writes. Entries are
* applied in order, meaning that earlier rules will affect the results of later
* ones. This is intended to be used in combination with
* {@see Google\Cloud\Bigtable\Table::readModifyWriteRow()}.
* {@see \Google\Cloud\Bigtable\Table::readModifyWriteRow()}.
*/
class ReadModifyWriteRowRules
{
Expand Down
22 changes: 11 additions & 11 deletions Bigtable/src/Table.php
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ class Table
* replication. **Defaults to** the "default" application profile.
* @type array $headers Headers to be passed with each request.
* @type int $retries Number of times to retry. **Defaults to** `3`.
* This settings only applies to {@see Google\Cloud\Bigtable\Table::mutateRows()},
* {@see Google\Cloud\Bigtable\Table::upsert()} and
* {@see Google\Cloud\Bigtable\Table::readRows()}.
* This settings only applies to {@see \Google\Cloud\Bigtable\Table::mutateRows()},
* {@see \Google\Cloud\Bigtable\Table::upsert()} and
* {@see \Google\Cloud\Bigtable\Table::readRows()}.
* }
*/
public function __construct(
Expand Down Expand Up @@ -111,7 +111,7 @@ public function __construct(
*
* @param array $rowMutations An associative array with the key being the
* row key and the value being the
* {@see Google\Cloud\Bigtable\Mutations} to perform.
* {@see \Google\Cloud\Bigtable\Mutations} to perform.
* @param array $options [optional] Configuration options.
* @return void
* @throws ApiException|BigtableDataOperationException If the remote call fails or operation fails.
Expand Down Expand Up @@ -253,7 +253,7 @@ public function upsert(array $rows, array $options = [])
* (`endKeyOpen` or `endKeyClosed`).
* @type FilterInterface $filter A filter used to take an input row and
* produce an alternate view of the row based on the specified rules.
* To learn more please see {@see Google\Cloud\Bigtable\Filter} which
* To learn more please see {@see \Google\Cloud\Bigtable\Filter} which
* provides static factory methods for the various filter types.
* @type int $rowsLimit The number of rows to scan.
* @type int $retries Number of times to retry. **Defaults to** `3`.
Expand Down Expand Up @@ -447,10 +447,10 @@ public function sampleRowKeys(array $options = [])
* row. Depending on whether or not any results are yielded, either the
* trueMutations or falseMutations will be executed. If unset, checks that the
* row contains any values at all. Only a single condition can be set, however
* that filter can be {@see Google\Cloud\Bigtable\Filter::chain()} or
* {@see Google\Cloud\Bigtable\Filter::interleave()} which can wrap multiple other
* that filter can be {@see \Google\Cloud\Bigtable\Filter::chain()} or
* {@see \Google\Cloud\Bigtable\Filter::interleave()} which can wrap multiple other
* filters.
* WARNING: {@see Google\Cloud\Bigtable\Filter::condition()} is not supported.
* WARNING: {@see \Google\Cloud\Bigtable\Filter::condition()} is not supported.
* @type Mutations $trueMutations Mutations to be atomically applied when the predicate
* filter's condition yields at least one cell when applied to the row. Please note
* either `trueMutations` or `falseMutations` must be provided.
Expand All @@ -462,9 +462,9 @@ public function sampleRowKeys(array $options = [])
* @return bool Returns true if predicate filter yielded any output, false otherwise.
* @throws ApiException If the remote call fails or operation fails
* @throws \InvalidArgumentException If neither of $trueMutations or $falseMutations is set.
* If $predicateFilter is not instance of {@see Google\Cloud\Bigtable\Filter\FilterInterface}.
* If $trueMutations is set and is not instance of {@see Google\Cloud\Bigtable\Mutations}.
* If $falseMutations is set and is not instance of {@see Google\Cloud\Bigtable\Mutations}.
* If $predicateFilter is not instance of {@see \Google\Cloud\Bigtable\Filter\FilterInterface}.
* If $trueMutations is set and is not instance of {@see \Google\Cloud\Bigtable\Mutations}.
* If $falseMutations is set and is not instance of {@see \Google\Cloud\Bigtable\Mutations}.
*/
public function checkAndMutateRow($rowKey, array $options = [])
{
Expand Down
2 changes: 1 addition & 1 deletion Core/src/Batch/BatchTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ abstract protected function getCallback();
* responsible for serializing closures used in the
* `$clientConfig`. This is especially important when using the
* batch daemon. **Defaults to**
* {@see Google\Cloud\Core\Batch\OpisClosureSerializer} if the
* {@see \Google\Cloud\Core\Batch\OpisClosureSerializer} if the
* `opis/closure` library is installed.
* }
* @throws \InvalidArgumentException
Expand Down
2 changes: 1 addition & 1 deletion Core/src/Batch/QueueOverflowException.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
namespace Google\Cloud\Core\Batch;

/**
* Exception thrown in {@see Google\Cloud\Core\Batch\SysvProcessor::submit()}
* Exception thrown in {@see \Google\Cloud\Core\Batch\SysvProcessor::submit()}
* method when it cannot add an item to the message queue.
* Possible causes include:
*
Expand Down
2 changes: 1 addition & 1 deletion Core/src/Batch/SerializableClientTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ trait SerializableClientTrait
* responsible for serializing closures used in the
* `$clientConfig`. This is especially important when using the
* batch daemon. **Defaults to**
* {@see Google\Cloud\Core\Batch\OpisClosureSerializer} if the
* {@see \Google\Cloud\Core\Batch\OpisClosureSerializer} if the
* `opis/closure` library is installed.
* @type array $clientConfig A config used to construct the client upon
* which requests will be made.
Expand Down
2 changes: 1 addition & 1 deletion Core/src/Batch/SimpleJobTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ abstract public function run();
* responsible for serializing closures used in the
* `$clientConfig`. This is especially important when using the
* batch daemon. **Defaults to**
* {@see Google\Cloud\Core\Batch\OpisClosureSerializer} if the
* {@see \Google\Cloud\Core\Batch\OpisClosureSerializer} if the
* `opis/closure` library is installed.
* }
*/
Expand Down
2 changes: 1 addition & 1 deletion Core/src/ExponentialBackoff.php
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public function setDelayFunction(callable $delayFunction)

/**
* If not set, defaults to using
* {@see Google\Cloud\Core\ExponentialBackoff::calculateDelay()}.
* {@see \Google\Cloud\Core\ExponentialBackoff::calculateDelay()}.
*
* @param callable $calcDelayFunction
* @return void
Expand Down
2 changes: 1 addition & 1 deletion Core/src/GrpcRequestWrapper.php
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class GrpcRequestWrapper
/**
* @param array $config [optional] {
* Configuration options. Please see
* {@see Google\Cloud\Core\RequestWrapperTrait::setCommonDefaults()} for
* {@see \Google\Cloud\Core\RequestWrapperTrait::setCommonDefaults()} for
* the other available options.
*
* @type callable $authHttpHandler A handler used to deliver Psr7
Expand Down
6 changes: 3 additions & 3 deletions Core/src/Iam/Iam.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
* This class is not meant to be used directly. It should be accessed
* through other objects which support IAM.
*
* Policies can be created using the {@see Google\Cloud\Core\Iam\PolicyBuilder}
* Policies can be created using the {@see \Google\Cloud\Core\Iam\PolicyBuilder}
* to help ensure their validity.
*
* Example:
Expand Down Expand Up @@ -98,7 +98,7 @@ public function __construct(IamConnectionInterface $connection, $resource, array
*
* If a policy has already been retrieved from the API, it will be returned.
* To fetch a fresh copy of the policy, use
* {@see Google\Cloud\Core\Iam\Iam::reload()}.
* {@see \Google\Cloud\Core\Iam\Iam::reload()}.
*
* Example:
* ```
Expand Down Expand Up @@ -136,7 +136,7 @@ public function policy(array $options = [])
* ```
*
* @param array|PolicyBuilder $policy The new policy, as an array or an
* instance of {@see Google\Cloud\Core\Iam\PolicyBuilder}.
* instance of {@see \Google\Cloud\Core\Iam\PolicyBuilder}.
* @param array $options Configuration Options
* @return array An array of policy data
* @throws \InvalidArgumentException If the given policy is not an array or PolicyBuilder.
Expand Down
2 changes: 1 addition & 1 deletion Core/src/RequestWrapper.php
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ class RequestWrapper
/**
* @param array $config [optional] {
* Configuration options. Please see
* {@see Google\Cloud\Core\RequestWrapperTrait::setCommonDefaults()} for
* {@see \Google\Cloud\Core\RequestWrapperTrait::setCommonDefaults()} for
* the other available options.
*
* @type string $componentVersion The current version of the component from
Expand Down
2 changes: 1 addition & 1 deletion Core/src/Retry.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
/**
* Retry implementation.
*
* Unlike {@see Google\Cloud\Core\ExponentialBackoff}, Retry requires an implementor
* Unlike {@see \Google\Cloud\Core\ExponentialBackoff}, Retry requires an implementor
* to supply wait times for each iteration.
*/
class Retry
Expand Down
Loading
Loading