+
+
+
+
+
+
+
+
+
+
+
+
+
+ Class containing functions used to build the Agent header.
Provides basic array helper methods.
BidiStream is the response object from a gRPC bidirectional streaming API call.
Contains information necessary to manage a network request.
Common functions used to work with various clients.
ClientStream is the response object from a gRPC client streaming API call.
The CredentialsWrapper object provides a wrapper around a FetchAuthTokenInterface.
A collection of elements retrieved using one or more API calls. The +collection will attempt to retrieve a fixed number of elements, and +will make API calls until that fixed number is reached, or there +are no more elements to retrieve.
Container class for Protobuf label constants. See FieldDescriptorProto.Label in +https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
Container class for Protobuf type constants. See FieldDescriptorProto.Type in +https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
Common functions used to work with various clients.
Provides helper methods for gRPC support.
For connect to emulator.
Response object from a long running API method.
A Page object wraps an API list method response and provides methods +to retrieve additional pages using the page token.
Holds the description information used for page streaming.
Response object for paged results from a list API method
Represents a path template.
Builds a PSR-7 request from a set of request information.
Encapsulates request params header metadata.
Provides functionality for loading a resource name template map from a descriptor config, +retrieving a PathTemplate, and parsing values using registered templates.
The RetrySettings class is used to configure retrying and timeouts for RPCs.
Collection of methods to help with serialization of protobuf objects
ServerStream is the response object from a server streaming API call.
Provides helper methods for service address handling.
Provides a light wrapper around often used URI related functions.
Represents an exception thrown during an RPC.
ValidationException represents a local error (i.e. not during an RPC call).
class + AgentHeader (View source) +
+ + + + + +Class containing functions used to build the Agent header.
| + AGENT_HEADER_KEY + | +
+ + + |
+
| + UNKNOWN_VERSION + | +
+ + + |
+
No description
+Reads the gapic version string from a VERSION file. In order to determine the file +location, this method follows this procedure:
+ static array
+ buildAgentHeader(array $headerInfo)
+
+ No description
+ + static string
+ readGapicVersionFromFile(string $callingClass)
+
+ Reads the gapic version string from a VERSION file. In order to determine the file +location, this method follows this procedure:
+class + ApiException extends Exception (View source) +
+ + + + + +Represents an exception thrown during an RPC.
ApiException constructor.
No description
+Returns the reason in ErrorInfo for an exception, or null if there is no ErrorInfo.
Returns the domain in ErrorInfo for an exception, or null if there is no ErrorInfo.
Returns the metadata in ErrorInfo for an exception, or null if there is no ErrorInfo.
No description
+For REST-based responses, the metadata does not need to be decoded.
No description
+Creates an ApiException from a GuzzleHttp RequestException.
No description
+No description
+String representation of ApiException
+ __construct(string $message, int $code, string $status = null, array $optionalArgs = [])
+
+ ApiException constructor.
+
+ getStatus()
+
+ No description
+ + string|null
+ getReason()
+
+ Returns the reason in ErrorInfo for an exception, or null if there is no ErrorInfo.
string|null
+ getDomain()
+
+ Returns the domain in ErrorInfo for an exception, or null if there is no ErrorInfo.
array|null
+ getErrorInfoMetadata()
+
+ Returns the metadata in ErrorInfo for an exception, or null if there is no ErrorInfo.
static ApiException
+ createFromStdClass(stdClass $status)
+
+ No description
+ + static ApiException
+ createFromApiResponse(string $basicMessage, int $rpcCode, array $metadata = null, Exception $previous = null)
+
+ No description
+ + static ApiException
+ createFromRestApiResponse(string $basicMessage, int $rpcCode, array $metadata = null, Exception $previous = null)
+
+ For REST-based responses, the metadata does not need to be decoded.
+ static ApiException
+ createFromRpcStatus(Status $status)
+
+ No description
+ + static ApiException
+ createFromRequestException(RequestException $ex, bool $isStream = false)
+
+ Creates an ApiException from a GuzzleHttp RequestException.
+ null|string
+ getBasicMessage()
+
+ No description
+ + array
+ getMetadata()
+
+ No description
+ + string
+ __toString()
+
+ String representation of ApiException
+class + ApiStatus (View source) +
+ + + + + + + +| + OK + | +
+ + + |
+
| + CANCELLED + | +
+ + + |
+
| + UNKNOWN + | +
+ + + |
+
| + INVALID_ARGUMENT + | +
+ + + |
+
| + DEADLINE_EXCEEDED + | +
+ + + |
+
| + NOT_FOUND + | +
+ + + |
+
| + ALREADY_EXISTS + | +
+ + + |
+
| + PERMISSION_DENIED + | +
+ + + |
+
| + RESOURCE_EXHAUSTED + | +
+ + + |
+
| + FAILED_PRECONDITION + | +
+ + + |
+
| + ABORTED + | +
+ + + |
+
| + OUT_OF_RANGE + | +
+ + + |
+
| + UNIMPLEMENTED + | +
+ + + |
+
| + INTERNAL + | +
+ + + |
+
| + UNAVAILABLE + | +
+ + + |
+
| + DATA_LOSS + | +
+ + + |
+
| + UNAUTHENTICATED + | +
+ + + |
+
| + UNRECOGNIZED_STATUS + | +
+ + + |
+
| + UNRECOGNIZED_CODE + | +
+ + + |
+
No description
+No description
+No description
+Maps HTTP status codes to Google\Rpc\Code codes.
static bool
+ isValidStatus(string $status)
+
+ No description
+ + static string
+ statusFromRpcCode(int $code)
+
+ No description
+ + static int
+ rpcCodeFromStatus(string $status)
+
+ No description
+ + static int
+ rpcCodeFromHttpStatusCode(int $httpStatusCode)
+
+ Maps HTTP status codes to Google\Rpc\Code codes.
Some codes are left out because they map to multiple gRPC codes (e.g. 500).
+trait + ArrayTrait (View source) +
+ + + +| internal | ++ |
Provides basic array helper methods.
class + BidiStream (View source) +
+ + + + + +BidiStream is the response object from a gRPC bidirectional streaming API call.
BidiStream constructor.
Write request to the server.
Write all requests in $requests.
Inform the server that no more requests will be written. The write() function cannot be +called after closeWrite() is called.
Read the next response from the server. Returns null if the streaming call completed +successfully. Throws an ApiException if the streaming call failed.
Call closeWrite(), and read all responses from the server, until the streaming call is +completed. Throws an ApiException if the streaming call failed.
Return the underlying gRPC call object
+ __construct(BidiStreamingCall $bidiStreamingCall, array $streamingDescriptor = [])
+
+ BidiStream constructor.
+
+ write(mixed $request)
+
+ Write request to the server.
+
+ writeAll(iterable $requests = [])
+
+ Write all requests in $requests.
+
+ closeWrite()
+
+ Inform the server that no more requests will be written. The write() function cannot be +called after closeWrite() is called.
+ mixed
+ read()
+
+ Read the next response from the server. Returns null if the streaming call completed +successfully. Throws an ApiException if the streaming call failed.
+ Generator|array
+ closeWriteAndReadAll()
+
+ Call closeWrite(), and read all responses from the server, until the streaming call is +completed. Throws an ApiException if the streaming call failed.
+ BidiStreamingCall|mixed
+ getBidiStreamingCall()
+
+ Return the underlying gRPC call object
+class + Call (View source) +
+ + + + + +Contains information necessary to manage a network request.
| + UNARY_CALL + | +
+ + + |
+
| + BIDI_STREAMING_CALL + | +
+ + + |
+
| + CLIENT_STREAMING_CALL + | +
+ + + |
+
| + SERVER_STREAMING_CALL + | +
+ + + |
+
| + LONGRUNNING_CALL + | +
+ + + |
+
| + PAGINATED_CALL + | +
+ + + |
+
No description
+No description
+No description
+No description
+No description
+No description
+No description
+
+ __construct(string $method, string $decodeType = null, mixed|Message $message = null, array|null $descriptor = [], int $callType = Call::UNARY_CALL)
+
+ No description
+ + string
+ getMethod()
+
+ No description
+ + int
+ getCallType()
+
+ No description
+ + string
+ getDecodeType()
+
+ No description
+ + mixed|Message
+ getMessage()
+
+ No description
+ + array|null
+ getDescriptor()
+
+ No description
+ + Call
+ withMessage(mixed|Message $message)
+
+ No description
+ +trait + ClientOptionsTrait (View source) +
+ + + +| internal | ++ |
Common functions used to work with various clients.
Provides basic array helper methods.
class + ClientStream (View source) +
+ + + + + +ClientStream is the response object from a gRPC client streaming API call.
ClientStream constructor.
Write request to the server.
Read the response from the server, completing the streaming call.
Write all data in $dataArray and read the response from the server, completing the streaming +call.
Return the underlying gRPC call object
+ __construct(ClientStreamingCall $clientStreamingCall, array $streamingDescriptor = [])
+
+ ClientStream constructor.
+
+ write(mixed $request)
+
+ Write request to the server.
+ mixed
+ readResponse()
+
+ Read the response from the server, completing the streaming call.
+ mixed
+ writeAllAndReadResponse(array $requests)
+
+ Write all data in $dataArray and read the response from the server, completing the streaming +call.
+ ClientStreamingCall|mixed
+ getClientStreamingCall()
+
+ Return the underlying gRPC call object
+class + CredentialsWrapper implements ProjectIdProviderInterface (View source) +
+ + + + + +The CredentialsWrapper object provides a wrapper around a FetchAuthTokenInterface.
No description
+No description
+CredentialsWrapper constructor.
Factory method to create a CredentialsWrapper from an array of options.
No description
+No description
+No description
+Verify that the expected universe domain matches the universe domain from the credentials.
static array
+ validate(array $arr, array $requiredKeys)
+
+ No description
+ + static array
+ validateNotNull(array $arr, array $requiredKeys)
+
+ No description
+ +
+ __construct(FetchAuthTokenInterface $credentialsFetcher, callable $authHttpHandler = null, string $universeDomain = GetUniverseDomainInterface::DEFAULT_UNIVERSE_DOMAIN)
+
+ CredentialsWrapper constructor.
+ static CredentialsWrapper
+ build(array $args = [], string $universeDomain = GetUniverseDomainInterface::DEFAULT_UNIVERSE_DOMAIN)
+
+ Factory method to create a CredentialsWrapper from an array of options.
+ string|null
+ getQuotaProject()
+
+ No description
+ + string|null
+ getProjectId(callable $httpHandler = null)
+
+ No description
+ + string
+ getBearerString()
+ deprecated
+ + deprecated +
No description
+ + callable
+ getAuthorizationHeaderCallback(string $audience = null)
+
+ No description
+ +
+ checkUniverseDomain()
+
+ Verify that the expected universe domain matches the universe domain from the credentials.
+class + FixedSizeCollection implements IteratorAggregate (View source) +
+ + + + + +A collection of elements retrieved using one or more API calls. The +collection will attempt to retrieve a fixed number of elements, and +will make API calls until that fixed number is reached, or there +are no more elements to retrieve.
Returns the number of elements in the collection. This will be +equal to the collectionSize parameter used at construction +unless there are no elements remaining to be retrieved.
Returns true if there are more elements that can be retrieved +from the API.
Returns a page token that can be passed into the API list +method to retrieve additional elements.
Retrieves the next FixedSizeCollection using one or more API calls.
Returns an iterator over the elements of the collection.
Returns an iterator over FixedSizeCollections, starting with this +and making API calls as required until all of the elements have +been retrieved.
+ __construct(Page $initialPage, int $collectionSize)
+
+ FixedSizeCollection constructor.
+ int
+ getCollectionSize()
+
+ Returns the number of elements in the collection. This will be +equal to the collectionSize parameter used at construction +unless there are no elements remaining to be retrieved.
+ bool
+ hasNextCollection()
+
+ Returns true if there are more elements that can be retrieved +from the API.
+ string
+ getNextPageToken()
+
+ Returns a page token that can be passed into the API list +method to retrieve additional elements.
+ FixedSizeCollection
+ getNextCollection()
+
+ Retrieves the next FixedSizeCollection using one or more API calls.
+ Generator
+ getIterator()
+
+ Returns an iterator over the elements of the collection.
+ Generator|FixedSizeCollection[]
+ iterateCollections()
+
+ Returns an iterator over FixedSizeCollections, starting with this +and making API calls as required until all of the elements have +been retrieved.
+class + GPBLabel (View source) +
+ + + + + +Container class for Protobuf label constants. See FieldDescriptorProto.Label in +https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
| + OPTIONAL + | +
+ + + |
+
| + REQUIRED + | +
+ + + |
+
| + REPEATED + | +
+ + + |
+
class + GPBType (View source) +
+ + + + + +Container class for Protobuf type constants. See FieldDescriptorProto.Type in +https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
| + DOUBLE + | +
+ + + |
+
| + FLOAT + | +
+ + + |
+
| + INT64 + | +
+ + + |
+
| + UINT64 + | +
+ + + |
+
| + INT32 + | +
+ + + |
+
| + FIXED64 + | +
+ + + |
+
| + FIXED32 + | +
+ + + |
+
| + BOOL + | +
+ + + |
+
| + STRING + | +
+ + + |
+
| + GROUP + | +
+ + + |
+
| + MESSAGE + | +
+ + + |
+
| + BYTES + | +
+ + + |
+
| + UINT32 + | +
+ + + |
+
| + ENUM + | +
+ + + |
+
| + SFIXED32 + | +
+ + + |
+
| + SFIXED64 + | +
+ + + |
+
| + SINT32 + | +
+ + + |
+
| + SINT64 + | +
+ + + |
+
trait + GapicClientTrait (View source) +
+ + + +| internal | ++ |
Common functions used to work with various clients.
Common functions used to work with various clients.
Provides helper methods for gRPC support.
Provides basic array helper methods.
No description
+No description
+Add a middleware to the call stack by providing a callable which will be +invoked at the start of each call, and will return an instance of +{MiddlewareInterface} when invoked.
Initiates an orderly shutdown in which preexisting calls continue but new +calls are immediately cancelled.
static array
+ validate(array $arr, array $requiredKeys)
+
+ No description
+ + static array
+ validateNotNull(array $arr, array $requiredKeys)
+
+ No description
+ + void
+ addMiddleware(callable $middlewareCallable)
+
+ Add a middleware to the call stack by providing a callable which will be +invoked at the start of each call, and will return an instance of +{MiddlewareInterface} when invoked.
The callable must have the following method signature:
+callable(MiddlewareInterface): MiddlewareInterfaceAn implementation may look something like this:
+$client->addMiddleware(function (MiddlewareInterface $handler) {
+ return new class ($handler) implements MiddlewareInterface {
+ public function __construct(private MiddlewareInterface $handler) {
+ }
+
+ public function __invoke(Call $call, array $options) {
+ // modify call and options (pre-request)
+ $response = ($this->handler)($call, $options);
+ // modify the response (post-request)
+ return $response;
+ }
+ };
+});
+ close()
+
+ Initiates an orderly shutdown in which preexisting calls continue but new +calls are immediately cancelled.
+trait + GrpcSupportTrait (View source) +
+ + + +| internal | ++ |
Provides helper methods for gRPC support.
class + InsecureCredentialsWrapper extends CredentialsWrapper (View source) +
+ + + + + +For connect to emulator.
No description
+No description
+CredentialsWrapper constructor.
Factory method to create a CredentialsWrapper from an array of options.
No description
+No description
+Verify that the expected universe domain matches the universe domain from the credentials.
static array
+ validate(array $arr, array $requiredKeys)
+
+ No description
+ + static array
+ validateNotNull(array $arr, array $requiredKeys)
+
+ No description
+ +
+ __construct()
+
+ CredentialsWrapper constructor.
+ static CredentialsWrapper
+ build(array $args = [], string $universeDomain = GetUniverseDomainInterface::DEFAULT_UNIVERSE_DOMAIN)
+
+ Factory method to create a CredentialsWrapper from an array of options.
+ string|null
+ getQuotaProject()
+
+ No description
+ + string|null
+ getProjectId(callable $httpHandler = null)
+
+ No description
+ + string
+ getBearerString()
+ deprecated
+ + deprecated +
No description
+ + callable
+ getAuthorizationHeaderCallback(string $audience = null)
+
+ No description
+ +
+ checkUniverseDomain()
+
+ Verify that the expected universe domain matches the universe domain from the credentials.
+Middleware which adds a CredentialsWrapper object to the call options.
Middleware to add fixed headers to an API call.
Middleware which wraps the response in an OperationResponse object.
Middleware which filters the $options array.
Middleware which wraps the response in an PagedListResponses object.
Middleware that adds autopopulation functionality. This middlware is +added iff auto population settings are present in the resource +descriptor config for the rpc method in context.
Middleware which transforms $response into [$response, $metadata]
Middleware that adds retry functionality.
Middlewares must take a MiddlewareInterface as their first constructor
+argument {Google\ApiCore\Middleware\ResponseMetadataMiddleware}, which
+represents the next middleware in the chain. This next middleware MUST be
+invoked by this MiddlewareInterface, and the result must be returned as part
+of the __invoke method implementation.
class + CredentialsWrapperMiddleware implements MiddlewareInterface (View source) +
+ + + + + +Middleware which adds a CredentialsWrapper object to the call options.
+ __construct(callable $nextHandler, CredentialsWrapper $credentialsWrapper)
+
+ No description
+ + PromiseInterface|ClientStream|ServerStream|BidiStream
+ __invoke(Call $call, array $options)
+
+ Modify or observe the API call request and response.
The returned value must include the result of the next MiddlewareInterface invocation in the +chain.
+class + FixedHeaderMiddleware implements MiddlewareInterface (View source) +
+ + + + + +Middleware to add fixed headers to an API call.
No description
+
+ __construct(callable $nextHandler, array $headers, bool $overrideUserHeaders = false)
+
+ No description
+ + PromiseInterface|ClientStream|ServerStream|BidiStream
+ __invoke(Call $call, array $options)
+
+ Modify or observe the API call request and response.
The returned value must include the result of the next MiddlewareInterface invocation in the +chain.
+interface + MiddlewareInterface (View source) +
+ + + + + +Middlewares must take a MiddlewareInterface as their first constructor
+argument {Google\ApiCore\Middleware\ResponseMetadataMiddleware}, which
+represents the next middleware in the chain. This next middleware MUST be
+invoked by this MiddlewareInterface, and the result must be returned as part
+of the __invoke method implementation.
To create your own middleware, first implement the interface, as well as pass the handler +in through the constructor:
+use Google\ApiCore\Call;
+use Google\ApiCore\Middleware\MiddlewareInterface;
+
+class MyTestMiddleware implements MiddlewareInterface
+{
+ public function __construct(MiddlewareInterface $handler)
+ {
+. $this->handler = $handler;
+ }
+ public function __invoke(Call $call, array $options)
+ {
+ echo "Logging info about the call: " . $call->getMethod();
+ return ($this->handler)($call, $options);
+ }
+}Next, add the middleware to any class implementing GapicClientTrait by passing in a
+callable which returns the new middleware:
$client = new ExampleGoogleApiServiceClient();
+$client->addMiddleware(function (MiddlewareInterface $handler) {
+ return new MyTestMiddleware($handler);
+}); PromiseInterface|ClientStream|ServerStream|BidiStream
+ __invoke(Call $call, array $options)
+
+ Modify or observe the API call request and response.
The returned value must include the result of the next MiddlewareInterface invocation in the +chain.
+class + OperationsMiddleware implements MiddlewareInterface (View source) +
+ + + + + +Middleware which wraps the response in an OperationResponse object.
No description
+
+ __construct(callable $nextHandler, $operationsClient, array $descriptor)
+
+ No description
+ + PromiseInterface|ClientStream|ServerStream|BidiStream
+ __invoke(Call $call, array $options)
+
+ Modify or observe the API call request and response.
The returned value must include the result of the next MiddlewareInterface invocation in the +chain.
+class + OptionsFilterMiddleware implements MiddlewareInterface (View source) +
+ + + + + +Middleware which filters the $options array.
Provides basic array helper methods.
No description
+
+ __construct(callable $nextHandler, array $permittedOptions)
+
+ No description
+ + PromiseInterface|ClientStream|ServerStream|BidiStream
+ __invoke(Call $call, array $options)
+
+ Modify or observe the API call request and response.
The returned value must include the result of the next MiddlewareInterface invocation in the +chain.
+class + PagedMiddleware implements MiddlewareInterface (View source) +
+ + + + + +Middleware which wraps the response in an PagedListResponses object.
+ __construct(callable $nextHandler, PageStreamingDescriptor $descriptor)
+
+ No description
+ + PromiseInterface|ClientStream|ServerStream|BidiStream
+ __invoke(Call $call, array $options)
+
+ Modify or observe the API call request and response.
The returned value must include the result of the next MiddlewareInterface invocation in the +chain.
+class + RequestAutoPopulationMiddleware implements MiddlewareInterface (View source) +
+ + + +| internal | ++ |
Middleware that adds autopopulation functionality. This middlware is +added iff auto population settings are present in the resource +descriptor config for the rpc method in context.
No description
+
+ __construct(callable $nextHandler, array $autoPopulationSettings)
+
+ No description
+ + PromiseInterface|ClientStream|ServerStream|BidiStream
+ __invoke(Call $call, array $options)
+
+ No description
+ +class + ResponseMetadataMiddleware implements MiddlewareInterface (View source) +
+ + + + + +Middleware which transforms $response into [$response, $metadata]
No description
+
+ __construct(callable $nextHandler)
+
+ No description
+ + PromiseInterface|ClientStream|ServerStream|BidiStream
+ __invoke(Call $call, array $options)
+
+ Modify or observe the API call request and response.
The returned value must include the result of the next MiddlewareInterface invocation in the +chain.
+class + RetryMiddleware implements MiddlewareInterface (View source) +
+ + + + + +Middleware that adds retry functionality.
No description
+No description
+
+ __construct(callable $nextHandler, RetrySettings $retrySettings, $deadlineMs = null, $retryAttempts = 0)
+
+ No description
+ + PromiseInterface|ClientStream|ServerStream|BidiStream
+ __invoke(Call $call, array $options)
+
+ No description
+ + protected
+ getCurrentTimeMs()
+
+ No description
+ +class + OperationResponse (View source) +
+ + + + + +Response object from a long running API method.
The OperationResponse object is returned by API methods that perform +a long running operation. It provides methods that can be used to +poll the status of the operation, retrieve the results, and cancel +the operation.
+To support a long running operation, the server must implement the +Operations API, which is used by the OperationResponse object. If +more control is required, it is possible to make calls against the +Operations API directly instead of via the OperationResponse object +using an Operations Client instance.
| + DEFAULT_POLLING_INTERVAL + | +
+ + + |
+
| + DEFAULT_POLLING_MULTIPLIER + | +
+ + + |
+
| + DEFAULT_MAX_POLLING_INTERVAL + | +
+ + + |
+
| + DEFAULT_MAX_POLLING_DURATION + | +
+ + + |
+
| + private + NEW_CLIENT_NAMESPACE + | +
+ + + |
+
Protected to allow overriding for tests
Protected to allow overriding for tests
OperationResponse constructor.
Check whether the operation has completed.
Check whether the operation completed successfully. If the operation is not complete, or if the operation +failed, return false.
Check whether the operation failed. If the operation is not complete, or if the operation +succeeded, return false.
Get the formatted name of the operation
Poll the server in a loop until the operation is complete.
Reload the status of the operation with a request to the service.
Return the result of the operation. If operationSucceeded() is false, return null.
If the operation failed, return the status. If operationFailed() is false, return null.
Get an array containing the values of 'operationReturnType', 'metadataReturnType', and
+the polling options initialPollDelayMillis, pollDelayMultiplier, maxPollDelayMillis,
+and totalPollTimeoutMillis. The array can be passed as the $options argument to the
+constructor when creating another OperationResponse object.
No description
+No description
+Cancel the long-running operation.
Delete the long-running operation.
Get the metadata returned with the last proto response. If a metadata type was provided, then +the return value will be of that type - otherwise, the return value will be of type Any. If +no metadata object is available, returns null.
protected float
+ getCurrentTimeMillis()
+
+ Protected to allow overriding for tests
+ protected
+ sleepMillis(int $millis)
+
+ Protected to allow overriding for tests
+
+ __construct(string $operationName, object $operationsClient, array $options = [])
+
+ OperationResponse constructor.
+ bool
+ isDone()
+
+ Check whether the operation has completed.
+ bool
+ operationSucceeded()
+
+ Check whether the operation completed successfully. If the operation is not complete, or if the operation +failed, return false.
+ bool
+ operationFailed()
+
+ Check whether the operation failed. If the operation is not complete, or if the operation +succeeded, return false.
+ string
+ getName()
+
+ Get the formatted name of the operation
+ bool
+ pollUntilComplete(array $options = [])
+
+ Poll the server in a loop until the operation is complete.
Return true if the operation completed, otherwise return false. If the +$options['totalPollTimeoutMillis'] setting is not set (or set <= 0) then +pollUntilComplete will continue polling until the operation completes, +and therefore will always return true.
+
+ reload()
+
+ Reload the status of the operation with a request to the service.
+ mixed|null
+ getResult()
+
+ Return the result of the operation. If operationSucceeded() is false, return null.
+ Status|null
+ getError()
+
+ If the operation failed, return the status. If operationFailed() is false, return null.
+ array
+ getDescriptorOptions()
+
+ Get an array containing the values of 'operationReturnType', 'metadataReturnType', and
+the polling options initialPollDelayMillis, pollDelayMultiplier, maxPollDelayMillis,
+and totalPollTimeoutMillis. The array can be passed as the $options argument to the
+constructor when creating another OperationResponse object.
Operation|mixed|null
+ getLastProtoResponse()
+
+ No description
+ + object
+ getOperationsClient()
+
+ No description
+ +
+ cancel()
+
+ Cancel the long-running operation.
For operations of type Google\LongRunning\Operation, this method starts +asynchronous cancellation on a long-running operation. The server +makes a best effort to cancel the operation, but success is not +guaranteed. If the server doesn't support this method, it will throw an +ApiException with code \Google\Rpc\Code::UNIMPLEMENTED. Clients can continue +to use reload and pollUntilComplete methods to check whether the cancellation +succeeded or whether the operation completed despite cancellation. +On successful cancellation, the operation is not deleted; instead, it becomes +an operation with a getError() value with a \Google\Rpc\Status code of 1, +corresponding to \Google\Rpc\Code::CANCELLED.
+
+ delete()
+
+ Delete the long-running operation.
For operations of type Google\LongRunning\Operation, this method +indicates that the client is no longer interested in the operation result. +It does not cancel the operation. If the server doesn't support this method, +it will throw an ApiException with code \Google\Rpc\Code::UNIMPLEMENTED.
+ mixed
+ getMetadata()
+
+ Get the metadata returned with the last proto response. If a metadata type was provided, then +the return value will be of that type - otherwise, the return value will be of type Any. If +no metadata object is available, returns null.
+The CallOptions class provides typing to the associative array of options +passed to transport RPC methods. See {TransportInterface::startUnaryCall()}, +{@see TransportInterface::startBidiStreamingCall()}, +{TransportInterface::startClientStreamingCall()}, and +{TransportInterface::startServerStreamingCall()}.
The ClientOptions class adds typing to the associative array of options +passed into each API client constructor. To use this class directly, pass +the result of {ClientOptions::toArray} to the client constructor:
Trait implemented by any class representing an associative array of PHP options.
class + CallOptions implements ArrayAccess (View source) +
+ + + + + +The CallOptions class provides typing to the associative array of options +passed to transport RPC methods. See {TransportInterface::startUnaryCall()}, +{@see TransportInterface::startBidiStreamingCall()}, +{TransportInterface::startClientStreamingCall()}, and +{TransportInterface::startServerStreamingCall()}.
Trait implemented by any class representing an associative array of PHP options.
No description
+No description
+No description
+No description
+ bool
+ offsetExists($offset)
+
+ No description
+ +
+ offsetGet($offset)
+
+ No description
+ + void
+ offsetSet($offset, $value)
+
+ No description
+ + void
+ offsetUnset($offset)
+
+ No description
+ + array
+ toArray()
+
+ No description
+ +
+ __construct(array $options)
+
+ No description
+ +
+ setHeaders(array $headers)
+
+ No description
+ +
+ setTimeoutMillis(int|null $timeoutMillis)
+
+ No description
+ +
+ setTransportOptions(array $transportOptions)
+
+ No description
+ +
+ setTransportSpecificOptions(array $transportSpecificOptions)
+ deprecated
+ + deprecated +
No description
+ +
+ setRetrySettings(RetrySettings|array|null $retrySettings)
+
+ No description
+ +class + ClientOptions implements ArrayAccess (View source) +
+ + + + + +The ClientOptions class adds typing to the associative array of options +passed into each API client constructor. To use this class directly, pass +the result of {ClientOptions::toArray} to the client constructor:
use Google\ApiCore\ClientOptions;
+use Google\Cloud\SecretManager\Client\SecretManagerClient;
+
+$options = new ClientOptions([
+ 'credentials' => '/path/to/my/credentials.json'
+]);
+$secretManager = new SecretManagerClient($options->toArray());Note: It's possible to pass an associative array to the API clients as well, +as ClientOptions will still be used internally for validation.
Trait implemented by any class representing an associative array of PHP options.
No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+ bool
+ offsetExists($offset)
+
+ No description
+ +
+ offsetGet($offset)
+
+ No description
+ + void
+ offsetSet($offset, $value)
+
+ No description
+ + void
+ offsetUnset($offset)
+
+ No description
+ + array
+ toArray()
+
+ No description
+ +
+ __construct(array $options)
+
+ No description
+ + void
+ setApiEndpoint(string|null $apiEndpoint)
+
+ No description
+ + void
+ setDisableRetries(bool $disableRetries)
+
+ No description
+ + void
+ setClientConfig(string|array $clientConfig)
+
+ No description
+ + void
+ setCredentials(string|array|FetchAuthTokenInterface|CredentialsWrapper|null $credentials)
+
+ No description
+ + void
+ setCredentialsConfig(array $credentialsConfig)
+
+ No description
+ + void
+ setTransport(string|TransportInterface|null $transport)
+
+ No description
+ + void
+ setTransportConfig(TransportOptions $transportConfig)
+
+ No description
+ + void
+ setVersionFile(string|null $versionFile)
+
+ No description
+ + void
+ setServiceName(string|null $serviceName)
+
+ No description
+ + void
+ setLibName(string|null $libName)
+
+ No description
+ + void
+ setLibVersion(string|null $libVersion)
+
+ No description
+ + void
+ setGapicVersion(string|null $gapicVersion)
+
+ No description
+ +
+ setClientCertSource(callable|null $clientCertSource)
+
+ No description
+ +
+ setUniverseDomain(string|null $universeDomain)
+
+ No description
+ +trait + OptionsTrait (View source) +
+ + + + + +Trait implemented by any class representing an associative array of PHP options.
This provides validation and typehinting to loosely typed associative arrays.
No description
+No description
+No description
+No description
+No description
+ bool
+ offsetExists($offset)
+
+ No description
+ +
+ offsetGet($offset)
+
+ No description
+ + void
+ offsetSet($offset, $value)
+
+ No description
+ + void
+ offsetUnset($offset)
+
+ No description
+ + array
+ toArray()
+
+ No description
+ +class + TransportOptions implements ArrayAccess (View source) +
+ + + + + + +Trait implemented by any class representing an associative array of PHP options.
No description
+ bool
+ offsetExists($offset)
+
+ No description
+ +
+ offsetGet($offset)
+
+ No description
+ + void
+ offsetSet($offset, $value)
+
+ No description
+ + void
+ offsetUnset($offset)
+
+ No description
+ + array
+ toArray()
+
+ No description
+ +
+ __construct(array $options)
+
+ No description
+ + void
+ setGrpc(GrpcTransportOptions $grpc)
+
+ No description
+ + void
+ setGrpcFallback(GrpcFallbackTransportOptions $grpcFallback)
+
+ No description
+ + void
+ setRest(RestTransportOptions $rest)
+
+ No description
+ +class + GrpcFallbackTransportOptions implements ArrayAccess (View source) +
+ + + + + +The GrpcFallbackTransportOptions class provides typing to the associative array of options used +to configure {\Google\ApiCore\Transport\GrpcFallbackTransport}.
Trait implemented by any class representing an associative array of PHP options.
No description
+No description
+No description
+ bool
+ offsetExists($offset)
+
+ No description
+ +
+ offsetGet($offset)
+
+ No description
+ + void
+ offsetSet($offset, $value)
+
+ No description
+ + void
+ offsetUnset($offset)
+
+ No description
+ + array
+ toArray()
+
+ No description
+ +
+ __construct(array $options)
+
+ No description
+ +
+ setHttpHandler(callable|null $httpHandler)
+
+ No description
+ +
+ setClientCertSource(callable|null $clientCertSource)
+
+ No description
+ +class + GrpcTransportOptions implements ArrayAccess (View source) +
+ + + + + +The GrpcTransportOptions class provides typing to the associative array of options used to +configure {\Google\ApiCore\Transport\GrpcTransport}.
Trait implemented by any class representing an associative array of PHP options.
No description
+No description
+No description
+No description
+No description
+ bool
+ offsetExists($offset)
+
+ No description
+ +
+ offsetGet($offset)
+
+ No description
+ + void
+ offsetSet($offset, $value)
+
+ No description
+ + void
+ offsetUnset($offset)
+
+ No description
+ + array
+ toArray()
+
+ No description
+ +
+ __construct(array $options)
+
+ No description
+ +
+ setStubOpts(array $stubOpts)
+
+ No description
+ +
+ setChannel(Channel|null $channel)
+
+ No description
+ +
+ setInterceptors(array $interceptors)
+
+ No description
+ +
+ setClientCertSource(callable|null $clientCertSource)
+
+ No description
+ +class + RestTransportOptions implements ArrayAccess (View source) +
+ + + + + +The RestTransportOptions class provides typing to the associative array of options used to +configure {\Google\ApiCore\Transport\RestTransport}.
Trait implemented by any class representing an associative array of PHP options.
No description
+No description
+No description
+No description
+ bool
+ offsetExists($offset)
+
+ No description
+ +
+ offsetGet($offset)
+
+ No description
+ + void
+ offsetSet($offset, $value)
+
+ No description
+ + void
+ offsetUnset($offset)
+
+ No description
+ + array
+ toArray()
+
+ No description
+ +
+ __construct(array $options)
+
+ No description
+ +
+ setHttpHandler(callable|null $httpHandler)
+
+ No description
+ +
+ setClientCertSource(callable|null $clientCertSource)
+
+ No description
+ +
+ setRestClientConfigPath(string|null $restClientConfigPath)
+
+ No description
+ +class + Page implements IteratorAggregate (View source) +
+ + + + + +A Page object wraps an API list method response and provides methods +to retrieve additional pages using the page token.
| + FINAL_PAGE_TOKEN + | +
+ + + |
+
Page constructor.
Returns true if there are more pages that can be retrieved from the +API.
Returns the next page token from the response.
Retrieves the next Page object using the next page token.
Return the number of elements in the response.
Return an iterator over the elements in the response.
Return an iterator over Page objects, beginning with this object.
Gets the request object used to generate the Page.
Gets the API response object.
Returns a collection of elements with a fixed size set by +the collectionSize parameter. The collection will only contain +fewer than collectionSize elements if there are no more +pages to be retrieved from the server.
+ __construct(Call $call, array $options, callable $callable, PageStreamingDescriptor $pageStreamingDescriptor, Message $response)
+
+ Page constructor.
+ bool
+ hasNextPage()
+
+ Returns true if there are more pages that can be retrieved from the +API.
+ string
+ getNextPageToken()
+
+ Returns the next page token from the response.
+ Page
+ getNextPage(int $pageSize = null)
+
+ Retrieves the next Page object using the next page token.
+ int
+ getPageElementCount()
+
+ Return the number of elements in the response.
+ Generator
+ getIterator()
+
+ Return an iterator over the elements in the response.
+ Generator|Page[]
+ iteratePages()
+
+ Return an iterator over Page objects, beginning with this object.
Additional Page objects are retrieved lazily via API calls until +all elements have been retrieved.
+ mixed|Message
+ getRequestObject()
+
+ Gets the request object used to generate the Page.
+ mixed|Message
+ getResponseObject()
+
+ Gets the API response object.
+ FixedSizeCollection
+ expandToFixedSizeCollection(int $collectionSize)
+
+ Returns a collection of elements with a fixed size set by +the collectionSize parameter. The collection will only contain +fewer than collectionSize elements if there are no more +pages to be retrieved from the server.
NOTE: it is an error to call this method if an optional parameter +to set the page size is not supported or has not been set in the +API call that was used to create this page. It is also an error +if the collectionSize parameter is less than the page size that +has been set.
+class + PageStreamingDescriptor (View source) +
+ + + + + +Holds the description information used for page streaming.
No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+
+ __construct(array $descriptor)
+
+ No description
+ + static PageStreamingDescriptor
+ createFromFields(array $fields)
+
+ No description
+ + string
+ getRequestPageTokenGetMethod()
+
+ No description
+ + string
+ getRequestPageSizeGetMethod()
+
+ No description
+ + bool
+ requestHasPageSizeField()
+
+ No description
+ + string
+ getResponsePageTokenGetMethod()
+
+ No description
+ + string
+ getResourcesGetMethod()
+
+ No description
+ + string
+ getRequestPageTokenSetMethod()
+
+ No description
+ + string
+ getRequestPageSizeSetMethod()
+
+ No description
+ +class + PagedListResponse implements IteratorAggregate (View source) +
+ + + + + +Response object for paged results from a list API method
The PagedListResponse object is returned by API methods that implement +pagination, and makes it easier to access multiple pages of results +without having to manually manipulate page tokens. Pages are retrieved +lazily, with additional API calls being made as additional results +are required.
+The list elements can be accessed in the following ways:
+Example of using PagedListResponse as an iterator:
+$pagedListResponse = $client->getList(...);
+foreach ($pagedListResponse as $element) {
+ // doSomethingWith($element);
+}Example of iterating over each page of elements:
+$pagedListResponse = $client->getList(...);
+foreach ($pagedListResponse->iteratePages() as $page) {
+ foreach ($page as $element) {
+ // doSomethingWith($element);
+ }
+}Example of accessing the current page, and manually iterating +over pages:
+$pagedListResponse = $client->getList(...);
+$page = $pagedListResponse->getPage();
+// doSomethingWith($page);
+while ($page->hasNextPage()) {
+ $page = $page->getNextPage();
+ // doSomethingWith($page);
+}Returns an iterator over the full list of elements. If the +API response contains a (non-empty) next page token, then +the PagedListResponse object will make calls to the underlying +API to retrieve additional elements as required.
Returns an iterator over the full list of elements. If the +API response contains a (non-empty) next page token, then +the PagedListResponse object will make calls to the underlying +API to retrieve additional elements as required.
Returns an iterator over pages of results. The pages are +retrieved lazily from the underlying API.
Returns a collection of elements with a fixed size set by +the collectionSize parameter. The collection will only contain +fewer than collectionSize elements if there are no more +pages to be retrieved from the server.
Returns an iterator over fixed size collections of results.
+ __construct(Page $firstPage)
+
+ PagedListResponse constructor.
+ Generator
+ iterateAllElements()
+
+ Returns an iterator over the full list of elements. If the +API response contains a (non-empty) next page token, then +the PagedListResponse object will make calls to the underlying +API to retrieve additional elements as required.
NOTE: The result of this method is the same as getIterator(). +Prefer using getIterator(), or iterate directly on the +PagedListResponse object.
+ Generator
+ getIterator()
+
+ Returns an iterator over the full list of elements. If the +API response contains a (non-empty) next page token, then +the PagedListResponse object will make calls to the underlying +API to retrieve additional elements as required.
+ Page
+ getPage()
+
+ Return the current page of results.
+ Page[]
+ iteratePages()
+
+ Returns an iterator over pages of results. The pages are +retrieved lazily from the underlying API.
+ FixedSizeCollection
+ expandToFixedSizeCollection(int $collectionSize)
+
+ Returns a collection of elements with a fixed size set by +the collectionSize parameter. The collection will only contain +fewer than collectionSize elements if there are no more +pages to be retrieved from the server.
NOTE: it is an error to call this method if an optional parameter +to set the page size is not supported or has not been set in the +original API call. It is also an error if the collectionSize parameter +is less than the page size that has been set.
+ Generator|FixedSizeCollection[]
+ iterateFixedSizeCollections(int $collectionSize)
+
+ Returns an iterator over fixed size collections of results.
The collections are retrieved lazily from the underlying API.
+Each collection will have collectionSize elements, with the +exception of the final collection which may contain fewer +elements.
+NOTE: it is an error to call this method if an optional parameter +to set the page size is not supported or has not been set in the +original API call. It is also an error if the collectionSize parameter +is less than the page size that has been set.
+class + PathTemplate implements ResourceTemplateInterface (View source) +
+ + + + + +Represents a path template.
Templates use the syntax of the API platform; see the protobuf of HttpRule for +details. A template consists of a sequence of literals, wildcards, and variable bindings, +where each binding can have a sub-path. A string representation can be parsed into an +instance of PathTemplate, which can then be used to perform matching and instantiation.
PathTemplate constructor.
No description
+Renders a path template using the provided bindings.
Check if $path matches a resource string.
Matches a fully qualified path template string.
+ __construct(string $path = null)
+
+ PathTemplate constructor.
+ string
+ __toString()
+
+ No description
+ + string
+ render(array $bindings)
+
+ Renders a path template using the provided bindings.
+ bool
+ matches(string $path)
+
+ Check if $path matches a resource string.
+ array
+ match(string $path)
+
+ Matches a fully qualified path template string.
+trait + PollingTrait (View source) +
+ + + +| internal | ++ |
Protected to allow overriding for tests
Protected to allow overriding for tests
protected float
+ getCurrentTimeMillis()
+
+ Protected to allow overriding for tests
+ protected
+ sleepMillis(int $millis)
+
+ Protected to allow overriding for tests
+class + RequestBuilder (View source) +
+ + + +| internal | ++ |
Builds a PSR-7 request from a set of request information.
Provides basic array helper methods.
Provides a light wrapper around often used URI related functions.
No description
+No description
+No description
+No description
+No description
+No description
+ UriInterface
+ buildUriWithQuery(string|UriInterface $uri, array $query)
+
+ No description
+ + static array
+ validate(array $arr, array $requiredKeys)
+
+ No description
+ + static array
+ validateNotNull(array $arr, array $requiredKeys)
+
+ No description
+ +
+ __construct(string $baseUri, string $restConfigPath)
+
+ No description
+ + bool
+ pathExists(string $path)
+
+ No description
+ + RequestInterface
+ build(string $path, Message $message, array $headers = [])
+
+ No description
+ +class + RequestParamsHeaderDescriptor (View source) +
+ + + + + +Encapsulates request params header metadata.
| + HEADER_KEY + | +
+ + + |
+
RequestParamsHeaderDescriptor constructor.
Returns an associative array that contains request params header metadata.
+ __construct(array $requestParams)
+
+ RequestParamsHeaderDescriptor constructor.
+ array
+ getHeader()
+
+ Returns an associative array that contains request params header metadata.
+trait + ResourceHelperTrait (View source) +
+ + + +| internal | ++ |
Provides functionality for loading a resource name template map from a descriptor config, +retrieving a PathTemplate, and parsing values using registered templates.
Represents an absolute resource template, meaning that it will always contain a leading slash,
+and may contain a trailing verb (":
Collection of methods for parsing Segments.
Represents a relative resource template, meaning that it will never contain a leading slash or
+trailing verb (":
Represents a segment in a resource template. This is used internally by RelativeResourceTemplate, +but is not intended for public use and may change without notice.
Represents a resource template that may or may not contain a leading slash, and if a leading
+slash is present may contain a trailing verb (":
class + AbsoluteResourceTemplate implements ResourceTemplateInterface (View source) +
+ + + +| internal | ++ |
Represents an absolute resource template, meaning that it will always contain a leading slash,
+and may contain a trailing verb (":
Examples: +/projects +/projects/{project} +/foo/{bar=*}/fizz/:action
+Templates use the syntax of the API platform; see +https://github.com/googleapis/api-common-protos/blob/master/google/api/http.proto +for details. A template consists of a sequence of literals, wildcards, and variable bindings, +where each binding can have a sub-path. A string representation can be parsed into an +instance of AbsoluteResourceTemplate, which can then be used to perform matching and instantiation.
AbsoluteResourceTemplate constructor.
No description
+No description
+No description
+No description
+
+ __construct(string $path)
+
+ AbsoluteResourceTemplate constructor.
+ string
+ __toString()
+
+ No description
+ + string
+ render(array $bindings)
+
+ No description
+ + bool
+ matches(string $path)
+
+ No description
+ + array
+ match(string $path)
+
+ No description
+ +class + Parser (View source) +
+ + + +| internal | ++ |
Collection of methods for parsing Segments.
Parses a path into an array of segments.
static array
+ parseSegments(string $path = null)
+
+ Parses a path into an array of segments.
+class + RelativeResourceTemplate implements ResourceTemplateInterface (View source) +
+ + + +| internal | ++ |
Represents a relative resource template, meaning that it will never contain a leading slash or
+trailing verb (":
Examples: +projects +projects/{project} +foo/{bar=*}/fizz/
+Templates use the syntax of the API platform; see +https://github.com/googleapis/api-common-protos/blob/master/google/api/http.proto +for details. A template consists of a sequence of literals, wildcards, and variable bindings, +where each binding can have a sub-path. A string representation can be parsed into an +instance of AbsoluteResourceTemplate, which can then be used to perform matching and instantiation.
RelativeResourceTemplate constructor.
No description
+No description
+No description
+No description
+
+ __construct(string $path)
+
+ RelativeResourceTemplate constructor.
+ string
+ __toString()
+
+ No description
+ + string
+ render(array $bindings)
+
+ No description
+ + bool
+ matches(string $path)
+
+ No description
+ + array
+ match(string $path)
+
+ No description
+ +interface + ResourceTemplateInterface (View source) +
+ + + +| internal | ++ |
Represents a resource template that may or may not contain a leading slash, and if a leading
+slash is present may contain a trailing verb (":
Examples: +projects +/projects +foo/{bar=*}/fizz/ +/foo/{bar=*}/fizz/:action
+Templates use the syntax of the API platform; see +https://github.com/googleapis/api-common-protos/blob/master/google/api/http.proto +for details. A template consists of a sequence of literals, wildcards, and variable bindings, +where each binding can have a sub-path. A string representation can be parsed into an +instance of AbsoluteResourceTemplate, which can then be used to perform matching and instantiation.
No description
+Renders a resource template using the provided bindings.
Check if $path matches a resource string.
Matches a given $path to a resource template, and returns an array of bindings between +wildcards / variables in the template and values in the path. If $path does not match the +template, then a ValidationException is thrown.
string
+ __toString()
+
+ No description
+ + string
+ render(array $bindings)
+
+ Renders a resource template using the provided bindings.
+ bool
+ matches(string $path)
+
+ Check if $path matches a resource string.
+ array
+ match(string $path)
+
+ Matches a given $path to a resource template, and returns an array of bindings between +wildcards / variables in the template and values in the path. If $path does not match the +template, then a ValidationException is thrown.
+class + Segment (View source) +
+ + + +| internal | ++ |
Represents a segment in a resource template. This is used internally by RelativeResourceTemplate, +but is not intended for public use and may change without notice.
| + LITERAL_SEGMENT + | +
+ + + |
+
| + WILDCARD_SEGMENT + | +
+ + + |
+
| + DOUBLE_WILDCARD_SEGMENT + | +
+ + + |
+
| + VARIABLE_SEGMENT + | +
+ + + |
+
Segment constructor.
No description
+Checks if $value matches this Segment.
No description
+No description
+No description
+No description
+No description
+
+ __construct(int $segmentType, string $value = null, string $key = null, RelativeResourceTemplate $template = null, string $separator = '/')
+
+ Segment constructor.
+ string
+ __toString()
+
+ No description
+ + bool
+ matches(string $value)
+
+ Checks if $value matches this Segment.
+ int
+ getSegmentType()
+
+ No description
+ + string|null
+ getKey()
+
+ No description
+ + string|null
+ getValue()
+
+ No description
+ + RelativeResourceTemplate|null
+ getTemplate()
+
+ No description
+ + string
+ getSeparator()
+
+ No description
+ +class + RetrySettings (View source) +
+ + + + + +The RetrySettings class is used to configure retrying and timeouts for RPCs.
This class can be passed as an optional parameter to RPC methods, or as part +of an optional array in the constructor of a client object. In addition, +many RPCs and API clients accept a PHP array in place of a RetrySettings +object. This can be used to change particular retry parameters without +needing to construct a complete RetrySettings object.
+See the RetrySettings constructor for documentation about parameters that +can be passed to RetrySettings.
+Example of creating a RetrySettings object using the constructor:
+$retrySettings = new RetrySettings([
+ 'initialRetryDelayMillis' => 100,
+ 'retryDelayMultiplier' => 1.3,
+ 'maxRetryDelayMillis' => 60000,
+ 'initialRpcTimeoutMillis' => 20000,
+ 'rpcTimeoutMultiplier' => 1.0,
+ 'maxRpcTimeoutMillis' => 20000,
+ 'totalTimeoutMillis' => 600000,
+ 'retryableCodes' => [ApiStatus::DEADLINE_EXCEEDED, ApiStatus::UNAVAILABLE],
+]);It is also possible to create a new RetrySettings object from an existing +object using the {\Google\ApiCore\RetrySettings::with()} method.
+Example modifying an existing RetrySettings object using with():
$newRetrySettings = $retrySettings->with([
+ 'totalTimeoutMillis' => 700000,
+]);RetrySettings objects can be used to control retries for many RPC methods in +google-cloud-php. +The examples below make use of the +GroupServiceClient +from the Monitoring V3 API, +but they can be applied to other APIs in the +google-cloud-php repository.
+It is possible to specify the retry behavior to be used by an RPC via the
+retrySettings field in the optionalArgs parameter. The retrySettings
+field can contain either a RetrySettings object, or a PHP array containing
+the particular retry parameters to be updated.
Example of disabling retries for a single call to the +listGroups +method, and setting a custom timeout:
+$result = $client->listGroups($name, [
+ 'retrySettings' => [
+ 'retriesEnabled' => false,
+ 'noRetriesRpcTimeoutMillis' => 5000,
+ ]
+]);Example of creating a new RetrySettings object and using it to override +the retry settings for a call to the +listGroups +method:
+$customRetrySettings = new RetrySettings([
+ 'initialRetryDelayMillis' => 100,
+ 'retryDelayMultiplier' => 1.3,
+ 'maxRetryDelayMillis' => 60000,
+ 'initialRpcTimeoutMillis' => 20000,
+ 'rpcTimeoutMultiplier' => 1.0,
+ 'maxRpcTimeoutMillis' => 20000,
+ 'totalTimeoutMillis' => 600000,
+ 'retryableCodes' => [ApiStatus::DEADLINE_EXCEEDED, ApiStatus::UNAVAILABLE],
+]);
+
+$result = $client->listGroups($name, [
+ 'retrySettings' => $customRetrySettings
+]);It is also possible to specify the retry behavior for RPC methods when +constructing a client object using the 'retrySettingsArray'. The examples +below again make use of the +GroupServiceClient +from the Monitoring V3 API, +but they can be applied to other APIs in the +google-cloud-php repository.
+The GroupServiceClient object accepts an optional retrySettingsArray
+parameter, which can be used to specify retry behavior for RPC methods
+on the client. The retrySettingsArray accepts a PHP array in which keys
+are the names of RPC methods on the client, and values are either a
+RetrySettings object or a PHP array containing the particular retry
+parameters to be updated.
Example updating the retry settings for four methods of GroupServiceClient:
+use Google\Cloud\Monitoring\V3\GroupServiceClient;
+
+$customRetrySettings = new RetrySettings([
+ 'initialRetryDelayMillis' => 100,
+ 'retryDelayMultiplier' => 1.3,
+ 'maxRetryDelayMillis' => 60000,
+ 'initialRpcTimeoutMillis' => 20000,
+ 'rpcTimeoutMultiplier' => 1.0,
+ 'maxRpcTimeoutMillis' => 20000,
+ 'totalTimeoutMillis' => 600000,
+ 'retryableCodes' => [ApiStatus::DEADLINE_EXCEEDED, ApiStatus::UNAVAILABLE],
+]);
+
+$updatedCustomRetrySettings = $customRetrySettings->with([
+ 'totalTimeoutMillis' => 700000
+]);
+
+$client = new GroupServiceClient([
+ 'retrySettingsArray' => [
+ 'listGroups' => ['retriesEnabled' => false],
+ 'getGroup' => [
+ 'initialRpcTimeoutMillis' => 10000,
+ 'maxRpcTimeoutMillis' => 30000,
+ 'totalTimeoutMillis' => 60000,
+ ],
+ 'deleteGroup' => $customRetrySettings,
+ 'updateGroup' => $updatedCustomRetrySettings
+ ],
+]);To configure the use of a logical timeout, where a logical timeout is the +duration a method is given to complete one or more RPC attempts, with each +attempt using only the time remaining in the logical timeout, use +{\Google\ApiCore\RetrySettings::logicalTimeout()} combined with +{[\Google\ApiCore\RetrySettings::with()}.
+$timeoutSettings](../../Google/ApiCore/RetrySettings.html) = RetrySettings::logicalTimeout(30000);
+
+$customRetrySettings = $customRetrySettings->with($timeoutSettings);
+
+$result = $client->listGroups($name, [
+ 'retrySettings' => $customRetrySettings
+]);{\Google\ApiCore\RetrySettings::logicalTimeout()} can also be used on a +method call independent of a RetrySettings instance.
+$timeoutSettings = RetrySettings::logicalTimeout(30000);
+
+$result = $client->listGroups($name, [
+ 'retrySettings' => $timeoutSettings
+]);| + DEFAULT_MAX_RETRIES + | +
+ + + |
+
No description
+No description
+Constructs an instance.
Constructs an array mapping method names to CallSettings.
No description
+Creates a new instance of RetrySettings that updates the settings in the existing instance +with the settings specified in the $settings parameter.
Creates an associative array of the {\Google\ApiCore\RetrySettings} timeout fields configured +with the given timeout specified in the $timeout parameter interpreted as a logical timeout.
No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+No description
+ static array
+ validate(array $arr, array $requiredKeys)
+
+ No description
+ + static array
+ validateNotNull(array $arr, array $requiredKeys)
+
+ No description
+ +
+ __construct(array $settings)
+
+ Constructs an instance.
+ static RetrySettings[]
+ load(string $serviceName, array $clientConfig, bool $disableRetries = false)
+
+ Constructs an array mapping method names to CallSettings.
+ static
+ constructDefault()
+
+ No description
+ + RetrySettings
+ with(array $settings)
+
+ Creates a new instance of RetrySettings that updates the settings in the existing instance +with the settings specified in the $settings parameter.
+ static array
+ logicalTimeout(int $timeout)
+
+ Creates an associative array of the {\Google\ApiCore\RetrySettings} timeout fields configured +with the given timeout specified in the $timeout parameter interpreted as a logical timeout.
+ bool
+ retriesEnabled()
+
+ No description
+ + int
+ getNoRetriesRpcTimeoutMillis()
+
+ No description
+ + int[]
+ getRetryableCodes()
+
+ No description
+ + int
+ getInitialRetryDelayMillis()
+
+ No description
+ + float
+ getRetryDelayMultiplier()
+
+ No description
+ + int
+ getMaxRetryDelayMillis()
+
+ No description
+ + int
+ getInitialRpcTimeoutMillis()
+
+ No description
+ + float
+ getRpcTimeoutMultiplier()
+
+ No description
+ + int
+ getMaxRpcTimeoutMillis()
+
+ No description
+ + int
+ getTotalTimeoutMillis()
+
+ No description
+ +
+ getMaxRetries()
+
+ No description
+ +
+ getRetryFunction()
+
+ No description
+ +class + Serializer (View source) +
+ + + + + +Collection of methods to help with serialization of protobuf objects
| + MAP_KEY_FIELD_NAME + | +
+ + + |
+
| + MAP_VALUE_FIELD_NAME + | +
+ + + |
+
Serializer constructor.
Encode protobuf message as a PHP array
Decode PHP array into the specified protobuf message
No description
+No description
+Decode metadata received from gRPC status object
Decode an array of Any messages into a printable PHP array.
No description
+No description
+Convert string from camelCase to snake_case
Convert string from snake_case to camelCase
No description
+
+ __construct(array $fieldTransformers = [], array $messageTypeTransformers = [], array $decodeFieldTransformers = [], array $decodeMessageTypeTransformers = [], $customEncoders = [])
+
+ Serializer constructor.
+ array
+ encodeMessage(mixed $message)
+
+ Encode protobuf message as a PHP array
+ mixed
+ decodeMessage(mixed $message, array $data)
+
+ Decode PHP array into the specified protobuf message
+ static string
+ serializeToJson(Message $message)
+
+ No description
+ + static array
+ serializeToPhpArray(Message $message)
+
+ No description
+ + static array
+ decodeMetadata(array $metadata)
+
+ Decode metadata received from gRPC status object
+ static array
+ decodeAnyMessages(iterable $anyArray)
+
+ Decode an array of Any messages into a printable PHP array.
+ static string
+ getGetter(string $name)
+
+ No description
+ + static string
+ getSetter(string $name)
+
+ No description
+ + static string
+ toSnakeCase(string $key)
+
+ Convert string from camelCase to snake_case
+ static string
+ toCamelCase(string $key)
+
+ Convert string from snake_case to camelCase
+ static
+ loadKnownMetadataTypes()
+
+ No description
+ +class + ServerStream (View source) +
+ + + + + +ServerStream is the response object from a server streaming API call.
ServerStream constructor.
A generator which yields results from the server until the streaming call +completes. Throws an ApiException if the streaming call failed.
Return the underlying call object.
+ __construct(ServerStreamingCallInterface $serverStreamingCall, array $streamingDescriptor = [])
+
+ ServerStream constructor.
+ Generator|mixed
+ readAll()
+
+ A generator which yields results from the server until the streaming call +completes. Throws an ApiException if the streaming call failed.
+ ServerStreamingCallInterface
+ getServerStreamingCall()
+
+ Return the underlying call object.
+interface + ServerStreamingCallInterface (View source) +
+ + + +| internal | ++ |
Start the call.
No description
+No description
+No description
+No description
+Cancels the call.
Set the CallCredentials for the underlying Call.
void
+ start(mixed $data, array $metadata = [], array $options = [])
+
+ Start the call.
+ mixed
+ responses()
+
+ No description
+ + stdClass
+ getStatus()
+
+ Return the status of the server stream.
+ mixed
+ getMetadata()
+
+ No description
+ + mixed
+ getTrailingMetadata()
+
+ No description
+ + string
+ getPeer()
+
+ No description
+ + void
+ cancel()
+
+ Cancels the call.
+ void
+ setCallCredentials(mixed $call_credentials)
+
+ Set the CallCredentials for the underlying Call.
+trait + ServiceAddressTrait (View source) +
+ + ++ deprecated +
Provides helper methods for service address handling.
+ +
The MockBidiStreamingCall class is used to mock out the \Grpc\BidiStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BidiStreamingCall.php)
The MockClientStreamingCall class is used to mock out the \Grpc\ClientStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ClientStreamingCall.php)
Generated from protobuf message google.apicore.testing.MockRequest
Generated from protobuf message google.apicore.testing.MockRequestBody
Generated from protobuf message google.apicore.testing.MockResponse
The MockServerStreamingCall class is used to mock out the \Grpc\ServerStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ServerStreamingCall.php)
The MockStubTrait is used by generated mock stub classes which extent \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +It provides functionality to add responses, get received calls, and overrides the _simpleRequest +method so that the elements of $responses are returned instead of making a call to the API.
The MockUnaryCall class is used to mock out the \Grpc\UnaryCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/UnaryCall.php)
Class ReceivedRequest used to hold the function name and request object of a call +make to a mock gRPC stub.
abstract class + GeneratedTest extends TestCase (View source) +
+ + + +| internal | ++ |
No description
+
+ assertProtobufEquals(mixed $expected, mixed $actual)
+
+ No description
+ +class + MessageAwareArrayComparator extends ArrayComparator (View source) +
+ + + +| internal | ++ |
No description
+
+ __construct()
+
+ No description
+ +class + MessageAwareExporter extends Exporter (View source) +
+ + + +| internal | ++ |
Exports a value into a single-line string
string
+ shortenedExport(mixed $value)
+
+ Exports a value into a single-line string
+class + MockBidiStreamingCall extends BidiStreamingCall (View source) +
+ + + +| internal | ++ |
The MockBidiStreamingCall class is used to mock out the \Grpc\BidiStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BidiStreamingCall.php)
No description
+MockBidiStreamingCall constructor.
No description
+Save the request object, to be retrieved via getReceivedCalls()
Set writesDone to true
Return a list of calls made to write(), and clear $receivedFuncCalls.
protected
+ deserializeMessage(mixed $message, mixed $deserialize)
+
+ No description
+ +
+ __construct(array $responses, mixed|null $deserialize = null, stdClass $status = null)
+
+ MockBidiStreamingCall constructor.
+ mixed|null
+ read()
+
+ No description
+ + stdClass|null
+ getStatus()
+
+ No description
+ +
+ write(Message|mixed $request, array $options = [])
+
+ Save the request object, to be retrieved via getReceivedCalls()
+
+ writesDone()
+
+ Set writesDone to true
+ array
+ popReceivedCalls()
+
+ Return a list of calls made to write(), and clear $receivedFuncCalls.
+class + MockClientStreamingCall extends ClientStreamingCall (View source) +
+ + + +| internal | ++ |
The MockClientStreamingCall class is used to mock out the \Grpc\ClientStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ClientStreamingCall.php)
The MockClientStreamingCall object is constructed with a response object, an optional deserialize +method, and an optional status. The response object and status are returned immediately from the +wait() method. It also provides a write() method that accepts request objects, and a +getAllRequests() method that returns all request objects passed to write(), and clears them.
MockClientStreamingCall constructor.
Immediately return the preset response object and status.
Save the request object, to be retrieved via getReceivedCalls()
Return a list of calls made to write(), and clear $receivedFuncCalls.
+ __construct(Message|string $response, callable|array|null $deserialize = null, stdClass $status = null)
+
+ MockClientStreamingCall constructor.
+ array
+ wait()
+
+ Immediately return the preset response object and status.
+
+ write(Message|mixed $request, array $options = [])
+
+ Save the request object, to be retrieved via getReceivedCalls()
+ array
+ popReceivedCalls()
+
+ Return a list of calls made to write(), and clear $receivedFuncCalls.
+class + MockGrpcTransport extends GrpcTransport (View source) +
+ + + +| internal | ++ |
Provides helper methods for gRPC support.
Provides helper methods for service address handling.
No description
+No description
+No description
+Builds a GrpcTransport.
Returns a promise used to execute network requests.
No description
+No description
+No description
+No description
+No description
+ static array
+ validate(array $arr, array $requiredKeys)
+
+ No description
+ + static array
+ validateNotNull(array $arr, array $requiredKeys)
+
+ No description
+ +
+ __construct(mixed $mockCall = null)
+
+ No description
+ + static GrpcTransport
+ build(string $apiEndpoint, array $config = [])
+
+ Builds a GrpcTransport.
+ BidiStream
+ startBidiStreamingCall(Call $call, array $options)
+
+ Starts a bidi streaming call.
+ ClientStream
+ startClientStreamingCall(Call $call, array $options)
+
+ Starts a client streaming call.
+ ServerStream
+ startServerStreamingCall(Call $call, array $options)
+
+ Starts a server streaming call.
+ PromiseInterface
+ startUnaryCall(Call $call, array $options)
+
+ Returns a promise used to execute network requests.
+ protected
+ _simpleRequest(string $method, array $arguments, callable $deserialize, array $metadata = [], array $options = [])
+
+ No description
+ + protected
+ _clientStreamRequest(string $method, callable $deserialize, array $metadata = [], array $options = [])
+
+ No description
+ + protected
+ _serverStreamRequest(string $method, array $arguments, callable $deserialize, array $metadata = [], array $options = [])
+
+ No description
+ + protected
+ _bidiRequest(string $method, callable $deserialize, array $metadata = [], array $options = [])
+
+ No description
+ +
+ getRequestArguments()
+
+ No description
+ +class + MockRequest extends Message (View source) +
+ + + +| internal | ++ |
Generated from protobuf message google.apicore.testing.MockRequest
| + protected + + | +$page_token | +Generated from protobuf field |
+ + |
| + protected + + | +$page_size | +Generated from protobuf field |
+ + |
Constructor.
Generated from protobuf field string page_token = 1;
Generated from protobuf field string page_token = 1;
Generated from protobuf field uint64 page_size = 2;
Generated from protobuf field uint64 page_size = 2;
+ __construct(array $data = NULL)
+
+ Constructor.
+ string
+ getPageToken()
+
+ Generated from protobuf field string page_token = 1;
$this
+ setPageToken(string $var)
+
+ Generated from protobuf field string page_token = 1;
int|string
+ getPageSize()
+
+ Generated from protobuf field uint64 page_size = 2;
$this
+ setPageSize(int|string $var)
+
+ Generated from protobuf field uint64 page_size = 2;
class + MockRequestBody extends Message (View source) +
+ + + +| internal | ++ |
Generated from protobuf message google.apicore.testing.MockRequestBody
| + protected + + | +$name | +Generated from protobuf field |
+ + |
| + protected + + | +$number | +Generated from protobuf field |
+ + |
| + protected + + | +$nested_message | +Generated from protobuf field |
+ + |
| + protected + + | +$bytes_value | +Generated from protobuf field |
+ + |
| + protected + + | +$duration_value | +Generated from protobuf field |
+ + |
| + protected + + | +$field_mask | +Generated from protobuf field |
+ + |
| + protected + + | +$int64_value | +Generated from protobuf field |
+ + |
| + protected + + | +$list_value | +Generated from protobuf field |
+ + |
| + protected + + | +$string_value | +Generated from protobuf field |
+ + |
| + protected + + | +$struct_value | +Generated from protobuf field |
+ + |
| + protected + + | +$timestamp_value | +Generated from protobuf field |
+ + |
| + protected + + | +$value_value | +Generated from protobuf field |
+ + |
| + protected + + | +$oneof_field | ++ | + |
Constructor.
Generated from protobuf field string name = 1;
Generated from protobuf field string name = 1;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field repeated string repeated_field = 3;
Generated from protobuf field repeated string repeated_field = 3;
Generated from protobuf field .google.apicore.testing.MockRequestBody nested_message = 4;
No description
+No description
+Generated from protobuf field .google.apicore.testing.MockRequestBody nested_message = 4;
Generated from protobuf field .google.protobuf.BytesValue bytes_value = 5;
No description
+No description
+Returns the unboxed value from getBytesValue()
Generated from protobuf field .google.protobuf.BytesValue bytes_value = 5;
Sets the field by wrapping a primitive type in a Google\Protobuf\BytesValue object.
Generated from protobuf field .google.protobuf.Duration duration_value = 6;
No description
+No description
+Generated from protobuf field .google.protobuf.Duration duration_value = 6;
Generated from protobuf field .google.protobuf.FieldMask field_mask = 7;
No description
+No description
+Generated from protobuf field .google.protobuf.FieldMask field_mask = 7;
Generated from protobuf field .google.protobuf.Int64Value int64_value = 8;
No description
+No description
+Returns the unboxed value from getInt64Value()
Generated from protobuf field .google.protobuf.Int64Value int64_value = 8;
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Generated from protobuf field .google.protobuf.ListValue list_value = 9;
No description
+No description
+Generated from protobuf field .google.protobuf.ListValue list_value = 9;
Generated from protobuf field .google.protobuf.StringValue string_value = 10;
No description
+No description
+Returns the unboxed value from getStringValue()
Generated from protobuf field .google.protobuf.StringValue string_value = 10;
Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
Generated from protobuf field .google.protobuf.Struct struct_value = 11;
No description
+No description
+Generated from protobuf field .google.protobuf.Struct struct_value = 11;
Generated from protobuf field .google.protobuf.Timestamp timestamp_value = 12;
No description
+No description
+Generated from protobuf field .google.protobuf.Timestamp timestamp_value = 12;
Generated from protobuf field .google.protobuf.Value value_value = 13;
No description
+No description
+Generated from protobuf field .google.protobuf.Value value_value = 13;
Generated from protobuf field string field_1 = 14;
No description
+Generated from protobuf field string field_1 = 14;
Generated from protobuf field string field_2 = 15;
No description
+Generated from protobuf field string field_2 = 15;
Generated from protobuf field string field_3 = 16;
No description
+Generated from protobuf field string field_3 = 16;
No description
+
+ __construct(array $data = NULL)
+
+ Constructor.
+ string
+ getName()
+
+ Generated from protobuf field string name = 1;
$this
+ setName(string $var)
+
+ Generated from protobuf field string name = 1;
int|string
+ getNumber()
+
+ Generated from protobuf field uint64 number = 2;
$this
+ setNumber(int|string $var)
+
+ Generated from protobuf field uint64 number = 2;
RepeatedField
+ getRepeatedField()
+
+ Generated from protobuf field repeated string repeated_field = 3;
$this
+ setRepeatedField(string[]|RepeatedField $var)
+
+ Generated from protobuf field repeated string repeated_field = 3;
MockRequestBody
+ getNestedMessage()
+
+ Generated from protobuf field .google.apicore.testing.MockRequestBody nested_message = 4;
+ hasNestedMessage()
+
+ No description
+ +
+ clearNestedMessage()
+
+ No description
+ + $this
+ setNestedMessage(MockRequestBody $var)
+
+ Generated from protobuf field .google.apicore.testing.MockRequestBody nested_message = 4;
BytesValue
+ getBytesValue()
+
+ Generated from protobuf field .google.protobuf.BytesValue bytes_value = 5;
+ hasBytesValue()
+
+ No description
+ +
+ clearBytesValue()
+
+ No description
+ + string|null
+ getBytesValueUnwrapped()
+
+ Returns the unboxed value from getBytesValue()
Generated from protobuf field .google.protobuf.BytesValue bytes_value = 5;
$this
+ setBytesValue(BytesValue $var)
+
+ Generated from protobuf field .google.protobuf.BytesValue bytes_value = 5;
$this
+ setBytesValueUnwrapped(string|null $var)
+
+ Sets the field by wrapping a primitive type in a Google\Protobuf\BytesValue object.
Generated from protobuf field .google.protobuf.BytesValue bytes_value = 5;
Duration
+ getDurationValue()
+
+ Generated from protobuf field .google.protobuf.Duration duration_value = 6;
+ hasDurationValue()
+
+ No description
+ +
+ clearDurationValue()
+
+ No description
+ + $this
+ setDurationValue(Duration $var)
+
+ Generated from protobuf field .google.protobuf.Duration duration_value = 6;
FieldMask
+ getFieldMask()
+
+ Generated from protobuf field .google.protobuf.FieldMask field_mask = 7;
+ hasFieldMask()
+
+ No description
+ +
+ clearFieldMask()
+
+ No description
+ + $this
+ setFieldMask(FieldMask $var)
+
+ Generated from protobuf field .google.protobuf.FieldMask field_mask = 7;
Int64Value
+ getInt64Value()
+
+ Generated from protobuf field .google.protobuf.Int64Value int64_value = 8;
+ hasInt64Value()
+
+ No description
+ +
+ clearInt64Value()
+
+ No description
+ + int|string|null
+ getInt64ValueUnwrapped()
+
+ Returns the unboxed value from getInt64Value()
Generated from protobuf field .google.protobuf.Int64Value int64_value = 8;
$this
+ setInt64Value(Int64Value $var)
+
+ Generated from protobuf field .google.protobuf.Int64Value int64_value = 8;
$this
+ setInt64ValueUnwrapped(int|string|null $var)
+
+ Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Generated from protobuf field .google.protobuf.Int64Value int64_value = 8;
ListValue
+ getListValue()
+
+ Generated from protobuf field .google.protobuf.ListValue list_value = 9;
+ hasListValue()
+
+ No description
+ +
+ clearListValue()
+
+ No description
+ + $this
+ setListValue(ListValue $var)
+
+ Generated from protobuf field .google.protobuf.ListValue list_value = 9;
StringValue
+ getStringValue()
+
+ Generated from protobuf field .google.protobuf.StringValue string_value = 10;
+ hasStringValue()
+
+ No description
+ +
+ clearStringValue()
+
+ No description
+ + string|null
+ getStringValueUnwrapped()
+
+ Returns the unboxed value from getStringValue()
Generated from protobuf field .google.protobuf.StringValue string_value = 10;
$this
+ setStringValue(StringValue $var)
+
+ Generated from protobuf field .google.protobuf.StringValue string_value = 10;
$this
+ setStringValueUnwrapped(string|null $var)
+
+ Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
Generated from protobuf field .google.protobuf.StringValue string_value = 10;
Struct
+ getStructValue()
+
+ Generated from protobuf field .google.protobuf.Struct struct_value = 11;
+ hasStructValue()
+
+ No description
+ +
+ clearStructValue()
+
+ No description
+ + $this
+ setStructValue(Struct $var)
+
+ Generated from protobuf field .google.protobuf.Struct struct_value = 11;
Timestamp
+ getTimestampValue()
+
+ Generated from protobuf field .google.protobuf.Timestamp timestamp_value = 12;
+ hasTimestampValue()
+
+ No description
+ +
+ clearTimestampValue()
+
+ No description
+ + $this
+ setTimestampValue(Timestamp $var)
+
+ Generated from protobuf field .google.protobuf.Timestamp timestamp_value = 12;
Value
+ getValueValue()
+
+ Generated from protobuf field .google.protobuf.Value value_value = 13;
+ hasValueValue()
+
+ No description
+ +
+ clearValueValue()
+
+ No description
+ + $this
+ setValueValue(Value $var)
+
+ Generated from protobuf field .google.protobuf.Value value_value = 13;
string
+ getField1()
+
+ Generated from protobuf field string field_1 = 14;
+ hasField1()
+
+ No description
+ + $this
+ setField1(string $var)
+
+ Generated from protobuf field string field_1 = 14;
string
+ getField2()
+
+ Generated from protobuf field string field_2 = 15;
+ hasField2()
+
+ No description
+ + $this
+ setField2(string $var)
+
+ Generated from protobuf field string field_2 = 15;
string
+ getField3()
+
+ Generated from protobuf field string field_3 = 16;
+ hasField3()
+
+ No description
+ + $this
+ setField3(string $var)
+
+ Generated from protobuf field string field_3 = 16;
string
+ getOneofField()
+
+ No description
+ +class + MockResponse extends Message (View source) +
+ + + +| internal | ++ |
Generated from protobuf message google.apicore.testing.MockResponse
| + protected + + | +$name | +Generated from protobuf field |
+ + |
| + protected + + | +$number | +Generated from protobuf field |
+ + |
| + protected + + | +$next_page_token | +Generated from protobuf field |
+ + |
Constructor.
Generated from protobuf field string name = 1;
Generated from protobuf field string name = 1;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field repeated string resources_list = 3;
Generated from protobuf field repeated string resources_list = 3;
Generated from protobuf field string next_page_token = 4;
Generated from protobuf field string next_page_token = 4;
Generated from protobuf field map<string, string> resources_map = 5;
Generated from protobuf field map<string, string> resources_map = 5;
+ __construct(array $data = NULL)
+
+ Constructor.
+ string
+ getName()
+
+ Generated from protobuf field string name = 1;
$this
+ setName(string $var)
+
+ Generated from protobuf field string name = 1;
int|string
+ getNumber()
+
+ Generated from protobuf field uint64 number = 2;
$this
+ setNumber(int|string $var)
+
+ Generated from protobuf field uint64 number = 2;
RepeatedField
+ getResourcesList()
+
+ Generated from protobuf field repeated string resources_list = 3;
$this
+ setResourcesList(string[]|RepeatedField $var)
+
+ Generated from protobuf field repeated string resources_list = 3;
string
+ getNextPageToken()
+
+ Generated from protobuf field string next_page_token = 4;
$this
+ setNextPageToken(string $var)
+
+ Generated from protobuf field string next_page_token = 4;
MapField
+ getResourcesMap()
+
+ Generated from protobuf field map<string, string> resources_map = 5;
$this
+ setResourcesMap(array|MapField $var)
+
+ Generated from protobuf field map<string, string> resources_map = 5;
class + MockServerStreamingCall extends ServerStreamingCall implements ServerStreamingCallInterface (View source) +
+ + + +| internal | ++ |
The MockServerStreamingCall class is used to mock out the \Grpc\ServerStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ServerStreamingCall.php)
No description
+MockServerStreamingCall constructor.
No description
+ protected
+ deserializeMessage(mixed $message, mixed $deserialize)
+
+ No description
+ +
+ __construct(array $responses, callable|array|null $deserialize = null, stdClass $status = null)
+
+ MockServerStreamingCall constructor.
+ mixed
+ responses()
+
+ No description
+ + stdClass
+ getStatus()
+
+ No description
+ +class + MockStatus extends stdClass (View source) +
+ + + +| internal | ++ |
| + Code|int + + | +$code | ++ | + |
| + + + | +$details | ++ | + |
| + + + | +$metadata | ++ | + |
No description
+
+ __construct($code, string $details = null, array $metadata = [])
+
+ No description
+ +trait + MockStubTrait (View source) +
+ + + +| internal | ++ |
The MockStubTrait is used by generated mock stub classes which extent \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +It provides functionality to add responses, get received calls, and overrides the _simpleRequest +method so that the elements of $responses are returned instead of making a call to the API.
No description
+Overrides the _simpleRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockUnaryCall object that will return the first item from $responses
Overrides the _clientStreamRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockClientStreamingCall object that will return the first item from $responses
Overrides the _serverStreamRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockServerStreamingCall object that will stream items from $responses, and return +a final status of $serverStreamingStatus.
Overrides the _bidiRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockBidiStreamingCall object that will stream items from $responses, and return +a final status of $serverStreamingStatus.
No description
+Add a response object, and an optional status, to the list of responses to be returned via +_simpleRequest.
Set the status object to be used when creating streaming calls.
Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.
No description
+No description
+No description
+Creates a sequence such that the responses are returned in order.
+ __construct(callable $deserialize = null)
+
+ No description
+ + MockUnaryCall
+ _simpleRequest(string $method, Message $argument, callable $deserialize, array $metadata = [], array $options = [])
+
+ Overrides the _simpleRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockUnaryCall object that will return the first item from $responses
+ MockClientStreamingCall
+ _clientStreamRequest(string $method, callable $deserialize, array $metadata = [], array $options = [])
+
+ Overrides the _clientStreamRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockClientStreamingCall object that will return the first item from $responses
+ MockServerStreamingCall
+ _serverStreamRequest(string $method, Message $argument, callable $deserialize, array $metadata = [], array $options = [])
+
+ Overrides the _serverStreamRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockServerStreamingCall object that will stream items from $responses, and return +a final status of $serverStreamingStatus.
+ MockBidiStreamingCall
+ _bidiRequest(string $method, callable $deserialize, array $metadata = [], array $options = [])
+
+ Overrides the _bidiRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockBidiStreamingCall object that will stream items from $responses, and return +a final status of $serverStreamingStatus.
+ static
+ stripStatusFromResponses($responses)
+
+ No description
+ +
+ addResponse(Message $response, stdClass $status = null)
+
+ Add a response object, and an optional status, to the list of responses to be returned via +_simpleRequest.
+
+ setStreamingStatus(stdClass $status)
+
+ Set the status object to be used when creating streaming calls.
+ ReceivedRequest[]
+ popReceivedCalls()
+
+ Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.
+ int
+ getReceivedCallCount()
+
+ No description
+ + array
+ popCallObjects()
+
+ No description
+ + bool
+ isExhausted()
+
+ No description
+ + static MockStubTrait
+ create(mixed $responseObject, stdClass $status = null, callable $deserialize = null)
+
+ No description
+ + static MockStubTrait
+ createWithResponseSequence(array $sequence, callable $deserialize = null, stdClass $finalStatus = null)
+
+ Creates a sequence such that the responses are returned in order.
+class + MockTransport implements TransportInterface (View source) +
+ + + +| internal | ++ |
The MockStubTrait is used by generated mock stub classes which extent \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +It provides functionality to add responses, get received calls, and overrides the _simpleRequest +method so that the elements of $responses are returned instead of making a call to the API.
Overrides the _simpleRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockUnaryCall object that will return the first item from $responses
Overrides the _clientStreamRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockClientStreamingCall object that will return the first item from $responses
Overrides the _serverStreamRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockServerStreamingCall object that will stream items from $responses, and return +a final status of $serverStreamingStatus.
Overrides the _bidiRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockBidiStreamingCall object that will stream items from $responses, and return +a final status of $serverStreamingStatus.
Add a response object, and an optional status, to the list of responses to be returned via +_simpleRequest.
Set the status object to be used when creating streaming calls.
Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.
No description
+Creates a sequence such that the responses are returned in order.
No description
+Returns a promise used to execute network requests.
No description
+Closes the connection, if one exists.
+ __construct(callable $deserialize = null)
+
+ No description
+ + MockUnaryCall
+ _simpleRequest(string $method, Message $argument, callable $deserialize, array $metadata = [], array $options = [])
+
+ Overrides the _simpleRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockUnaryCall object that will return the first item from $responses
+ MockClientStreamingCall
+ _clientStreamRequest(string $method, callable $deserialize, array $metadata = [], array $options = [])
+
+ Overrides the _clientStreamRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockClientStreamingCall object that will return the first item from $responses
+ MockServerStreamingCall
+ _serverStreamRequest(string $method, Message $argument, callable $deserialize, array $metadata = [], array $options = [])
+
+ Overrides the _serverStreamRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockServerStreamingCall object that will stream items from $responses, and return +a final status of $serverStreamingStatus.
+ MockBidiStreamingCall
+ _bidiRequest(string $method, callable $deserialize, array $metadata = [], array $options = [])
+
+ Overrides the _bidiRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockBidiStreamingCall object that will stream items from $responses, and return +a final status of $serverStreamingStatus.
+ static
+ stripStatusFromResponses($responses)
+
+ No description
+ +
+ addResponse(Message $response, stdClass $status = null)
+
+ Add a response object, and an optional status, to the list of responses to be returned via +_simpleRequest.
+
+ setStreamingStatus(stdClass $status)
+
+ Set the status object to be used when creating streaming calls.
+ ReceivedRequest[]
+ popReceivedCalls()
+
+ Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.
+ int
+ getReceivedCallCount()
+
+ No description
+ + array
+ popCallObjects()
+
+ No description
+ + bool
+ isExhausted()
+
+ No description
+ + static MockStubTrait
+ create(mixed $responseObject, stdClass $status = null, callable $deserialize = null)
+
+ No description
+ + static MockStubTrait
+ createWithResponseSequence(array $sequence, callable $deserialize = null, stdClass $finalStatus = null)
+
+ Creates a sequence such that the responses are returned in order.
+
+ setAgentHeaderDescriptor($agentHeaderDescriptor)
+
+ No description
+ + PromiseInterface
+ startUnaryCall(Call $call, array $options)
+
+ Returns a promise used to execute network requests.
+ BidiStream
+ startBidiStreamingCall(Call $call, array $options)
+
+ Starts a bidi streaming call.
+ ClientStream
+ startClientStreamingCall(Call $call, array $options)
+
+ Starts a client streaming call.
+ ServerStream
+ startServerStreamingCall(Call $call, array $options)
+
+ Starts a server streaming call.
+
+ __call(string $name, array $arguments)
+
+ No description
+ + void
+ close()
+
+ Closes the connection, if one exists.
+class + MockUnaryCall extends UnaryCall (View source) +
+ + + +| internal | ++ |
The MockUnaryCall class is used to mock out the \Grpc\UnaryCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/UnaryCall.php)
The MockUnaryCall object is constructed with a response object, an optional deserialize +method, and an optional status. The response object and status are returned immediately from the +wait() method.
No description
+MockUnaryCall constructor.
Immediately return the preset response object and status.
protected
+ deserializeMessage(mixed $message, mixed $deserialize)
+
+ No description
+ +
+ __construct(Message|string|null $response = null, callable|array|null $deserialize = null, stdClass $status = null)
+
+ MockUnaryCall constructor.
+ array
+ wait()
+
+ Immediately return the preset response object and status.
+class + ProtobufGPBEmptyComparator extends Comparator (View source) +
+ + + +| internal | ++ |
Returns whether the comparator can compare two values.
Asserts that two values are equal.
bool
+ accepts(mixed $expected, mixed $actual)
+
+ Returns whether the comparator can compare two values.
+
+ assertEquals(Message $expected, Message $actual, float|int $delta = 0, bool $canonicalize = FALSE, bool $ignoreCase = FALSE)
+
+ Asserts that two values are equal.
+class + ProtobufMessageComparator extends Comparator (View source) +
+ + + +| internal | ++ |
| + protected Exporter + + | +$exporter | ++ | + |
No description
+Returns whether the comparator can compare two values.
Asserts that two values are equal.
+ __construct()
+
+ No description
+ + bool
+ accepts(mixed $expected, mixed $actual)
+
+ Returns whether the comparator can compare two values.
+
+ assertEquals(Message $expected, Message $actual, float|int $delta = 0, bool $canonicalize = FALSE, bool $ignoreCase = FALSE)
+
+ Asserts that two values are equal.
+class + ReceivedRequest (View source) +
+ + + +| internal | ++ |
Class ReceivedRequest used to hold the function name and request object of a call +make to a mock gRPC stub.
No description
+No description
+No description
+No description
+No description
+No description
+
+ __construct($funcCall, $requestObject, $deserialize = null, $metadata = [], $options = [])
+
+ No description
+ +
+ getArray()
+
+ No description
+ +
+ getFuncCall()
+
+ No description
+ +
+ getRequestObject()
+
+ No description
+ +
+ getMetadata()
+
+ No description
+ +
+ getOptions()
+
+ No description
+ +trait + SerializationTrait (View source) +
+ + + +| internal | ++ |
No description
+ protected
+ deserializeMessage(mixed $message, mixed $deserialize)
+
+ No description
+ +A transport that sends protobuf over HTTP 1.1 that can be used when full gRPC support +is not available.
A gRPC based transport implementation.
A trait for shared functionality between transports that support only unary RPCs using simple +HTTP requests.
A REST based transport implementation.
Class ForwardingCall wraps a \Grpc\AbstractCall.
Class ForwardingServerStreamingCall wraps a \Grpc\ServerStreamingCall.
Class ForwardingUnaryCall wraps a \Grpc\UnaryCall.
Class ServerStreamingCallWrapper implements \Google\ApiCore\ServerStreamingCallInterface.
Temporary class to support an interceptor-like interface until gRPC interceptor support is +available.
abstract class + ForwardingCall (View source) +
+ + + + + +Class ForwardingCall wraps a \Grpc\AbstractCall.
| + protected AbstractCall|ForwardingCall + + | +$innerCall | ++ | + |
No description
+No description
+No description
+Cancels the call.
+ __construct(AbstractCall|ForwardingCall $innerCall)
+
+ ForwardingCall constructor.
+ mixed
+ getMetadata()
+
+ No description
+ + mixed
+ getTrailingMetadata()
+
+ No description
+ + string
+ getPeer()
+
+ No description
+ +
+ cancel()
+
+ Cancels the call.
+class + ForwardingServerStreamingCall extends ForwardingCall (View source) +
+ + + + + +Class ForwardingServerStreamingCall wraps a \Grpc\ServerStreamingCall.
| + protected ServerStreamingCall + + | +$innerCall | ++ | + |
No description
+
+ __construct(AbstractCall|ForwardingCall $innerCall)
+
+ ForwardingCall constructor.
+ mixed
+ getMetadata()
+
+ No description
+ + mixed
+ getTrailingMetadata()
+
+ No description
+ + string
+ getPeer()
+
+ No description
+ +
+ cancel()
+
+ Cancels the call.
+ mixed
+ responses()
+
+ No description
+ + stdClass
+ getStatus()
+
+ Wait for the server to send the status, and return it.
+class + ForwardingUnaryCall extends ForwardingCall (View source) +
+ + + + + +Class ForwardingUnaryCall wraps a \Grpc\UnaryCall.
| + protected UnaryCall + + | +$innerCall | ++ | + |
Wait for the server to respond with data and a status.
+ __construct(AbstractCall|ForwardingCall $innerCall)
+
+ ForwardingCall constructor.
+ mixed
+ getMetadata()
+
+ No description
+ + mixed
+ getTrailingMetadata()
+
+ No description
+ + string
+ getPeer()
+
+ No description
+ +
+ cancel()
+
+ Cancels the call.
+ array
+ wait()
+
+ Wait for the server to respond with data and a status.
+class + ServerStreamingCallWrapper implements ServerStreamingCallInterface (View source) +
+ + + + + +Class ServerStreamingCallWrapper implements \Google\ApiCore\ServerStreamingCallInterface.
This is essentially a wrapper class around the \Grpc\ServerStreamingCall.
No description
+Start the call.
No description
+No description
+No description
+No description
+Cancels the call.
Set the CallCredentials for the underlying Call.
+ __construct(ServerStreamingCall|GCPServerStreamCall $stream)
+
+ No description
+ + void
+ start(mixed $data, array $metadata = [], array $callOptions = [])
+
+ Start the call.
+ mixed
+ responses()
+
+ No description
+ + stdClass
+ getStatus()
+
+ Return the status of the server stream.
+ mixed
+ getMetadata()
+
+ No description
+ + mixed
+ getTrailingMetadata()
+
+ No description
+ + string
+ getPeer()
+
+ No description
+ + void
+ cancel()
+
+ Cancels the call.
+ void
+ setCallCredentials(mixed $call_credentials)
+
+ Set the CallCredentials for the underlying Call.
+interface + UnaryInterceptorInterface (View source) +
+ + ++ deprecated +
Temporary class to support an interceptor-like interface until gRPC interceptor support is +available.
No description
+ mixed
+ interceptUnaryUnary(string $method, Message $argument, callable $deserialize, array $metadata, array $options, callable $continuation)
+
+ No description
+ +class + GrpcFallbackTransport implements TransportInterface (View source) +
+ + + + + +A transport that sends protobuf over HTTP 1.1 that can be used when full gRPC support +is not available.
Provides helper methods for service address handling.
A trait for shared functionality between transports that support only unary RPCs using simple +HTTP requests.
No description
+No description
+No description
+Builds a GrpcFallbackTransport.
Returns a promise used to execute network requests.
static array
+ validate(array $arr, array $requiredKeys)
+
+ No description
+ + static array
+ validateNotNull(array $arr, array $requiredKeys)
+
+ No description
+ + never
+ startClientStreamingCall(Call $call, array $options)
+
+ {@inheritdoc}
+ never
+ startServerStreamingCall(Call $call, array $options)
+
+ {@inheritdoc}
+ never
+ startBidiStreamingCall(Call $call, array $options)
+
+ {@inheritdoc}
+
+ close()
+
+ {@inheritdoc}
+
+ __construct(string $baseUri, callable $httpHandler)
+
+ No description
+ + static GrpcFallbackTransport
+ build(string $apiEndpoint, array $config = [])
+
+ Builds a GrpcFallbackTransport.
+ PromiseInterface
+ startUnaryCall(Call $call, array $options)
+
+ Returns a promise used to execute network requests.
+class + GrpcTransport extends BaseStub implements TransportInterface (View source) +
+ + + + + +A gRPC based transport implementation.
Provides helper methods for gRPC support.
Provides helper methods for service address handling.
No description
+No description
+No description
+Builds a GrpcTransport.
Returns a promise used to execute network requests.
static array
+ validate(array $arr, array $requiredKeys)
+
+ No description
+ + static array
+ validateNotNull(array $arr, array $requiredKeys)
+
+ No description
+ +
+ __construct(string $hostname, array $opts, Channel $channel = null, array $interceptors = [])
+
+ No description
+ + static GrpcTransport
+ build(string $apiEndpoint, array $config = [])
+
+ Builds a GrpcTransport.
+ BidiStream
+ startBidiStreamingCall(Call $call, array $options)
+
+ Starts a bidi streaming call.
+ ClientStream
+ startClientStreamingCall(Call $call, array $options)
+
+ Starts a client streaming call.
+ ServerStream
+ startServerStreamingCall(Call $call, array $options)
+
+ Starts a server streaming call.
+ PromiseInterface
+ startUnaryCall(Call $call, array $options)
+
+ Returns a promise used to execute network requests.
+trait + HttpUnaryTransportTrait (View source) +
+ + + +| internal | ++ |
A trait for shared functionality between transports that support only unary RPCs using simple +HTTP requests.
{@inheritdoc}
never
+ startClientStreamingCall(Call $call, array $options)
+
+ {@inheritdoc}
+ never
+ startServerStreamingCall(Call $call, array $options)
+
+ {@inheritdoc}
+ never
+ startBidiStreamingCall(Call $call, array $options)
+
+ {@inheritdoc}
+
+ close()
+
+ {@inheritdoc}
+Class RestServerStreamingCall implements \Google\ApiCore\ServerStreamingCallInterface.
class + JsonStreamDecoder (View source) +
+ + + + + + + +| + ESCAPE_CHAR + | +
+ + + |
+
JsonStreamDecoder is a HTTP-JSON response stream decoder for JSON-ecoded +protobuf messages. The response stream must be a JSON array, where the first +byte is the opening of the array (i.e. '['), and the last byte is the closing +of the array (i.e. ']'). Each array item must be a JSON object and comma +separated.
Begins decoding the configured response stream. It is a generator which +yields messages of the given decode type from the stream until the stream +completes. Throws an Exception if the stream is closed before the closing +byte is read or if it encounters an error while decoding a message.
Closes the underlying stream. If the stream is actively being decoded, an +exception will not be thrown due to the interruption.
+ __construct(StreamInterface $stream, string $decodeType, array $options = [])
+
+ JsonStreamDecoder is a HTTP-JSON response stream decoder for JSON-ecoded +protobuf messages. The response stream must be a JSON array, where the first +byte is the opening of the array (i.e. '['), and the last byte is the closing +of the array (i.e. ']'). Each array item must be a JSON object and comma +separated.
+ Generator
+ decode()
+
+ Begins decoding the configured response stream. It is a generator which +yields messages of the given decode type from the stream until the stream +completes. Throws an Exception if the stream is closed before the closing +byte is read or if it encounters an error while decoding a message.
+ void
+ close()
+
+ Closes the underlying stream. If the stream is actively being decoded, an +exception will not be thrown due to the interruption.
+class + RestServerStreamingCall implements ServerStreamingCallInterface (View source) +
+ + + + + +Class RestServerStreamingCall implements \Google\ApiCore\ServerStreamingCallInterface.
No description
+Start the call.
No description
+Return the status of the server stream. If the call has not been started +this will be null.
No description
+The Rest transport does not support trailing metadata. This is a +passthrough to getMetadata().
No description
+Cancels the call.
For the REST transport this is a no-op.
+ __construct(callable $httpHandler, string $decodeType, array $decoderOptions)
+
+ No description
+ + void
+ start($request, array $headers = [], array $callOptions = [])
+
+ Start the call.
+ mixed
+ responses()
+
+ No description
+ + stdClass
+ getStatus()
+
+ Return the status of the server stream. If the call has not been started +this will be null.
+ mixed
+ getMetadata()
+
+ No description
+ + mixed
+ getTrailingMetadata()
+
+ The Rest transport does not support trailing metadata. This is a +passthrough to getMetadata().
+ string
+ getPeer()
+
+ No description
+ + void
+ cancel()
+
+ Cancels the call.
+ void
+ setCallCredentials(mixed $call_credentials)
+
+ For the REST transport this is a no-op.
{@inheritdoc}
+class + RestTransport implements TransportInterface (View source) +
+ + + + + +A REST based transport implementation.
Provides helper methods for service address handling.
A trait for shared functionality between transports that support only unary RPCs using simple +HTTP requests.
No description
+No description
+Builds a RestTransport.
Returns a promise used to execute network requests.
static array
+ validate(array $arr, array $requiredKeys)
+
+ No description
+ + static array
+ validateNotNull(array $arr, array $requiredKeys)
+
+ No description
+ + never
+ startClientStreamingCall(Call $call, array $options)
+
+ {@inheritdoc}
+ ServerStream
+ startServerStreamingCall(Call $call, array $options)
+
+ Starts a server streaming call.
+ never
+ startBidiStreamingCall(Call $call, array $options)
+
+ {@inheritdoc}
+
+ close()
+
+ {@inheritdoc}
+
+ __construct(RequestBuilder $requestBuilder, callable $httpHandler)
+
+ No description
+ + static RestTransport
+ build(string $apiEndpoint, string $restConfigPath, array $config = [])
+
+ Builds a RestTransport.
+ PromiseInterface
+ startUnaryCall(Call $call, array $options)
+
+ Returns a promise used to execute network requests.
+interface + TransportInterface (View source) +
+ + + + + + + + + +Returns a promise used to execute network requests.
Closes the connection, if one exists.
BidiStream
+ startBidiStreamingCall(Call $call, array $options)
+
+ Starts a bidi streaming call.
+ ClientStream
+ startClientStreamingCall(Call $call, array $options)
+
+ Starts a client streaming call.
+ ServerStream
+ startServerStreamingCall(Call $call, array $options)
+
+ Starts a server streaming call.
+ PromiseInterface
+ startUnaryCall(Call $call, array $options)
+
+ Returns a promise used to execute network requests.
+ void
+ close()
+
+ Closes the connection, if one exists.
+trait + UriTrait (View source) +
+ + + +| internal | ++ |
Provides a light wrapper around often used URI related functions.
No description
+ UriInterface
+ buildUriWithQuery(string|UriInterface $uri, array $query)
+
+ No description
+ +class + ValidationException extends Exception (View source) +
+ + + + + +ValidationException represents a local error (i.e. not during an RPC call).
trait + ValidationTrait (View source) +
+ + + +| internal | ++ |
No description
+No description
+ static array
+ validate(array $arr, array $requiredKeys)
+
+ No description
+ + static array
+ validateNotNull(array $arr, array $requiredKeys)
+
+ No description
+ +class + Version (View source) +
+ + + +| internal | ++ |
No description
+Reads a VERSION file and returns the contents. If the file does not +exist, returns "".
static string
+ getApiCoreVersion()
+
+ No description
+ + static string
+ readVersionFile(string $file)
+
+ Reads a VERSION file and returns the contents. If the file does not +exist, returns "".
+Class containing functions used to build the Agent header.
Represents an exception thrown during an RPC.
Provides basic array helper methods.
BidiStream is the response object from a gRPC bidirectional streaming API call.
Contains information necessary to manage a network request.
Common functions used to work with various clients.
ClientStream is the response object from a gRPC client streaming API call.
The CredentialsWrapper object provides a wrapper around a FetchAuthTokenInterface.
A collection of elements retrieved using one or more API calls. The +collection will attempt to retrieve a fixed number of elements, and +will make API calls until that fixed number is reached, or there +are no more elements to retrieve.
Container class for Protobuf label constants. See FieldDescriptorProto.Label in +https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
Container class for Protobuf type constants. See FieldDescriptorProto.Type in +https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
Common functions used to work with various clients.
Provides helper methods for gRPC support.
For connect to emulator.
Middleware which adds a CredentialsWrapper object to the call options.
Middleware to add fixed headers to an API call.
Middlewares must take a MiddlewareInterface as their first constructor
+argument {Google\ApiCore\Middleware\ResponseMetadataMiddleware}, which
+represents the next middleware in the chain. This next middleware MUST be
+invoked by this MiddlewareInterface, and the result must be returned as part
+of the __invoke method implementation.
Middleware which wraps the response in an OperationResponse object.
Middleware which filters the $options array.
Middleware which wraps the response in an PagedListResponses object.
Middleware that adds autopopulation functionality. This middlware is +added iff auto population settings are present in the resource +descriptor config for the rpc method in context.
Middleware which transforms $response into [$response, $metadata]
Middleware that adds retry functionality.
Response object from a long running API method.
The CallOptions class provides typing to the associative array of options +passed to transport RPC methods. See {TransportInterface::startUnaryCall()}, +{@see TransportInterface::startBidiStreamingCall()}, +{TransportInterface::startClientStreamingCall()}, and +{TransportInterface::startServerStreamingCall()}.
The ClientOptions class adds typing to the associative array of options +passed into each API client constructor. To use this class directly, pass +the result of {ClientOptions::toArray} to the client constructor:
Trait implemented by any class representing an associative array of PHP options.
The GrpcFallbackTransportOptions class provides typing to the associative array of options used +to configure {\Google\ApiCore\Transport\GrpcFallbackTransport}.
The GrpcTransportOptions class provides typing to the associative array of options used to +configure {\Google\ApiCore\Transport\GrpcTransport}.
The RestTransportOptions class provides typing to the associative array of options used to +configure {\Google\ApiCore\Transport\RestTransport}.
A Page object wraps an API list method response and provides methods +to retrieve additional pages using the page token.
Holds the description information used for page streaming.
Response object for paged results from a list API method
Represents a path template.
Builds a PSR-7 request from a set of request information.
Encapsulates request params header metadata.
Provides functionality for loading a resource name template map from a descriptor config, +retrieving a PathTemplate, and parsing values using registered templates.
Represents an absolute resource template, meaning that it will always contain a leading slash,
+and may contain a trailing verb (":
Collection of methods for parsing Segments.
Represents a relative resource template, meaning that it will never contain a leading slash or
+trailing verb (":
Represents a resource template that may or may not contain a leading slash, and if a leading
+slash is present may contain a trailing verb (":
Represents a segment in a resource template. This is used internally by RelativeResourceTemplate, +but is not intended for public use and may change without notice.
The RetrySettings class is used to configure retrying and timeouts for RPCs.
Collection of methods to help with serialization of protobuf objects
ServerStream is the response object from a server streaming API call.
Provides helper methods for service address handling.
The MockBidiStreamingCall class is used to mock out the \Grpc\BidiStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BidiStreamingCall.php)
The MockClientStreamingCall class is used to mock out the \Grpc\ClientStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ClientStreamingCall.php)
Generated from protobuf message google.apicore.testing.MockRequest
Generated from protobuf message google.apicore.testing.MockRequestBody
Generated from protobuf message google.apicore.testing.MockResponse
The MockServerStreamingCall class is used to mock out the \Grpc\ServerStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ServerStreamingCall.php)
The MockStubTrait is used by generated mock stub classes which extent \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +It provides functionality to add responses, get received calls, and overrides the _simpleRequest +method so that the elements of $responses are returned instead of making a call to the API.
The MockUnaryCall class is used to mock out the \Grpc\UnaryCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/UnaryCall.php)
Class ReceivedRequest used to hold the function name and request object of a call +make to a mock gRPC stub.
A transport that sends protobuf over HTTP 1.1 that can be used when full gRPC support +is not available.
A gRPC based transport implementation.
Class ForwardingCall wraps a \Grpc\AbstractCall.
Class ForwardingServerStreamingCall wraps a \Grpc\ServerStreamingCall.
Class ForwardingUnaryCall wraps a \Grpc\UnaryCall.
Class ServerStreamingCallWrapper implements \Google\ApiCore\ServerStreamingCallInterface.
Temporary class to support an interceptor-like interface until gRPC interceptor support is +available.
A trait for shared functionality between transports that support only unary RPCs using simple +HTTP requests.
A REST based transport implementation.
Class RestServerStreamingCall implements \Google\ApiCore\ServerStreamingCallInterface.
Provides a light wrapper around often used URI related functions.
ValidationException represents a local error (i.e. not during an RPC call).
Class containing functions used to build the Agent header.
Represents an exception thrown during an RPC.
Provides basic array helper methods.
Add a middleware to the call stack by providing a callable which will be +invoked at the start of each call, and will return an instance of +{MiddlewareInterface} when invoked.
Represents an absolute resource template, meaning that it will always contain a leading slash,
+and may contain a trailing verb (":
Add a response object, and an optional status, to the list of responses to be returned via +_simpleRequest.
Returns whether the comparator can compare two values.
Asserts that two values are equal.
Returns whether the comparator can compare two values.
Asserts that two values are equal.
BidiStream is the response object from a gRPC bidirectional streaming API call.
Factory method to create a CredentialsWrapper from an array of options.
Generated from protobuf field .google.protobuf.BytesValue bytes_value = 5;
Builds a GrpcFallbackTransport.
Builds a GrpcTransport.
Builds a RestTransport.
For REST-based responses, the metadata does not need to be decoded.
Creates an ApiException from a GuzzleHttp RequestException.
Inform the server that no more requests will be written. The write() function cannot be +called after closeWrite() is called.
Call closeWrite(), and read all responses from the server, until the streaming call is +completed. Throws an ApiException if the streaming call failed.
Contains information necessary to manage a network request.
Common functions used to work with various clients.
ClientStream is the response object from a gRPC client streaming API call.
The CredentialsWrapper object provides a wrapper around a FetchAuthTokenInterface.
Verify that the expected universe domain matches the universe domain from the credentials.
Initiates an orderly shutdown in which preexisting calls continue but new +calls are immediately cancelled.
Verify that the expected universe domain matches the universe domain from the credentials.
Middleware which adds a CredentialsWrapper object to the call options.
Cancel the long-running operation.
The CallOptions class provides typing to the associative array of options +passed to transport RPC methods. See {TransportInterface::startUnaryCall()}, +{@see TransportInterface::startBidiStreamingCall()}, +{TransportInterface::startClientStreamingCall()}, and +{TransportInterface::startServerStreamingCall()}.
The ClientOptions class adds typing to the associative array of options +passed into each API client constructor. To use this class directly, pass +the result of {ClientOptions::toArray} to the client constructor:
Cancels the call.
Creates a sequence such that the responses are returned in order.
Closes the connection, if one exists.
Cancels the call.
Cancels the call.
Closes the underlying stream. If the stream is actively being decoded, an +exception will not be thrown due to the interruption.
Cancels the call.
Closes the connection, if one exists.
Delete the long-running operation.
Decode PHP array into the specified protobuf message
Decode metadata received from gRPC status object
Decode an array of Any messages into a printable PHP array.
Generated from protobuf field .google.protobuf.Duration duration_value = 6;
Begins decoding the configured response stream. It is a generator which +yields messages of the given decode type from the stream until the stream +completes. Throws an Exception if the stream is closed before the closing +byte is read or if it encounters an error while decoding a message.
Returns a collection of elements with a fixed size set by +the collectionSize parameter. The collection will only contain +fewer than collectionSize elements if there are no more +pages to be retrieved from the server.
Returns a collection of elements with a fixed size set by +the collectionSize parameter. The collection will only contain +fewer than collectionSize elements if there are no more +pages to be retrieved from the server.
Encode protobuf message as a PHP array
A collection of elements retrieved using one or more API calls. The +collection will attempt to retrieve a fixed number of elements, and +will make API calls until that fixed number is reached, or there +are no more elements to retrieve.
Middleware to add fixed headers to an API call.
Generated from protobuf field .google.protobuf.FieldMask field_mask = 7;
Class ForwardingCall wraps a \Grpc\AbstractCall.
Class ForwardingServerStreamingCall wraps a \Grpc\ServerStreamingCall.
Class ForwardingUnaryCall wraps a \Grpc\UnaryCall.
Returns the reason in ErrorInfo for an exception, or null if there is no ErrorInfo.
Returns the domain in ErrorInfo for an exception, or null if there is no ErrorInfo.
Returns the metadata in ErrorInfo for an exception, or null if there is no ErrorInfo.
Return the underlying gRPC call object
Return the underlying gRPC call object
Returns the number of elements in the collection. This will be +equal to the collectionSize parameter used at construction +unless there are no elements remaining to be retrieved.
Returns a page token that can be passed into the API list +method to retrieve additional elements.
Retrieves the next FixedSizeCollection using one or more API calls.
Returns an iterator over the elements of the collection.
Container class for Protobuf label constants. See FieldDescriptorProto.Label in +https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
Container class for Protobuf type constants. See FieldDescriptorProto.Type in +https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
Common functions used to work with various clients.
Provides helper methods for gRPC support.
Get the formatted name of the operation
Return the result of the operation. If operationSucceeded() is false, return null.
If the operation failed, return the status. If operationFailed() is false, return null.
Get an array containing the values of 'operationReturnType', 'metadataReturnType', and
+the polling options initialPollDelayMillis, pollDelayMultiplier, maxPollDelayMillis,
+and totalPollTimeoutMillis. The array can be passed as the $options argument to the
+constructor when creating another OperationResponse object.
Get the metadata returned with the last proto response. If a metadata type was provided, then +the return value will be of that type - otherwise, the return value will be of type Any. If +no metadata object is available, returns null.
The GrpcFallbackTransportOptions class provides typing to the associative array of options used +to configure {\Google\ApiCore\Transport\GrpcFallbackTransport}.
The GrpcTransportOptions class provides typing to the associative array of options used to +configure {\Google\ApiCore\Transport\GrpcTransport}.
Returns the next page token from the response.
Retrieves the next Page object using the next page token.
Return the number of elements in the response.
Return an iterator over the elements in the response.
Gets the request object used to generate the Page.
Gets the API response object.
Returns an iterator over the full list of elements. If the +API response contains a (non-empty) next page token, then +the PagedListResponse object will make calls to the underlying +API to retrieve additional elements as required.
Return the current page of results.
Protected to allow overriding for tests
Returns an associative array that contains request params header metadata.
Return the underlying call object.
Return the status of the server stream.
Generated from protobuf field string page_token = 1;
Generated from protobuf field uint64 page_size = 2;
Generated from protobuf field string name = 1;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field repeated string repeated_field = 3;
Generated from protobuf field .google.apicore.testing.MockRequestBody nested_message = 4;
Generated from protobuf field .google.protobuf.BytesValue bytes_value = 5;
Returns the unboxed value from getBytesValue()
Generated from protobuf field .google.protobuf.Duration duration_value = 6;
Generated from protobuf field .google.protobuf.FieldMask field_mask = 7;
Generated from protobuf field .google.protobuf.Int64Value int64_value = 8;
Returns the unboxed value from getInt64Value()
Generated from protobuf field .google.protobuf.ListValue list_value = 9;
Generated from protobuf field .google.protobuf.StringValue string_value = 10;
Returns the unboxed value from getStringValue()
Generated from protobuf field .google.protobuf.Struct struct_value = 11;
Generated from protobuf field .google.protobuf.Timestamp timestamp_value = 12;
Generated from protobuf field .google.protobuf.Value value_value = 13;
Generated from protobuf field string field_1 = 14;
Generated from protobuf field string field_2 = 15;
Generated from protobuf field string field_3 = 16;
Generated from protobuf field string name = 1;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field repeated string resources_list = 3;
Generated from protobuf field string next_page_token = 4;
Generated from protobuf field map<string, string> resources_map = 5;
A transport that sends protobuf over HTTP 1.1 that can be used when full gRPC support +is not available.
A gRPC based transport implementation.
Wait for the server to send the status, and return it.
Return the status of the server stream.
Return the status of the server stream. If the call has not been started +this will be null.
The Rest transport does not support trailing metadata. This is a +passthrough to getMetadata().
Returns true if there are more elements that can be retrieved +from the API.
Returns true if there are more pages that can be retrieved from the +API.
A trait for shared functionality between transports that support only unary RPCs using simple +HTTP requests.
Returns an iterator over FixedSizeCollections, starting with this +and making API calls as required until all of the elements have +been retrieved.
For connect to emulator.
Check whether the operation has completed.
Return an iterator over Page objects, beginning with this object.
Returns an iterator over the full list of elements. If the +API response contains a (non-empty) next page token, then +the PagedListResponse object will make calls to the underlying +API to retrieve additional elements as required.
Returns an iterator over pages of results. The pages are +retrieved lazily from the underlying API.
Returns an iterator over fixed size collections of results.
Generated from protobuf field .google.protobuf.Int64Value int64_value = 8;
Constructs an array mapping method names to CallSettings.
Creates an associative array of the {\Google\ApiCore\RetrySettings} timeout fields configured +with the given timeout specified in the $timeout parameter interpreted as a logical timeout.
Generated from protobuf field .google.protobuf.ListValue list_value = 9;
Middlewares must take a MiddlewareInterface as their first constructor
+argument {Google\ApiCore\Middleware\ResponseMetadataMiddleware}, which
+represents the next middleware in the chain. This next middleware MUST be
+invoked by this MiddlewareInterface, and the result must be returned as part
+of the __invoke method implementation.
Check if $path matches a resource string.
Matches a fully qualified path template string.
Check if $path matches a resource string.
Matches a given $path to a resource template, and returns an array of bindings between +wildcards / variables in the template and values in the path. If $path does not match the +template, then a ValidationException is thrown.
Checks if $value matches this Segment.
The MockBidiStreamingCall class is used to mock out the \Grpc\BidiStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BidiStreamingCall.php)
The MockClientStreamingCall class is used to mock out the \Grpc\ClientStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ClientStreamingCall.php)
Generated from protobuf message google.apicore.testing.MockRequest
Generated from protobuf message google.apicore.testing.MockRequestBody
Generated from protobuf message google.apicore.testing.MockResponse
The MockServerStreamingCall class is used to mock out the \Grpc\ServerStreamingCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ServerStreamingCall.php)
The MockStubTrait is used by generated mock stub classes which extent \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +It provides functionality to add responses, get received calls, and overrides the _simpleRequest +method so that the elements of $responses are returned instead of making a call to the API.
The MockUnaryCall class is used to mock out the \Grpc\UnaryCall class +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/UnaryCall.php)
Generated from protobuf field string name = 1;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field .google.apicore.testing.MockRequestBody nested_message = 4;
Generated from protobuf field string name = 1;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field string next_page_token = 4;
Middleware which wraps the response in an OperationResponse object.
Middleware which filters the $options array.
Response object from a long running API method.
Check whether the operation completed successfully. If the operation is not complete, or if the operation +failed, return false.
Check whether the operation failed. If the operation is not complete, or if the operation +succeeded, return false.
Trait implemented by any class representing an associative array of PHP options.
Middleware which wraps the response in an PagedListResponses object.
Poll the server in a loop until the operation is complete.
A Page object wraps an API list method response and provides methods +to retrieve additional pages using the page token.
Holds the description information used for page streaming.
Response object for paged results from a list API method
Represents a path template.
Collection of methods for parsing Segments.
Parses a path into an array of segments.
Return a list of calls made to write(), and clear $receivedFuncCalls.
Return a list of calls made to write(), and clear $receivedFuncCalls.
Generated from protobuf field string page_token = 1;
Generated from protobuf field uint64 page_size = 2;
Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.
Reads the gapic version string from a VERSION file. In order to determine the file +location, this method follows this procedure:
+Maps HTTP status codes to Google\Rpc\Code codes.
Read the next response from the server. Returns null if the streaming call completed +successfully. Throws an ApiException if the streaming call failed.
Read the response from the server, completing the streaming call.
Middleware that adds autopopulation functionality. This middlware is +added iff auto population settings are present in the resource +descriptor config for the rpc method in context.
Middleware which transforms $response into [$response, $metadata]
Middleware that adds retry functionality.
Reload the status of the operation with a request to the service.
The RestTransportOptions class provides typing to the associative array of options used to +configure {\Google\ApiCore\Transport\RestTransport}.
Renders a path template using the provided bindings.
Builds a PSR-7 request from a set of request information.
Encapsulates request params header metadata.
Provides functionality for loading a resource name template map from a descriptor config, +retrieving a PathTemplate, and parsing values using registered templates.
Represents a relative resource template, meaning that it will never contain a leading slash or
+trailing verb (":
Represents a resource template that may or may not contain a leading slash, and if a leading
+slash is present may contain a trailing verb (":
Renders a resource template using the provided bindings.
The RetrySettings class is used to configure retrying and timeouts for RPCs.
A generator which yields results from the server until the streaming call +completes. Throws an ApiException if the streaming call failed.
Class ReceivedRequest used to hold the function name and request object of a call +make to a mock gRPC stub.
A REST based transport implementation.
Class RestServerStreamingCall implements \Google\ApiCore\ServerStreamingCallInterface.
Reads a VERSION file and returns the contents. If the file does not +exist, returns "".
Protected to allow overriding for tests
Represents a segment in a resource template. This is used internally by RelativeResourceTemplate, +but is not intended for public use and may change without notice.
Collection of methods to help with serialization of protobuf objects
ServerStream is the response object from a server streaming API call.
Start the call.
Set the CallCredentials for the underlying Call.
Provides helper methods for service address handling.
Exports a value into a single-line string
Generated from protobuf field string page_token = 1;
Generated from protobuf field uint64 page_size = 2;
Generated from protobuf field .google.protobuf.StringValue string_value = 10;
Generated from protobuf field .google.protobuf.Struct struct_value = 11;
Generated from protobuf field string name = 1;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field repeated string repeated_field = 3;
Generated from protobuf field .google.apicore.testing.MockRequestBody nested_message = 4;
Generated from protobuf field .google.protobuf.BytesValue bytes_value = 5;
Sets the field by wrapping a primitive type in a Google\Protobuf\BytesValue object.
Generated from protobuf field .google.protobuf.Duration duration_value = 6;
Generated from protobuf field .google.protobuf.FieldMask field_mask = 7;
Generated from protobuf field .google.protobuf.Int64Value int64_value = 8;
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Generated from protobuf field .google.protobuf.ListValue list_value = 9;
Generated from protobuf field .google.protobuf.StringValue string_value = 10;
Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
Generated from protobuf field .google.protobuf.Struct struct_value = 11;
Generated from protobuf field .google.protobuf.Timestamp timestamp_value = 12;
Generated from protobuf field .google.protobuf.Value value_value = 13;
Generated from protobuf field string field_1 = 14;
Generated from protobuf field string field_2 = 15;
Generated from protobuf field string field_3 = 16;
Generated from protobuf field string name = 1;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field repeated string resources_list = 3;
Generated from protobuf field string next_page_token = 4;
Generated from protobuf field map<string, string> resources_map = 5;
Set the status object to be used when creating streaming calls.
Returns a promise used to execute network requests.
Starts a bidi streaming call.
Starts a client streaming call.
Starts a server streaming call.
Returns a promise used to execute network requests.
Starts a bidi streaming call.
Starts a client streaming call.
Starts a server streaming call.
Returns a promise used to execute network requests.
Class ServerStreamingCallWrapper implements \Google\ApiCore\ServerStreamingCallInterface.
Start the call.
Set the CallCredentials for the underlying Call.
Returns a promise used to execute network requests.
Starts a server streaming call.
Start the call.
For the REST transport this is a no-op.
Starts a bidi streaming call.
Starts a client streaming call.
Starts a server streaming call.
Returns a promise used to execute network requests.
Convert string from camelCase to snake_case
Convert string from snake_case to camelCase
Generated from protobuf field .google.protobuf.Timestamp timestamp_value = 12;
Temporary class to support an interceptor-like interface until gRPC interceptor support is +available.
Provides a light wrapper around often used URI related functions.
Generated from protobuf field .google.protobuf.Value value_value = 13;
ValidationException represents a local error (i.e. not during an RPC call).
Write request to the server.
Write all requests in $requests.
Write request to the server.
Write all data in $dataArray and read the response from the server, completing the streaming +call.
Creates a new instance of RetrySettings that updates the settings in the existing instance +with the settings specified in the $settings parameter.
Save the request object, to be retrieved via getReceivedCalls()
Set writesDone to true
Immediately return the preset response object and status.
Save the request object, to be retrieved via getReceivedCalls()
Immediately return the preset response object and status.
Wait for the server to respond with data and a status.
ApiException constructor.
String representation of ApiException
BidiStream constructor.
ClientStream constructor.
CredentialsWrapper constructor.
FixedSizeCollection constructor.
CredentialsWrapper constructor.
Modify or observe the API call request and response.
Modify or observe the API call request and response.
Modify or observe the API call request and response.
Modify or observe the API call request and response.
Modify or observe the API call request and response.
Modify or observe the API call request and response.
Modify or observe the API call request and response.
OperationResponse constructor.
Page constructor.
PagedListResponse constructor.
PathTemplate constructor.
RequestParamsHeaderDescriptor constructor.
AbsoluteResourceTemplate constructor.
RelativeResourceTemplate constructor.
Segment constructor.
Constructs an instance.
Serializer constructor.
ServerStream constructor.
MockBidiStreamingCall constructor.
MockClientStreamingCall constructor.
MockServerStreamingCall constructor.
Overrides the _simpleRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockUnaryCall object that will return the first item from $responses
Overrides the _clientStreamRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockClientStreamingCall object that will return the first item from $responses
Overrides the _serverStreamRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockServerStreamingCall object that will stream items from $responses, and return +a final status of $serverStreamingStatus.
Overrides the _bidiRequest method in \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +Returns a MockBidiStreamingCall object that will stream items from $responses, and return +a final status of $serverStreamingStatus.
MockUnaryCall constructor.
ForwardingCall constructor.
JsonStreamDecoder is a HTTP-JSON response stream decoder for JSON-ecoded +protobuf messages. The response stream must be a JSON array, where the first +byte is the opening of the array (i.e. '['), and the last byte is the closing +of the array (i.e. ']'). Each array item must be a JSON object and comma +separated.
Class containing functions used to build the Agent header.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\ApiException","p":"Google/ApiCore/ApiException.html","d":"Represents an exception thrown during an RPC.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\ApiStatus","p":"Google/ApiCore/ApiStatus.html","d":null,"f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"T","n":"Google\\ApiCore\\ArrayTrait","p":"Google/ApiCore/ArrayTrait.html","d":"Provides basic array helper methods.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\BidiStream","p":"Google/ApiCore/BidiStream.html","d":"BidiStream is the response object from a gRPC bidirectional streaming API call.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\Call","p":"Google/ApiCore/Call.html","d":"Contains information necessary to manage a network request.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"T","n":"Google\\ApiCore\\ClientOptionsTrait","p":"Google/ApiCore/ClientOptionsTrait.html","d":"Common functions used to work with various clients.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\ClientStream","p":"Google/ApiCore/ClientStream.html","d":"ClientStream is the response object from a gRPC client streaming API call.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\CredentialsWrapper","p":"Google/ApiCore/CredentialsWrapper.html","d":"The CredentialsWrapper object provides a wrapper around a FetchAuthTokenInterface.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\FixedSizeCollection","p":"Google/ApiCore/FixedSizeCollection.html","d":"A collection of elements retrieved using one or more API calls. The\ncollection will attempt to retrieve a fixed number of elements, and\nwill make API calls until that fixed number is reached, or there\nare no more elements to retrieve.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\GPBLabel","p":"Google/ApiCore/GPBLabel.html","d":"Container class for Protobuf label constants. See FieldDescriptorProto.Label in\nhttps://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\GPBType","p":"Google/ApiCore/GPBType.html","d":"Container class for Protobuf type constants. See FieldDescriptorProto.Type in\nhttps://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"T","n":"Google\\ApiCore\\GapicClientTrait","p":"Google/ApiCore/GapicClientTrait.html","d":"Common functions used to work with various clients.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"T","n":"Google\\ApiCore\\GrpcSupportTrait","p":"Google/ApiCore/GrpcSupportTrait.html","d":"Provides helper methods for gRPC support.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\InsecureCredentialsWrapper","p":"Google/ApiCore/InsecureCredentialsWrapper.html","d":"For connect to emulator.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\Middleware\\CredentialsWrapperMiddleware","p":"Google/ApiCore/Middleware/CredentialsWrapperMiddleware.html","d":"Middleware which adds a CredentialsWrapper object to the call options.
","f":{"n":"Google\\ApiCore\\Middleware","p":"Google/ApiCore/Middleware.html"}},{"t":"C","n":"Google\\ApiCore\\Middleware\\FixedHeaderMiddleware","p":"Google/ApiCore/Middleware/FixedHeaderMiddleware.html","d":"Middleware to add fixed headers to an API call.
","f":{"n":"Google\\ApiCore\\Middleware","p":"Google/ApiCore/Middleware.html"}},{"t":"C","n":"Google\\ApiCore\\Middleware\\MiddlewareInterface","p":"Google/ApiCore/Middleware/MiddlewareInterface.html","d":"Middlewares must take a MiddlewareInterface as their first constructor\nargument {Google\\ApiCore\\Middleware\\ResponseMetadataMiddleware}, which\nrepresents the next middleware in the chain. This next middleware MUST be\ninvoked by this MiddlewareInterface, and the result must be returned as part\nof the __invoke method implementation.
Middleware which wraps the response in an OperationResponse object.
","f":{"n":"Google\\ApiCore\\Middleware","p":"Google/ApiCore/Middleware.html"}},{"t":"C","n":"Google\\ApiCore\\Middleware\\OptionsFilterMiddleware","p":"Google/ApiCore/Middleware/OptionsFilterMiddleware.html","d":"Middleware which filters the $options array.
","f":{"n":"Google\\ApiCore\\Middleware","p":"Google/ApiCore/Middleware.html"}},{"t":"C","n":"Google\\ApiCore\\Middleware\\PagedMiddleware","p":"Google/ApiCore/Middleware/PagedMiddleware.html","d":"Middleware which wraps the response in an PagedListResponses object.
","f":{"n":"Google\\ApiCore\\Middleware","p":"Google/ApiCore/Middleware.html"}},{"t":"C","n":"Google\\ApiCore\\Middleware\\RequestAutoPopulationMiddleware","p":"Google/ApiCore/Middleware/RequestAutoPopulationMiddleware.html","d":"Middleware that adds autopopulation functionality. This middlware is\nadded iff auto population settings are present in the resource\ndescriptor config for the rpc method in context.
","f":{"n":"Google\\ApiCore\\Middleware","p":"Google/ApiCore/Middleware.html"}},{"t":"C","n":"Google\\ApiCore\\Middleware\\ResponseMetadataMiddleware","p":"Google/ApiCore/Middleware/ResponseMetadataMiddleware.html","d":"Middleware which transforms $response into [$response, $metadata]
","f":{"n":"Google\\ApiCore\\Middleware","p":"Google/ApiCore/Middleware.html"}},{"t":"C","n":"Google\\ApiCore\\Middleware\\RetryMiddleware","p":"Google/ApiCore/Middleware/RetryMiddleware.html","d":"Middleware that adds retry functionality.
","f":{"n":"Google\\ApiCore\\Middleware","p":"Google/ApiCore/Middleware.html"}},{"t":"C","n":"Google\\ApiCore\\OperationResponse","p":"Google/ApiCore/OperationResponse.html","d":"Response object from a long running API method.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\Options\\CallOptions","p":"Google/ApiCore/Options/CallOptions.html","d":"The CallOptions class provides typing to the associative array of options\npassed to transport RPC methods. See {TransportInterface::startUnaryCall()},\n{@see TransportInterface::startBidiStreamingCall()},\n{TransportInterface::startClientStreamingCall()}, and\n{TransportInterface::startServerStreamingCall()}.
","f":{"n":"Google\\ApiCore\\Options","p":"Google/ApiCore/Options.html"}},{"t":"C","n":"Google\\ApiCore\\Options\\ClientOptions","p":"Google/ApiCore/Options/ClientOptions.html","d":"The ClientOptions class adds typing to the associative array of options\npassed into each API client constructor. To use this class directly, pass\nthe result of {ClientOptions::toArray} to the client constructor:
","f":{"n":"Google\\ApiCore\\Options","p":"Google/ApiCore/Options.html"}},{"t":"T","n":"Google\\ApiCore\\Options\\OptionsTrait","p":"Google/ApiCore/Options/OptionsTrait.html","d":"Trait implemented by any class representing an associative array of PHP options.
","f":{"n":"Google\\ApiCore\\Options","p":"Google/ApiCore/Options.html"}},{"t":"C","n":"Google\\ApiCore\\Options\\TransportOptions","p":"Google/ApiCore/Options/TransportOptions.html","d":null,"f":{"n":"Google\\ApiCore\\Options","p":"Google/ApiCore/Options.html"}},{"t":"C","n":"Google\\ApiCore\\Options\\TransportOptions\\GrpcFallbackTransportOptions","p":"Google/ApiCore/Options/TransportOptions/GrpcFallbackTransportOptions.html","d":"The GrpcFallbackTransportOptions class provides typing to the associative array of options used\nto configure {\\Google\\ApiCore\\Transport\\GrpcFallbackTransport}.
","f":{"n":"Google\\ApiCore\\Options\\TransportOptions","p":"Google/ApiCore/Options/TransportOptions.html"}},{"t":"C","n":"Google\\ApiCore\\Options\\TransportOptions\\GrpcTransportOptions","p":"Google/ApiCore/Options/TransportOptions/GrpcTransportOptions.html","d":"The GrpcTransportOptions class provides typing to the associative array of options used to\nconfigure {\\Google\\ApiCore\\Transport\\GrpcTransport}.
","f":{"n":"Google\\ApiCore\\Options\\TransportOptions","p":"Google/ApiCore/Options/TransportOptions.html"}},{"t":"C","n":"Google\\ApiCore\\Options\\TransportOptions\\RestTransportOptions","p":"Google/ApiCore/Options/TransportOptions/RestTransportOptions.html","d":"The RestTransportOptions class provides typing to the associative array of options used to\nconfigure {\\Google\\ApiCore\\Transport\\RestTransport}.
","f":{"n":"Google\\ApiCore\\Options\\TransportOptions","p":"Google/ApiCore/Options/TransportOptions.html"}},{"t":"C","n":"Google\\ApiCore\\Page","p":"Google/ApiCore/Page.html","d":"A Page object wraps an API list method response and provides methods\nto retrieve additional pages using the page token.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\PageStreamingDescriptor","p":"Google/ApiCore/PageStreamingDescriptor.html","d":"Holds the description information used for page streaming.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\PagedListResponse","p":"Google/ApiCore/PagedListResponse.html","d":"Response object for paged results from a list API method
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\PathTemplate","p":"Google/ApiCore/PathTemplate.html","d":"Represents a path template.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"T","n":"Google\\ApiCore\\PollingTrait","p":"Google/ApiCore/PollingTrait.html","d":"","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\RequestBuilder","p":"Google/ApiCore/RequestBuilder.html","d":"Builds a PSR-7 request from a set of request information.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\RequestParamsHeaderDescriptor","p":"Google/ApiCore/RequestParamsHeaderDescriptor.html","d":"Encapsulates request params header metadata.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"T","n":"Google\\ApiCore\\ResourceHelperTrait","p":"Google/ApiCore/ResourceHelperTrait.html","d":"Provides functionality for loading a resource name template map from a descriptor config,\nretrieving a PathTemplate, and parsing values using registered templates.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\ResourceTemplate\\AbsoluteResourceTemplate","p":"Google/ApiCore/ResourceTemplate/AbsoluteResourceTemplate.html","d":"Represents an absolute resource template, meaning that it will always contain a leading slash,\nand may contain a trailing verb (":
Collection of methods for parsing Segments.
","f":{"n":"Google\\ApiCore\\ResourceTemplate","p":"Google/ApiCore/ResourceTemplate.html"}},{"t":"C","n":"Google\\ApiCore\\ResourceTemplate\\RelativeResourceTemplate","p":"Google/ApiCore/ResourceTemplate/RelativeResourceTemplate.html","d":"Represents a relative resource template, meaning that it will never contain a leading slash or\ntrailing verb (":
Represents a resource template that may or may not contain a leading slash, and if a leading\nslash is present may contain a trailing verb (":
Represents a segment in a resource template. This is used internally by RelativeResourceTemplate,\nbut is not intended for public use and may change without notice.
","f":{"n":"Google\\ApiCore\\ResourceTemplate","p":"Google/ApiCore/ResourceTemplate.html"}},{"t":"C","n":"Google\\ApiCore\\RetrySettings","p":"Google/ApiCore/RetrySettings.html","d":"The RetrySettings class is used to configure retrying and timeouts for RPCs.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\Serializer","p":"Google/ApiCore/Serializer.html","d":"Collection of methods to help with serialization of protobuf objects
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\ServerStream","p":"Google/ApiCore/ServerStream.html","d":"ServerStream is the response object from a server streaming API call.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\ServerStreamingCallInterface","p":"Google/ApiCore/ServerStreamingCallInterface.html","d":"","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"T","n":"Google\\ApiCore\\ServiceAddressTrait","p":"Google/ApiCore/ServiceAddressTrait.html","d":"Provides helper methods for service address handling.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\GeneratedTest","p":"Google/ApiCore/Testing/GeneratedTest.html","d":"","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\MessageAwareArrayComparator","p":"Google/ApiCore/Testing/MessageAwareArrayComparator.html","d":"","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\MessageAwareExporter","p":"Google/ApiCore/Testing/MessageAwareExporter.html","d":"","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\MockBidiStreamingCall","p":"Google/ApiCore/Testing/MockBidiStreamingCall.html","d":"The MockBidiStreamingCall class is used to mock out the \\Grpc\\BidiStreamingCall class\n(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BidiStreamingCall.php)
","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\MockClientStreamingCall","p":"Google/ApiCore/Testing/MockClientStreamingCall.html","d":"The MockClientStreamingCall class is used to mock out the \\Grpc\\ClientStreamingCall class\n(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ClientStreamingCall.php)
","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\MockGrpcTransport","p":"Google/ApiCore/Testing/MockGrpcTransport.html","d":"","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\MockRequest","p":"Google/ApiCore/Testing/MockRequest.html","d":"Generated from protobuf message google.apicore.testing.MockRequest
Generated from protobuf message google.apicore.testing.MockRequestBody
Generated from protobuf message google.apicore.testing.MockResponse
The MockServerStreamingCall class is used to mock out the \\Grpc\\ServerStreamingCall class\n(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ServerStreamingCall.php)
","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\MockStatus","p":"Google/ApiCore/Testing/MockStatus.html","d":"","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"T","n":"Google\\ApiCore\\Testing\\MockStubTrait","p":"Google/ApiCore/Testing/MockStubTrait.html","d":"The MockStubTrait is used by generated mock stub classes which extent \\Grpc\\BaseStub\n(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php)\nIt provides functionality to add responses, get received calls, and overrides the _simpleRequest\nmethod so that the elements of $responses are returned instead of making a call to the API.
","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\MockTransport","p":"Google/ApiCore/Testing/MockTransport.html","d":"","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\MockUnaryCall","p":"Google/ApiCore/Testing/MockUnaryCall.html","d":"The MockUnaryCall class is used to mock out the \\Grpc\\UnaryCall class\n(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/UnaryCall.php)
","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\ProtobufGPBEmptyComparator","p":"Google/ApiCore/Testing/ProtobufGPBEmptyComparator.html","d":"","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\ProtobufMessageComparator","p":"Google/ApiCore/Testing/ProtobufMessageComparator.html","d":"","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Testing\\ReceivedRequest","p":"Google/ApiCore/Testing/ReceivedRequest.html","d":"Class ReceivedRequest used to hold the function name and request object of a call\nmake to a mock gRPC stub.
","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"T","n":"Google\\ApiCore\\Testing\\SerializationTrait","p":"Google/ApiCore/Testing/SerializationTrait.html","d":"","f":{"n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"}},{"t":"C","n":"Google\\ApiCore\\Transport\\GrpcFallbackTransport","p":"Google/ApiCore/Transport/GrpcFallbackTransport.html","d":"A transport that sends protobuf over HTTP 1.1 that can be used when full gRPC support\nis not available.
","f":{"n":"Google\\ApiCore\\Transport","p":"Google/ApiCore/Transport.html"}},{"t":"C","n":"Google\\ApiCore\\Transport\\GrpcTransport","p":"Google/ApiCore/Transport/GrpcTransport.html","d":"A gRPC based transport implementation.
","f":{"n":"Google\\ApiCore\\Transport","p":"Google/ApiCore/Transport.html"}},{"t":"C","n":"Google\\ApiCore\\Transport\\Grpc\\ForwardingCall","p":"Google/ApiCore/Transport/Grpc/ForwardingCall.html","d":"Class ForwardingCall wraps a \\Grpc\\AbstractCall.
","f":{"n":"Google\\ApiCore\\Transport\\Grpc","p":"Google/ApiCore/Transport/Grpc.html"}},{"t":"C","n":"Google\\ApiCore\\Transport\\Grpc\\ForwardingServerStreamingCall","p":"Google/ApiCore/Transport/Grpc/ForwardingServerStreamingCall.html","d":"Class ForwardingServerStreamingCall wraps a \\Grpc\\ServerStreamingCall.
","f":{"n":"Google\\ApiCore\\Transport\\Grpc","p":"Google/ApiCore/Transport/Grpc.html"}},{"t":"C","n":"Google\\ApiCore\\Transport\\Grpc\\ForwardingUnaryCall","p":"Google/ApiCore/Transport/Grpc/ForwardingUnaryCall.html","d":"Class ForwardingUnaryCall wraps a \\Grpc\\UnaryCall.
","f":{"n":"Google\\ApiCore\\Transport\\Grpc","p":"Google/ApiCore/Transport/Grpc.html"}},{"t":"C","n":"Google\\ApiCore\\Transport\\Grpc\\ServerStreamingCallWrapper","p":"Google/ApiCore/Transport/Grpc/ServerStreamingCallWrapper.html","d":"Class ServerStreamingCallWrapper implements \\Google\\ApiCore\\ServerStreamingCallInterface.
","f":{"n":"Google\\ApiCore\\Transport\\Grpc","p":"Google/ApiCore/Transport/Grpc.html"}},{"t":"C","n":"Google\\ApiCore\\Transport\\Grpc\\UnaryInterceptorInterface","p":"Google/ApiCore/Transport/Grpc/UnaryInterceptorInterface.html","d":"Temporary class to support an interceptor-like interface until gRPC interceptor support is\navailable.
","f":{"n":"Google\\ApiCore\\Transport\\Grpc","p":"Google/ApiCore/Transport/Grpc.html"}},{"t":"T","n":"Google\\ApiCore\\Transport\\HttpUnaryTransportTrait","p":"Google/ApiCore/Transport/HttpUnaryTransportTrait.html","d":"A trait for shared functionality between transports that support only unary RPCs using simple\nHTTP requests.
","f":{"n":"Google\\ApiCore\\Transport","p":"Google/ApiCore/Transport.html"}},{"t":"C","n":"Google\\ApiCore\\Transport\\RestTransport","p":"Google/ApiCore/Transport/RestTransport.html","d":"A REST based transport implementation.
","f":{"n":"Google\\ApiCore\\Transport","p":"Google/ApiCore/Transport.html"}},{"t":"C","n":"Google\\ApiCore\\Transport\\Rest\\JsonStreamDecoder","p":"Google/ApiCore/Transport/Rest/JsonStreamDecoder.html","d":null,"f":{"n":"Google\\ApiCore\\Transport\\Rest","p":"Google/ApiCore/Transport/Rest.html"}},{"t":"C","n":"Google\\ApiCore\\Transport\\Rest\\RestServerStreamingCall","p":"Google/ApiCore/Transport/Rest/RestServerStreamingCall.html","d":"Class RestServerStreamingCall implements \\Google\\ApiCore\\ServerStreamingCallInterface.
","f":{"n":"Google\\ApiCore\\Transport\\Rest","p":"Google/ApiCore/Transport/Rest.html"}},{"t":"C","n":"Google\\ApiCore\\Transport\\TransportInterface","p":"Google/ApiCore/Transport/TransportInterface.html","d":null,"f":{"n":"Google\\ApiCore\\Transport","p":"Google/ApiCore/Transport.html"}},{"t":"T","n":"Google\\ApiCore\\UriTrait","p":"Google/ApiCore/UriTrait.html","d":"Provides a light wrapper around often used URI related functions.
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\ValidationException","p":"Google/ApiCore/ValidationException.html","d":"ValidationException represents a local error (i.e. not during an RPC call).
","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"T","n":"Google\\ApiCore\\ValidationTrait","p":"Google/ApiCore/ValidationTrait.html","d":"","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"C","n":"Google\\ApiCore\\Version","p":"Google/ApiCore/Version.html","d":"","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"I","n":"Google\\ApiCore\\Middleware\\MiddlewareInterface","p":"Google/ApiCore/Middleware/MiddlewareInterface.html","f":{"n":"Google\\ApiCore\\Middleware","p":"Google/ApiCore/Middleware.html"}},{"t":"I","n":"Google\\ApiCore\\ResourceTemplate\\ResourceTemplateInterface","p":"Google/ApiCore/ResourceTemplate/ResourceTemplateInterface.html","f":{"n":"Google\\ApiCore\\ResourceTemplate","p":"Google/ApiCore/ResourceTemplate.html"}},{"t":"I","n":"Google\\ApiCore\\ServerStreamingCallInterface","p":"Google/ApiCore/ServerStreamingCallInterface.html","f":{"n":"Google\\ApiCore","p":"Google/ApiCore.html"}},{"t":"I","n":"Google\\ApiCore\\Transport\\Grpc\\UnaryInterceptorInterface","p":"Google/ApiCore/Transport/Grpc/UnaryInterceptorInterface.html","f":{"n":"Google\\ApiCore\\Transport\\Grpc","p":"Google/ApiCore/Transport/Grpc.html"}},{"t":"I","n":"Google\\ApiCore\\Transport\\TransportInterface","p":"Google/ApiCore/Transport/TransportInterface.html","f":{"n":"Google\\ApiCore\\Transport","p":"Google/ApiCore/Transport.html"}},{"t":"M","n":"Google\\ApiCore\\AgentHeader::buildAgentHeader","p":"Google/ApiCore/AgentHeader.html#method_buildAgentHeader","d":""},{"t":"M","n":"Google\\ApiCore\\AgentHeader::readGapicVersionFromFile","p":"Google/ApiCore/AgentHeader.html#method_readGapicVersionFromFile","d":"Reads the gapic version string from a VERSION file. In order to determine the file\nlocation, this method follows this procedure:
\nApiException constructor.
"},{"t":"M","n":"Google\\ApiCore\\ApiException::getStatus","p":"Google/ApiCore/ApiException.html#method_getStatus","d":null},{"t":"M","n":"Google\\ApiCore\\ApiException::getReason","p":"Google/ApiCore/ApiException.html#method_getReason","d":"Returns the reason in ErrorInfo for an exception, or null if there is no ErrorInfo.
Returns the domain in ErrorInfo for an exception, or null if there is no ErrorInfo.
Returns the metadata in ErrorInfo for an exception, or null if there is no ErrorInfo.
For REST-based responses, the metadata does not need to be decoded.
"},{"t":"M","n":"Google\\ApiCore\\ApiException::createFromRpcStatus","p":"Google/ApiCore/ApiException.html#method_createFromRpcStatus","d":""},{"t":"M","n":"Google\\ApiCore\\ApiException::createFromRequestException","p":"Google/ApiCore/ApiException.html#method_createFromRequestException","d":"Creates an ApiException from a GuzzleHttp RequestException.
"},{"t":"M","n":"Google\\ApiCore\\ApiException::getBasicMessage","p":"Google/ApiCore/ApiException.html#method_getBasicMessage","d":""},{"t":"M","n":"Google\\ApiCore\\ApiException::getMetadata","p":"Google/ApiCore/ApiException.html#method_getMetadata","d":""},{"t":"M","n":"Google\\ApiCore\\ApiException::__toString","p":"Google/ApiCore/ApiException.html#method___toString","d":"String representation of ApiException
"},{"t":"M","n":"Google\\ApiCore\\ApiStatus::isValidStatus","p":"Google/ApiCore/ApiStatus.html#method_isValidStatus","d":""},{"t":"M","n":"Google\\ApiCore\\ApiStatus::statusFromRpcCode","p":"Google/ApiCore/ApiStatus.html#method_statusFromRpcCode","d":""},{"t":"M","n":"Google\\ApiCore\\ApiStatus::rpcCodeFromStatus","p":"Google/ApiCore/ApiStatus.html#method_rpcCodeFromStatus","d":""},{"t":"M","n":"Google\\ApiCore\\ApiStatus::rpcCodeFromHttpStatusCode","p":"Google/ApiCore/ApiStatus.html#method_rpcCodeFromHttpStatusCode","d":"Maps HTTP status codes to Google\\Rpc\\Code codes.
"},{"t":"M","n":"Google\\ApiCore\\BidiStream::__construct","p":"Google/ApiCore/BidiStream.html#method___construct","d":"BidiStream constructor.
"},{"t":"M","n":"Google\\ApiCore\\BidiStream::write","p":"Google/ApiCore/BidiStream.html#method_write","d":"Write request to the server.
"},{"t":"M","n":"Google\\ApiCore\\BidiStream::writeAll","p":"Google/ApiCore/BidiStream.html#method_writeAll","d":"Write all requests in $requests.
"},{"t":"M","n":"Google\\ApiCore\\BidiStream::closeWrite","p":"Google/ApiCore/BidiStream.html#method_closeWrite","d":"Inform the server that no more requests will be written. The write() function cannot be\ncalled after closeWrite() is called.
"},{"t":"M","n":"Google\\ApiCore\\BidiStream::read","p":"Google/ApiCore/BidiStream.html#method_read","d":"Read the next response from the server. Returns null if the streaming call completed\nsuccessfully. Throws an ApiException if the streaming call failed.
"},{"t":"M","n":"Google\\ApiCore\\BidiStream::closeWriteAndReadAll","p":"Google/ApiCore/BidiStream.html#method_closeWriteAndReadAll","d":"Call closeWrite(), and read all responses from the server, until the streaming call is\ncompleted. Throws an ApiException if the streaming call failed.
"},{"t":"M","n":"Google\\ApiCore\\BidiStream::getBidiStreamingCall","p":"Google/ApiCore/BidiStream.html#method_getBidiStreamingCall","d":"Return the underlying gRPC call object
"},{"t":"M","n":"Google\\ApiCore\\Call::__construct","p":"Google/ApiCore/Call.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Call::getMethod","p":"Google/ApiCore/Call.html#method_getMethod","d":""},{"t":"M","n":"Google\\ApiCore\\Call::getCallType","p":"Google/ApiCore/Call.html#method_getCallType","d":""},{"t":"M","n":"Google\\ApiCore\\Call::getDecodeType","p":"Google/ApiCore/Call.html#method_getDecodeType","d":""},{"t":"M","n":"Google\\ApiCore\\Call::getMessage","p":"Google/ApiCore/Call.html#method_getMessage","d":""},{"t":"M","n":"Google\\ApiCore\\Call::getDescriptor","p":"Google/ApiCore/Call.html#method_getDescriptor","d":""},{"t":"M","n":"Google\\ApiCore\\Call::withMessage","p":"Google/ApiCore/Call.html#method_withMessage","d":""},{"t":"M","n":"Google\\ApiCore\\ClientStream::__construct","p":"Google/ApiCore/ClientStream.html#method___construct","d":"ClientStream constructor.
"},{"t":"M","n":"Google\\ApiCore\\ClientStream::write","p":"Google/ApiCore/ClientStream.html#method_write","d":"Write request to the server.
"},{"t":"M","n":"Google\\ApiCore\\ClientStream::readResponse","p":"Google/ApiCore/ClientStream.html#method_readResponse","d":"Read the response from the server, completing the streaming call.
"},{"t":"M","n":"Google\\ApiCore\\ClientStream::writeAllAndReadResponse","p":"Google/ApiCore/ClientStream.html#method_writeAllAndReadResponse","d":"Write all data in $dataArray and read the response from the server, completing the streaming\ncall.
"},{"t":"M","n":"Google\\ApiCore\\ClientStream::getClientStreamingCall","p":"Google/ApiCore/ClientStream.html#method_getClientStreamingCall","d":"Return the underlying gRPC call object
"},{"t":"M","n":"Google\\ApiCore\\CredentialsWrapper::__construct","p":"Google/ApiCore/CredentialsWrapper.html#method___construct","d":"CredentialsWrapper constructor.
"},{"t":"M","n":"Google\\ApiCore\\CredentialsWrapper::build","p":"Google/ApiCore/CredentialsWrapper.html#method_build","d":"Factory method to create a CredentialsWrapper from an array of options.
"},{"t":"M","n":"Google\\ApiCore\\CredentialsWrapper::getQuotaProject","p":"Google/ApiCore/CredentialsWrapper.html#method_getQuotaProject","d":""},{"t":"M","n":"Google\\ApiCore\\CredentialsWrapper::getProjectId","p":"Google/ApiCore/CredentialsWrapper.html#method_getProjectId","d":null},{"t":"M","n":"Google\\ApiCore\\CredentialsWrapper::getBearerString","p":"Google/ApiCore/CredentialsWrapper.html#method_getBearerString","d":""},{"t":"M","n":"Google\\ApiCore\\CredentialsWrapper::getAuthorizationHeaderCallback","p":"Google/ApiCore/CredentialsWrapper.html#method_getAuthorizationHeaderCallback","d":""},{"t":"M","n":"Google\\ApiCore\\CredentialsWrapper::checkUniverseDomain","p":"Google/ApiCore/CredentialsWrapper.html#method_checkUniverseDomain","d":"Verify that the expected universe domain matches the universe domain from the credentials.
"},{"t":"M","n":"Google\\ApiCore\\FixedSizeCollection::__construct","p":"Google/ApiCore/FixedSizeCollection.html#method___construct","d":"FixedSizeCollection constructor.
"},{"t":"M","n":"Google\\ApiCore\\FixedSizeCollection::getCollectionSize","p":"Google/ApiCore/FixedSizeCollection.html#method_getCollectionSize","d":"Returns the number of elements in the collection. This will be\nequal to the collectionSize parameter used at construction\nunless there are no elements remaining to be retrieved.
"},{"t":"M","n":"Google\\ApiCore\\FixedSizeCollection::hasNextCollection","p":"Google/ApiCore/FixedSizeCollection.html#method_hasNextCollection","d":"Returns true if there are more elements that can be retrieved\nfrom the API.
"},{"t":"M","n":"Google\\ApiCore\\FixedSizeCollection::getNextPageToken","p":"Google/ApiCore/FixedSizeCollection.html#method_getNextPageToken","d":"Returns a page token that can be passed into the API list\nmethod to retrieve additional elements.
"},{"t":"M","n":"Google\\ApiCore\\FixedSizeCollection::getNextCollection","p":"Google/ApiCore/FixedSizeCollection.html#method_getNextCollection","d":"Retrieves the next FixedSizeCollection using one or more API calls.
"},{"t":"M","n":"Google\\ApiCore\\FixedSizeCollection::getIterator","p":"Google/ApiCore/FixedSizeCollection.html#method_getIterator","d":"Returns an iterator over the elements of the collection.
"},{"t":"M","n":"Google\\ApiCore\\FixedSizeCollection::iterateCollections","p":"Google/ApiCore/FixedSizeCollection.html#method_iterateCollections","d":"Returns an iterator over FixedSizeCollections, starting with this\nand making API calls as required until all of the elements have\nbeen retrieved.
"},{"t":"M","n":"Google\\ApiCore\\GapicClientTrait::addMiddleware","p":"Google/ApiCore/GapicClientTrait.html#method_addMiddleware","d":"Add a middleware to the call stack by providing a callable which will be\ninvoked at the start of each call, and will return an instance of\n{MiddlewareInterface} when invoked.
"},{"t":"M","n":"Google\\ApiCore\\GapicClientTrait::close","p":"Google/ApiCore/GapicClientTrait.html#method_close","d":"Initiates an orderly shutdown in which preexisting calls continue but new\ncalls are immediately cancelled.
"},{"t":"M","n":"Google\\ApiCore\\InsecureCredentialsWrapper::__construct","p":"Google/ApiCore/InsecureCredentialsWrapper.html#method___construct","d":"CredentialsWrapper constructor.
"},{"t":"M","n":"Google\\ApiCore\\InsecureCredentialsWrapper::getAuthorizationHeaderCallback","p":"Google/ApiCore/InsecureCredentialsWrapper.html#method_getAuthorizationHeaderCallback","d":""},{"t":"M","n":"Google\\ApiCore\\InsecureCredentialsWrapper::checkUniverseDomain","p":"Google/ApiCore/InsecureCredentialsWrapper.html#method_checkUniverseDomain","d":"Verify that the expected universe domain matches the universe domain from the credentials.
"},{"t":"M","n":"Google\\ApiCore\\Middleware\\CredentialsWrapperMiddleware::__construct","p":"Google/ApiCore/Middleware/CredentialsWrapperMiddleware.html#method___construct","d":null},{"t":"M","n":"Google\\ApiCore\\Middleware\\CredentialsWrapperMiddleware::__invoke","p":"Google/ApiCore/Middleware/CredentialsWrapperMiddleware.html#method___invoke","d":"Modify or observe the API call request and response.
"},{"t":"M","n":"Google\\ApiCore\\Middleware\\FixedHeaderMiddleware::__construct","p":"Google/ApiCore/Middleware/FixedHeaderMiddleware.html#method___construct","d":null},{"t":"M","n":"Google\\ApiCore\\Middleware\\FixedHeaderMiddleware::__invoke","p":"Google/ApiCore/Middleware/FixedHeaderMiddleware.html#method___invoke","d":"Modify or observe the API call request and response.
"},{"t":"M","n":"Google\\ApiCore\\Middleware\\MiddlewareInterface::__invoke","p":"Google/ApiCore/Middleware/MiddlewareInterface.html#method___invoke","d":"Modify or observe the API call request and response.
"},{"t":"M","n":"Google\\ApiCore\\Middleware\\OperationsMiddleware::__construct","p":"Google/ApiCore/Middleware/OperationsMiddleware.html#method___construct","d":null},{"t":"M","n":"Google\\ApiCore\\Middleware\\OperationsMiddleware::__invoke","p":"Google/ApiCore/Middleware/OperationsMiddleware.html#method___invoke","d":"Modify or observe the API call request and response.
"},{"t":"M","n":"Google\\ApiCore\\Middleware\\OptionsFilterMiddleware::__construct","p":"Google/ApiCore/Middleware/OptionsFilterMiddleware.html#method___construct","d":null},{"t":"M","n":"Google\\ApiCore\\Middleware\\OptionsFilterMiddleware::__invoke","p":"Google/ApiCore/Middleware/OptionsFilterMiddleware.html#method___invoke","d":"Modify or observe the API call request and response.
"},{"t":"M","n":"Google\\ApiCore\\Middleware\\PagedMiddleware::__construct","p":"Google/ApiCore/Middleware/PagedMiddleware.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Middleware\\PagedMiddleware::__invoke","p":"Google/ApiCore/Middleware/PagedMiddleware.html#method___invoke","d":"Modify or observe the API call request and response.
"},{"t":"M","n":"Google\\ApiCore\\Middleware\\RequestAutoPopulationMiddleware::__construct","p":"Google/ApiCore/Middleware/RequestAutoPopulationMiddleware.html#method___construct","d":null},{"t":"M","n":"Google\\ApiCore\\Middleware\\RequestAutoPopulationMiddleware::__invoke","p":"Google/ApiCore/Middleware/RequestAutoPopulationMiddleware.html#method___invoke","d":""},{"t":"M","n":"Google\\ApiCore\\Middleware\\ResponseMetadataMiddleware::__construct","p":"Google/ApiCore/Middleware/ResponseMetadataMiddleware.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Middleware\\ResponseMetadataMiddleware::__invoke","p":"Google/ApiCore/Middleware/ResponseMetadataMiddleware.html#method___invoke","d":"Modify or observe the API call request and response.
"},{"t":"M","n":"Google\\ApiCore\\Middleware\\RetryMiddleware::__construct","p":"Google/ApiCore/Middleware/RetryMiddleware.html#method___construct","d":null},{"t":"M","n":"Google\\ApiCore\\Middleware\\RetryMiddleware::__invoke","p":"Google/ApiCore/Middleware/RetryMiddleware.html#method___invoke","d":""},{"t":"M","n":"Google\\ApiCore\\Middleware\\RetryMiddleware::getCurrentTimeMs","p":"Google/ApiCore/Middleware/RetryMiddleware.html#method_getCurrentTimeMs","d":null},{"t":"M","n":"Google\\ApiCore\\OperationResponse::__construct","p":"Google/ApiCore/OperationResponse.html#method___construct","d":"OperationResponse constructor.
"},{"t":"M","n":"Google\\ApiCore\\OperationResponse::isDone","p":"Google/ApiCore/OperationResponse.html#method_isDone","d":"Check whether the operation has completed.
"},{"t":"M","n":"Google\\ApiCore\\OperationResponse::operationSucceeded","p":"Google/ApiCore/OperationResponse.html#method_operationSucceeded","d":"Check whether the operation completed successfully. If the operation is not complete, or if the operation\nfailed, return false.
"},{"t":"M","n":"Google\\ApiCore\\OperationResponse::operationFailed","p":"Google/ApiCore/OperationResponse.html#method_operationFailed","d":"Check whether the operation failed. If the operation is not complete, or if the operation\nsucceeded, return false.
"},{"t":"M","n":"Google\\ApiCore\\OperationResponse::getName","p":"Google/ApiCore/OperationResponse.html#method_getName","d":"Get the formatted name of the operation
"},{"t":"M","n":"Google\\ApiCore\\OperationResponse::pollUntilComplete","p":"Google/ApiCore/OperationResponse.html#method_pollUntilComplete","d":"Poll the server in a loop until the operation is complete.
"},{"t":"M","n":"Google\\ApiCore\\OperationResponse::reload","p":"Google/ApiCore/OperationResponse.html#method_reload","d":"Reload the status of the operation with a request to the service.
"},{"t":"M","n":"Google\\ApiCore\\OperationResponse::getResult","p":"Google/ApiCore/OperationResponse.html#method_getResult","d":"Return the result of the operation. If operationSucceeded() is false, return null.
"},{"t":"M","n":"Google\\ApiCore\\OperationResponse::getError","p":"Google/ApiCore/OperationResponse.html#method_getError","d":"If the operation failed, return the status. If operationFailed() is false, return null.
"},{"t":"M","n":"Google\\ApiCore\\OperationResponse::getDescriptorOptions","p":"Google/ApiCore/OperationResponse.html#method_getDescriptorOptions","d":"Get an array containing the values of 'operationReturnType', 'metadataReturnType', and\nthe polling options initialPollDelayMillis, pollDelayMultiplier, maxPollDelayMillis,\nand totalPollTimeoutMillis. The array can be passed as the $options argument to the\nconstructor when creating another OperationResponse object.
Cancel the long-running operation.
"},{"t":"M","n":"Google\\ApiCore\\OperationResponse::delete","p":"Google/ApiCore/OperationResponse.html#method_delete","d":"Delete the long-running operation.
"},{"t":"M","n":"Google\\ApiCore\\OperationResponse::getMetadata","p":"Google/ApiCore/OperationResponse.html#method_getMetadata","d":"Get the metadata returned with the last proto response. If a metadata type was provided, then\nthe return value will be of that type - otherwise, the return value will be of type Any. If\nno metadata object is available, returns null.
"},{"t":"M","n":"Google\\ApiCore\\Options\\CallOptions::__construct","p":"Google/ApiCore/Options/CallOptions.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\CallOptions::setHeaders","p":"Google/ApiCore/Options/CallOptions.html#method_setHeaders","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\CallOptions::setTimeoutMillis","p":"Google/ApiCore/Options/CallOptions.html#method_setTimeoutMillis","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\CallOptions::setTransportOptions","p":"Google/ApiCore/Options/CallOptions.html#method_setTransportOptions","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\CallOptions::setTransportSpecificOptions","p":"Google/ApiCore/Options/CallOptions.html#method_setTransportSpecificOptions","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\CallOptions::setRetrySettings","p":"Google/ApiCore/Options/CallOptions.html#method_setRetrySettings","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::__construct","p":"Google/ApiCore/Options/ClientOptions.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setApiEndpoint","p":"Google/ApiCore/Options/ClientOptions.html#method_setApiEndpoint","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setDisableRetries","p":"Google/ApiCore/Options/ClientOptions.html#method_setDisableRetries","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setClientConfig","p":"Google/ApiCore/Options/ClientOptions.html#method_setClientConfig","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setCredentials","p":"Google/ApiCore/Options/ClientOptions.html#method_setCredentials","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setCredentialsConfig","p":"Google/ApiCore/Options/ClientOptions.html#method_setCredentialsConfig","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setTransport","p":"Google/ApiCore/Options/ClientOptions.html#method_setTransport","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setTransportConfig","p":"Google/ApiCore/Options/ClientOptions.html#method_setTransportConfig","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setVersionFile","p":"Google/ApiCore/Options/ClientOptions.html#method_setVersionFile","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setServiceName","p":"Google/ApiCore/Options/ClientOptions.html#method_setServiceName","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setLibName","p":"Google/ApiCore/Options/ClientOptions.html#method_setLibName","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setLibVersion","p":"Google/ApiCore/Options/ClientOptions.html#method_setLibVersion","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setGapicVersion","p":"Google/ApiCore/Options/ClientOptions.html#method_setGapicVersion","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setClientCertSource","p":"Google/ApiCore/Options/ClientOptions.html#method_setClientCertSource","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\ClientOptions::setUniverseDomain","p":"Google/ApiCore/Options/ClientOptions.html#method_setUniverseDomain","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\OptionsTrait::offsetExists","p":"Google/ApiCore/Options/OptionsTrait.html#method_offsetExists","d":null},{"t":"M","n":"Google\\ApiCore\\Options\\OptionsTrait::offsetGet","p":"Google/ApiCore/Options/OptionsTrait.html#method_offsetGet","d":null},{"t":"M","n":"Google\\ApiCore\\Options\\OptionsTrait::offsetSet","p":"Google/ApiCore/Options/OptionsTrait.html#method_offsetSet","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\OptionsTrait::offsetUnset","p":"Google/ApiCore/Options/OptionsTrait.html#method_offsetUnset","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\OptionsTrait::toArray","p":"Google/ApiCore/Options/OptionsTrait.html#method_toArray","d":null},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions::__construct","p":"Google/ApiCore/Options/TransportOptions.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions::setGrpc","p":"Google/ApiCore/Options/TransportOptions.html#method_setGrpc","d":null},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions::setGrpcFallback","p":"Google/ApiCore/Options/TransportOptions.html#method_setGrpcFallback","d":null},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions::setRest","p":"Google/ApiCore/Options/TransportOptions.html#method_setRest","d":null},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\GrpcFallbackTransportOptions::__construct","p":"Google/ApiCore/Options/TransportOptions/GrpcFallbackTransportOptions.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\GrpcFallbackTransportOptions::setHttpHandler","p":"Google/ApiCore/Options/TransportOptions/GrpcFallbackTransportOptions.html#method_setHttpHandler","d":null},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\GrpcFallbackTransportOptions::setClientCertSource","p":"Google/ApiCore/Options/TransportOptions/GrpcFallbackTransportOptions.html#method_setClientCertSource","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\GrpcTransportOptions::__construct","p":"Google/ApiCore/Options/TransportOptions/GrpcTransportOptions.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\GrpcTransportOptions::setStubOpts","p":"Google/ApiCore/Options/TransportOptions/GrpcTransportOptions.html#method_setStubOpts","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\GrpcTransportOptions::setChannel","p":"Google/ApiCore/Options/TransportOptions/GrpcTransportOptions.html#method_setChannel","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\GrpcTransportOptions::setInterceptors","p":"Google/ApiCore/Options/TransportOptions/GrpcTransportOptions.html#method_setInterceptors","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\GrpcTransportOptions::setClientCertSource","p":"Google/ApiCore/Options/TransportOptions/GrpcTransportOptions.html#method_setClientCertSource","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\RestTransportOptions::__construct","p":"Google/ApiCore/Options/TransportOptions/RestTransportOptions.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\RestTransportOptions::setHttpHandler","p":"Google/ApiCore/Options/TransportOptions/RestTransportOptions.html#method_setHttpHandler","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\RestTransportOptions::setClientCertSource","p":"Google/ApiCore/Options/TransportOptions/RestTransportOptions.html#method_setClientCertSource","d":""},{"t":"M","n":"Google\\ApiCore\\Options\\TransportOptions\\RestTransportOptions::setRestClientConfigPath","p":"Google/ApiCore/Options/TransportOptions/RestTransportOptions.html#method_setRestClientConfigPath","d":""},{"t":"M","n":"Google\\ApiCore\\Page::__construct","p":"Google/ApiCore/Page.html#method___construct","d":"Page constructor.
"},{"t":"M","n":"Google\\ApiCore\\Page::hasNextPage","p":"Google/ApiCore/Page.html#method_hasNextPage","d":"Returns true if there are more pages that can be retrieved from the\nAPI.
"},{"t":"M","n":"Google\\ApiCore\\Page::getNextPageToken","p":"Google/ApiCore/Page.html#method_getNextPageToken","d":"Returns the next page token from the response.
"},{"t":"M","n":"Google\\ApiCore\\Page::getNextPage","p":"Google/ApiCore/Page.html#method_getNextPage","d":"Retrieves the next Page object using the next page token.
"},{"t":"M","n":"Google\\ApiCore\\Page::getPageElementCount","p":"Google/ApiCore/Page.html#method_getPageElementCount","d":"Return the number of elements in the response.
"},{"t":"M","n":"Google\\ApiCore\\Page::getIterator","p":"Google/ApiCore/Page.html#method_getIterator","d":"Return an iterator over the elements in the response.
"},{"t":"M","n":"Google\\ApiCore\\Page::iteratePages","p":"Google/ApiCore/Page.html#method_iteratePages","d":"Return an iterator over Page objects, beginning with this object.
"},{"t":"M","n":"Google\\ApiCore\\Page::getRequestObject","p":"Google/ApiCore/Page.html#method_getRequestObject","d":"Gets the request object used to generate the Page.
"},{"t":"M","n":"Google\\ApiCore\\Page::getResponseObject","p":"Google/ApiCore/Page.html#method_getResponseObject","d":"Gets the API response object.
"},{"t":"M","n":"Google\\ApiCore\\Page::expandToFixedSizeCollection","p":"Google/ApiCore/Page.html#method_expandToFixedSizeCollection","d":"Returns a collection of elements with a fixed size set by\nthe collectionSize parameter. The collection will only contain\nfewer than collectionSize elements if there are no more\npages to be retrieved from the server.
"},{"t":"M","n":"Google\\ApiCore\\PageStreamingDescriptor::__construct","p":"Google/ApiCore/PageStreamingDescriptor.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\PageStreamingDescriptor::createFromFields","p":"Google/ApiCore/PageStreamingDescriptor.html#method_createFromFields","d":""},{"t":"M","n":"Google\\ApiCore\\PageStreamingDescriptor::getRequestPageTokenGetMethod","p":"Google/ApiCore/PageStreamingDescriptor.html#method_getRequestPageTokenGetMethod","d":""},{"t":"M","n":"Google\\ApiCore\\PageStreamingDescriptor::getRequestPageSizeGetMethod","p":"Google/ApiCore/PageStreamingDescriptor.html#method_getRequestPageSizeGetMethod","d":""},{"t":"M","n":"Google\\ApiCore\\PageStreamingDescriptor::requestHasPageSizeField","p":"Google/ApiCore/PageStreamingDescriptor.html#method_requestHasPageSizeField","d":""},{"t":"M","n":"Google\\ApiCore\\PageStreamingDescriptor::getResponsePageTokenGetMethod","p":"Google/ApiCore/PageStreamingDescriptor.html#method_getResponsePageTokenGetMethod","d":""},{"t":"M","n":"Google\\ApiCore\\PageStreamingDescriptor::getResourcesGetMethod","p":"Google/ApiCore/PageStreamingDescriptor.html#method_getResourcesGetMethod","d":""},{"t":"M","n":"Google\\ApiCore\\PageStreamingDescriptor::getRequestPageTokenSetMethod","p":"Google/ApiCore/PageStreamingDescriptor.html#method_getRequestPageTokenSetMethod","d":""},{"t":"M","n":"Google\\ApiCore\\PageStreamingDescriptor::getRequestPageSizeSetMethod","p":"Google/ApiCore/PageStreamingDescriptor.html#method_getRequestPageSizeSetMethod","d":""},{"t":"M","n":"Google\\ApiCore\\PagedListResponse::__construct","p":"Google/ApiCore/PagedListResponse.html#method___construct","d":"PagedListResponse constructor.
"},{"t":"M","n":"Google\\ApiCore\\PagedListResponse::iterateAllElements","p":"Google/ApiCore/PagedListResponse.html#method_iterateAllElements","d":"Returns an iterator over the full list of elements. If the\nAPI response contains a (non-empty) next page token, then\nthe PagedListResponse object will make calls to the underlying\nAPI to retrieve additional elements as required.
"},{"t":"M","n":"Google\\ApiCore\\PagedListResponse::getIterator","p":"Google/ApiCore/PagedListResponse.html#method_getIterator","d":"Returns an iterator over the full list of elements. If the\nAPI response contains a (non-empty) next page token, then\nthe PagedListResponse object will make calls to the underlying\nAPI to retrieve additional elements as required.
"},{"t":"M","n":"Google\\ApiCore\\PagedListResponse::getPage","p":"Google/ApiCore/PagedListResponse.html#method_getPage","d":"Return the current page of results.
"},{"t":"M","n":"Google\\ApiCore\\PagedListResponse::iteratePages","p":"Google/ApiCore/PagedListResponse.html#method_iteratePages","d":"Returns an iterator over pages of results. The pages are\nretrieved lazily from the underlying API.
"},{"t":"M","n":"Google\\ApiCore\\PagedListResponse::expandToFixedSizeCollection","p":"Google/ApiCore/PagedListResponse.html#method_expandToFixedSizeCollection","d":"Returns a collection of elements with a fixed size set by\nthe collectionSize parameter. The collection will only contain\nfewer than collectionSize elements if there are no more\npages to be retrieved from the server.
"},{"t":"M","n":"Google\\ApiCore\\PagedListResponse::iterateFixedSizeCollections","p":"Google/ApiCore/PagedListResponse.html#method_iterateFixedSizeCollections","d":"Returns an iterator over fixed size collections of results.
"},{"t":"M","n":"Google\\ApiCore\\PathTemplate::__construct","p":"Google/ApiCore/PathTemplate.html#method___construct","d":"PathTemplate constructor.
"},{"t":"M","n":"Google\\ApiCore\\PathTemplate::__toString","p":"Google/ApiCore/PathTemplate.html#method___toString","d":""},{"t":"M","n":"Google\\ApiCore\\PathTemplate::render","p":"Google/ApiCore/PathTemplate.html#method_render","d":"Renders a path template using the provided bindings.
"},{"t":"M","n":"Google\\ApiCore\\PathTemplate::matches","p":"Google/ApiCore/PathTemplate.html#method_matches","d":"Check if $path matches a resource string.
"},{"t":"M","n":"Google\\ApiCore\\PathTemplate::match","p":"Google/ApiCore/PathTemplate.html#method_match","d":"Matches a fully qualified path template string.
"},{"t":"M","n":"Google\\ApiCore\\PollingTrait::getCurrentTimeMillis","p":"Google/ApiCore/PollingTrait.html#method_getCurrentTimeMillis","d":"Protected to allow overriding for tests
"},{"t":"M","n":"Google\\ApiCore\\PollingTrait::sleepMillis","p":"Google/ApiCore/PollingTrait.html#method_sleepMillis","d":"Protected to allow overriding for tests
"},{"t":"M","n":"Google\\ApiCore\\RequestBuilder::__construct","p":"Google/ApiCore/RequestBuilder.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\RequestBuilder::pathExists","p":"Google/ApiCore/RequestBuilder.html#method_pathExists","d":""},{"t":"M","n":"Google\\ApiCore\\RequestBuilder::build","p":"Google/ApiCore/RequestBuilder.html#method_build","d":""},{"t":"M","n":"Google\\ApiCore\\RequestParamsHeaderDescriptor::__construct","p":"Google/ApiCore/RequestParamsHeaderDescriptor.html#method___construct","d":"RequestParamsHeaderDescriptor constructor.
"},{"t":"M","n":"Google\\ApiCore\\RequestParamsHeaderDescriptor::getHeader","p":"Google/ApiCore/RequestParamsHeaderDescriptor.html#method_getHeader","d":"Returns an associative array that contains request params header metadata.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\AbsoluteResourceTemplate::__construct","p":"Google/ApiCore/ResourceTemplate/AbsoluteResourceTemplate.html#method___construct","d":"AbsoluteResourceTemplate constructor.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\AbsoluteResourceTemplate::__toString","p":"Google/ApiCore/ResourceTemplate/AbsoluteResourceTemplate.html#method___toString","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\AbsoluteResourceTemplate::render","p":"Google/ApiCore/ResourceTemplate/AbsoluteResourceTemplate.html#method_render","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\AbsoluteResourceTemplate::matches","p":"Google/ApiCore/ResourceTemplate/AbsoluteResourceTemplate.html#method_matches","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\AbsoluteResourceTemplate::match","p":"Google/ApiCore/ResourceTemplate/AbsoluteResourceTemplate.html#method_match","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\Parser::parseSegments","p":"Google/ApiCore/ResourceTemplate/Parser.html#method_parseSegments","d":"Parses a path into an array of segments.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\RelativeResourceTemplate::__construct","p":"Google/ApiCore/ResourceTemplate/RelativeResourceTemplate.html#method___construct","d":"RelativeResourceTemplate constructor.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\RelativeResourceTemplate::__toString","p":"Google/ApiCore/ResourceTemplate/RelativeResourceTemplate.html#method___toString","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\RelativeResourceTemplate::render","p":"Google/ApiCore/ResourceTemplate/RelativeResourceTemplate.html#method_render","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\RelativeResourceTemplate::matches","p":"Google/ApiCore/ResourceTemplate/RelativeResourceTemplate.html#method_matches","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\RelativeResourceTemplate::match","p":"Google/ApiCore/ResourceTemplate/RelativeResourceTemplate.html#method_match","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\ResourceTemplateInterface::__toString","p":"Google/ApiCore/ResourceTemplate/ResourceTemplateInterface.html#method___toString","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\ResourceTemplateInterface::render","p":"Google/ApiCore/ResourceTemplate/ResourceTemplateInterface.html#method_render","d":"Renders a resource template using the provided bindings.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\ResourceTemplateInterface::matches","p":"Google/ApiCore/ResourceTemplate/ResourceTemplateInterface.html#method_matches","d":"Check if $path matches a resource string.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\ResourceTemplateInterface::match","p":"Google/ApiCore/ResourceTemplate/ResourceTemplateInterface.html#method_match","d":"Matches a given $path to a resource template, and returns an array of bindings between\nwildcards / variables in the template and values in the path. If $path does not match the\ntemplate, then a ValidationException is thrown.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\Segment::__construct","p":"Google/ApiCore/ResourceTemplate/Segment.html#method___construct","d":"Segment constructor.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\Segment::__toString","p":"Google/ApiCore/ResourceTemplate/Segment.html#method___toString","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\Segment::matches","p":"Google/ApiCore/ResourceTemplate/Segment.html#method_matches","d":"Checks if $value matches this Segment.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\Segment::getSegmentType","p":"Google/ApiCore/ResourceTemplate/Segment.html#method_getSegmentType","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\Segment::getKey","p":"Google/ApiCore/ResourceTemplate/Segment.html#method_getKey","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\Segment::getValue","p":"Google/ApiCore/ResourceTemplate/Segment.html#method_getValue","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\Segment::getTemplate","p":"Google/ApiCore/ResourceTemplate/Segment.html#method_getTemplate","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\Segment::getSeparator","p":"Google/ApiCore/ResourceTemplate/Segment.html#method_getSeparator","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::__construct","p":"Google/ApiCore/RetrySettings.html#method___construct","d":"Constructs an instance.
"},{"t":"M","n":"Google\\ApiCore\\RetrySettings::load","p":"Google/ApiCore/RetrySettings.html#method_load","d":"Constructs an array mapping method names to CallSettings.
"},{"t":"M","n":"Google\\ApiCore\\RetrySettings::constructDefault","p":"Google/ApiCore/RetrySettings.html#method_constructDefault","d":null},{"t":"M","n":"Google\\ApiCore\\RetrySettings::with","p":"Google/ApiCore/RetrySettings.html#method_with","d":"Creates a new instance of RetrySettings that updates the settings in the existing instance\nwith the settings specified in the $settings parameter.
"},{"t":"M","n":"Google\\ApiCore\\RetrySettings::logicalTimeout","p":"Google/ApiCore/RetrySettings.html#method_logicalTimeout","d":"Creates an associative array of the {\\Google\\ApiCore\\RetrySettings} timeout fields configured\nwith the given timeout specified in the $timeout parameter interpreted as a logical timeout.
"},{"t":"M","n":"Google\\ApiCore\\RetrySettings::retriesEnabled","p":"Google/ApiCore/RetrySettings.html#method_retriesEnabled","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::getNoRetriesRpcTimeoutMillis","p":"Google/ApiCore/RetrySettings.html#method_getNoRetriesRpcTimeoutMillis","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::getRetryableCodes","p":"Google/ApiCore/RetrySettings.html#method_getRetryableCodes","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::getInitialRetryDelayMillis","p":"Google/ApiCore/RetrySettings.html#method_getInitialRetryDelayMillis","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::getRetryDelayMultiplier","p":"Google/ApiCore/RetrySettings.html#method_getRetryDelayMultiplier","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::getMaxRetryDelayMillis","p":"Google/ApiCore/RetrySettings.html#method_getMaxRetryDelayMillis","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::getInitialRpcTimeoutMillis","p":"Google/ApiCore/RetrySettings.html#method_getInitialRpcTimeoutMillis","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::getRpcTimeoutMultiplier","p":"Google/ApiCore/RetrySettings.html#method_getRpcTimeoutMultiplier","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::getMaxRpcTimeoutMillis","p":"Google/ApiCore/RetrySettings.html#method_getMaxRpcTimeoutMillis","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::getTotalTimeoutMillis","p":"Google/ApiCore/RetrySettings.html#method_getTotalTimeoutMillis","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::getMaxRetries","p":"Google/ApiCore/RetrySettings.html#method_getMaxRetries","d":""},{"t":"M","n":"Google\\ApiCore\\RetrySettings::getRetryFunction","p":"Google/ApiCore/RetrySettings.html#method_getRetryFunction","d":""},{"t":"M","n":"Google\\ApiCore\\Serializer::__construct","p":"Google/ApiCore/Serializer.html#method___construct","d":"Serializer constructor.
"},{"t":"M","n":"Google\\ApiCore\\Serializer::encodeMessage","p":"Google/ApiCore/Serializer.html#method_encodeMessage","d":"Encode protobuf message as a PHP array
"},{"t":"M","n":"Google\\ApiCore\\Serializer::decodeMessage","p":"Google/ApiCore/Serializer.html#method_decodeMessage","d":"Decode PHP array into the specified protobuf message
"},{"t":"M","n":"Google\\ApiCore\\Serializer::serializeToJson","p":"Google/ApiCore/Serializer.html#method_serializeToJson","d":""},{"t":"M","n":"Google\\ApiCore\\Serializer::serializeToPhpArray","p":"Google/ApiCore/Serializer.html#method_serializeToPhpArray","d":""},{"t":"M","n":"Google\\ApiCore\\Serializer::decodeMetadata","p":"Google/ApiCore/Serializer.html#method_decodeMetadata","d":"Decode metadata received from gRPC status object
"},{"t":"M","n":"Google\\ApiCore\\Serializer::decodeAnyMessages","p":"Google/ApiCore/Serializer.html#method_decodeAnyMessages","d":"Decode an array of Any messages into a printable PHP array.
"},{"t":"M","n":"Google\\ApiCore\\Serializer::getGetter","p":"Google/ApiCore/Serializer.html#method_getGetter","d":""},{"t":"M","n":"Google\\ApiCore\\Serializer::getSetter","p":"Google/ApiCore/Serializer.html#method_getSetter","d":""},{"t":"M","n":"Google\\ApiCore\\Serializer::toSnakeCase","p":"Google/ApiCore/Serializer.html#method_toSnakeCase","d":"Convert string from camelCase to snake_case
"},{"t":"M","n":"Google\\ApiCore\\Serializer::toCamelCase","p":"Google/ApiCore/Serializer.html#method_toCamelCase","d":"Convert string from snake_case to camelCase
"},{"t":"M","n":"Google\\ApiCore\\Serializer::loadKnownMetadataTypes","p":"Google/ApiCore/Serializer.html#method_loadKnownMetadataTypes","d":null},{"t":"M","n":"Google\\ApiCore\\ServerStream::__construct","p":"Google/ApiCore/ServerStream.html#method___construct","d":"ServerStream constructor.
"},{"t":"M","n":"Google\\ApiCore\\ServerStream::readAll","p":"Google/ApiCore/ServerStream.html#method_readAll","d":"A generator which yields results from the server until the streaming call\ncompletes. Throws an ApiException if the streaming call failed.
"},{"t":"M","n":"Google\\ApiCore\\ServerStream::getServerStreamingCall","p":"Google/ApiCore/ServerStream.html#method_getServerStreamingCall","d":"Return the underlying call object.
"},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::start","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_start","d":"Start the call.
"},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::responses","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_responses","d":""},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::getStatus","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_getStatus","d":"Return the status of the server stream.
"},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::getMetadata","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_getMetadata","d":""},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::getTrailingMetadata","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_getTrailingMetadata","d":""},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::getPeer","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_getPeer","d":""},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::cancel","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_cancel","d":"Cancels the call.
"},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::setCallCredentials","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_setCallCredentials","d":"Set the CallCredentials for the underlying Call.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\GeneratedTest::assertProtobufEquals","p":"Google/ApiCore/Testing/GeneratedTest.html#method_assertProtobufEquals","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MessageAwareArrayComparator::__construct","p":"Google/ApiCore/Testing/MessageAwareArrayComparator.html#method___construct","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\MessageAwareExporter::shortenedExport","p":"Google/ApiCore/Testing/MessageAwareExporter.html#method_shortenedExport","d":"Exports a value into a single-line string
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockBidiStreamingCall::__construct","p":"Google/ApiCore/Testing/MockBidiStreamingCall.html#method___construct","d":"MockBidiStreamingCall constructor.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockBidiStreamingCall::read","p":"Google/ApiCore/Testing/MockBidiStreamingCall.html#method_read","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockBidiStreamingCall::getStatus","p":"Google/ApiCore/Testing/MockBidiStreamingCall.html#method_getStatus","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockBidiStreamingCall::write","p":"Google/ApiCore/Testing/MockBidiStreamingCall.html#method_write","d":"Save the request object, to be retrieved via getReceivedCalls()
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockBidiStreamingCall::writesDone","p":"Google/ApiCore/Testing/MockBidiStreamingCall.html#method_writesDone","d":"Set writesDone to true
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockBidiStreamingCall::popReceivedCalls","p":"Google/ApiCore/Testing/MockBidiStreamingCall.html#method_popReceivedCalls","d":"Return a list of calls made to write(), and clear $receivedFuncCalls.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockClientStreamingCall::__construct","p":"Google/ApiCore/Testing/MockClientStreamingCall.html#method___construct","d":"MockClientStreamingCall constructor.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockClientStreamingCall::wait","p":"Google/ApiCore/Testing/MockClientStreamingCall.html#method_wait","d":"Immediately return the preset response object and status.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockClientStreamingCall::write","p":"Google/ApiCore/Testing/MockClientStreamingCall.html#method_write","d":"Save the request object, to be retrieved via getReceivedCalls()
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockClientStreamingCall::popReceivedCalls","p":"Google/ApiCore/Testing/MockClientStreamingCall.html#method_popReceivedCalls","d":"Return a list of calls made to write(), and clear $receivedFuncCalls.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockGrpcTransport::__construct","p":"Google/ApiCore/Testing/MockGrpcTransport.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockGrpcTransport::_simpleRequest","p":"Google/ApiCore/Testing/MockGrpcTransport.html#method__simpleRequest","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockGrpcTransport::_clientStreamRequest","p":"Google/ApiCore/Testing/MockGrpcTransport.html#method__clientStreamRequest","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockGrpcTransport::_serverStreamRequest","p":"Google/ApiCore/Testing/MockGrpcTransport.html#method__serverStreamRequest","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockGrpcTransport::_bidiRequest","p":"Google/ApiCore/Testing/MockGrpcTransport.html#method__bidiRequest","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockGrpcTransport::getRequestArguments","p":"Google/ApiCore/Testing/MockGrpcTransport.html#method_getRequestArguments","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\MockRequest::__construct","p":"Google/ApiCore/Testing/MockRequest.html#method___construct","d":"Constructor."},{"t":"M","n":"Google\\ApiCore\\Testing\\MockRequest::getPageToken","p":"Google/ApiCore/Testing/MockRequest.html#method_getPageToken","d":"Generated from protobuf field string page_token = 1;
Generated from protobuf field string page_token = 1;
Generated from protobuf field uint64 page_size = 2;
Generated from protobuf field uint64 page_size = 2;
Generated from protobuf field string name = 1;
Generated from protobuf field string name = 1;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field repeated string repeated_field = 3;
Generated from protobuf field repeated string repeated_field = 3;
Generated from protobuf field .google.apicore.testing.MockRequestBody nested_message = 4;
Generated from protobuf field .google.apicore.testing.MockRequestBody nested_message = 4;
Generated from protobuf field .google.protobuf.BytesValue bytes_value = 5;
Returns the unboxed value from getBytesValue()
Generated from protobuf field .google.protobuf.BytesValue bytes_value = 5;
Sets the field by wrapping a primitive type in a Google\\Protobuf\\BytesValue object.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockRequestBody::getDurationValue","p":"Google/ApiCore/Testing/MockRequestBody.html#method_getDurationValue","d":"Generated from protobuf field .google.protobuf.Duration duration_value = 6;
Generated from protobuf field .google.protobuf.Duration duration_value = 6;
Generated from protobuf field .google.protobuf.FieldMask field_mask = 7;
Generated from protobuf field .google.protobuf.FieldMask field_mask = 7;
Generated from protobuf field .google.protobuf.Int64Value int64_value = 8;
Returns the unboxed value from getInt64Value()
Generated from protobuf field .google.protobuf.Int64Value int64_value = 8;
Sets the field by wrapping a primitive type in a Google\\Protobuf\\Int64Value object.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockRequestBody::getListValue","p":"Google/ApiCore/Testing/MockRequestBody.html#method_getListValue","d":"Generated from protobuf field .google.protobuf.ListValue list_value = 9;
Generated from protobuf field .google.protobuf.ListValue list_value = 9;
Generated from protobuf field .google.protobuf.StringValue string_value = 10;
Returns the unboxed value from getStringValue()
Generated from protobuf field .google.protobuf.StringValue string_value = 10;
Sets the field by wrapping a primitive type in a Google\\Protobuf\\StringValue object.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockRequestBody::getStructValue","p":"Google/ApiCore/Testing/MockRequestBody.html#method_getStructValue","d":"Generated from protobuf field .google.protobuf.Struct struct_value = 11;
Generated from protobuf field .google.protobuf.Struct struct_value = 11;
Generated from protobuf field .google.protobuf.Timestamp timestamp_value = 12;
Generated from protobuf field .google.protobuf.Timestamp timestamp_value = 12;
Generated from protobuf field .google.protobuf.Value value_value = 13;
Generated from protobuf field .google.protobuf.Value value_value = 13;
Generated from protobuf field string field_1 = 14;
Generated from protobuf field string field_1 = 14;
Generated from protobuf field string field_2 = 15;
Generated from protobuf field string field_2 = 15;
Generated from protobuf field string field_3 = 16;
Generated from protobuf field string field_3 = 16;
Generated from protobuf field string name = 1;
Generated from protobuf field string name = 1;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field uint64 number = 2;
Generated from protobuf field repeated string resources_list = 3;
Generated from protobuf field repeated string resources_list = 3;
Generated from protobuf field string next_page_token = 4;
Generated from protobuf field string next_page_token = 4;
Generated from protobuf field map<string, string> resources_map = 5;
Generated from protobuf field map<string, string> resources_map = 5;
MockServerStreamingCall constructor.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockServerStreamingCall::responses","p":"Google/ApiCore/Testing/MockServerStreamingCall.html#method_responses","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\MockServerStreamingCall::getStatus","p":"Google/ApiCore/Testing/MockServerStreamingCall.html#method_getStatus","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStatus::__construct","p":"Google/ApiCore/Testing/MockStatus.html#method___construct","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::__construct","p":"Google/ApiCore/Testing/MockStubTrait.html#method___construct","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::_simpleRequest","p":"Google/ApiCore/Testing/MockStubTrait.html#method__simpleRequest","d":"Overrides the _simpleRequest method in \\Grpc\\BaseStub\n(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php)\nReturns a MockUnaryCall object that will return the first item from $responses
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::_clientStreamRequest","p":"Google/ApiCore/Testing/MockStubTrait.html#method__clientStreamRequest","d":"Overrides the _clientStreamRequest method in \\Grpc\\BaseStub\n(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php)\nReturns a MockClientStreamingCall object that will return the first item from $responses
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::_serverStreamRequest","p":"Google/ApiCore/Testing/MockStubTrait.html#method__serverStreamRequest","d":"Overrides the _serverStreamRequest method in \\Grpc\\BaseStub\n(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php)\nReturns a MockServerStreamingCall object that will stream items from $responses, and return\na final status of $serverStreamingStatus.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::_bidiRequest","p":"Google/ApiCore/Testing/MockStubTrait.html#method__bidiRequest","d":"Overrides the _bidiRequest method in \\Grpc\\BaseStub\n(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php)\nReturns a MockBidiStreamingCall object that will stream items from $responses, and return\na final status of $serverStreamingStatus.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::stripStatusFromResponses","p":"Google/ApiCore/Testing/MockStubTrait.html#method_stripStatusFromResponses","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::addResponse","p":"Google/ApiCore/Testing/MockStubTrait.html#method_addResponse","d":"Add a response object, and an optional status, to the list of responses to be returned via\n_simpleRequest.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::setStreamingStatus","p":"Google/ApiCore/Testing/MockStubTrait.html#method_setStreamingStatus","d":"Set the status object to be used when creating streaming calls.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::popReceivedCalls","p":"Google/ApiCore/Testing/MockStubTrait.html#method_popReceivedCalls","d":"Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::getReceivedCallCount","p":"Google/ApiCore/Testing/MockStubTrait.html#method_getReceivedCallCount","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::popCallObjects","p":"Google/ApiCore/Testing/MockStubTrait.html#method_popCallObjects","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::isExhausted","p":"Google/ApiCore/Testing/MockStubTrait.html#method_isExhausted","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::create","p":"Google/ApiCore/Testing/MockStubTrait.html#method_create","d":""},{"t":"M","n":"Google\\ApiCore\\Testing\\MockStubTrait::createWithResponseSequence","p":"Google/ApiCore/Testing/MockStubTrait.html#method_createWithResponseSequence","d":"Creates a sequence such that the responses are returned in order.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockTransport::setAgentHeaderDescriptor","p":"Google/ApiCore/Testing/MockTransport.html#method_setAgentHeaderDescriptor","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\MockTransport::startUnaryCall","p":"Google/ApiCore/Testing/MockTransport.html#method_startUnaryCall","d":"Returns a promise used to execute network requests.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockTransport::startBidiStreamingCall","p":"Google/ApiCore/Testing/MockTransport.html#method_startBidiStreamingCall","d":"Starts a bidi streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockTransport::startClientStreamingCall","p":"Google/ApiCore/Testing/MockTransport.html#method_startClientStreamingCall","d":"Starts a client streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockTransport::startServerStreamingCall","p":"Google/ApiCore/Testing/MockTransport.html#method_startServerStreamingCall","d":"Starts a server streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockTransport::__call","p":"Google/ApiCore/Testing/MockTransport.html#method___call","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\MockTransport::close","p":"Google/ApiCore/Testing/MockTransport.html#method_close","d":"Closes the connection, if one exists.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockUnaryCall::__construct","p":"Google/ApiCore/Testing/MockUnaryCall.html#method___construct","d":"MockUnaryCall constructor.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\MockUnaryCall::wait","p":"Google/ApiCore/Testing/MockUnaryCall.html#method_wait","d":"Immediately return the preset response object and status.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\ProtobufGPBEmptyComparator::accepts","p":"Google/ApiCore/Testing/ProtobufGPBEmptyComparator.html#method_accepts","d":"Returns whether the comparator can compare two values.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\ProtobufGPBEmptyComparator::assertEquals","p":"Google/ApiCore/Testing/ProtobufGPBEmptyComparator.html#method_assertEquals","d":"Asserts that two values are equal.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\ProtobufMessageComparator::__construct","p":"Google/ApiCore/Testing/ProtobufMessageComparator.html#method___construct","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\ProtobufMessageComparator::accepts","p":"Google/ApiCore/Testing/ProtobufMessageComparator.html#method_accepts","d":"Returns whether the comparator can compare two values.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\ProtobufMessageComparator::assertEquals","p":"Google/ApiCore/Testing/ProtobufMessageComparator.html#method_assertEquals","d":"Asserts that two values are equal.
"},{"t":"M","n":"Google\\ApiCore\\Testing\\ReceivedRequest::__construct","p":"Google/ApiCore/Testing/ReceivedRequest.html#method___construct","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\ReceivedRequest::getArray","p":"Google/ApiCore/Testing/ReceivedRequest.html#method_getArray","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\ReceivedRequest::getFuncCall","p":"Google/ApiCore/Testing/ReceivedRequest.html#method_getFuncCall","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\ReceivedRequest::getRequestObject","p":"Google/ApiCore/Testing/ReceivedRequest.html#method_getRequestObject","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\ReceivedRequest::getMetadata","p":"Google/ApiCore/Testing/ReceivedRequest.html#method_getMetadata","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\ReceivedRequest::getOptions","p":"Google/ApiCore/Testing/ReceivedRequest.html#method_getOptions","d":null},{"t":"M","n":"Google\\ApiCore\\Testing\\SerializationTrait::deserializeMessage","p":"Google/ApiCore/Testing/SerializationTrait.html#method_deserializeMessage","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\GrpcFallbackTransport::__construct","p":"Google/ApiCore/Transport/GrpcFallbackTransport.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\GrpcFallbackTransport::build","p":"Google/ApiCore/Transport/GrpcFallbackTransport.html#method_build","d":"Builds a GrpcFallbackTransport.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\GrpcFallbackTransport::startUnaryCall","p":"Google/ApiCore/Transport/GrpcFallbackTransport.html#method_startUnaryCall","d":"Returns a promise used to execute network requests.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\GrpcTransport::__construct","p":"Google/ApiCore/Transport/GrpcTransport.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\GrpcTransport::build","p":"Google/ApiCore/Transport/GrpcTransport.html#method_build","d":"Builds a GrpcTransport.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\GrpcTransport::startBidiStreamingCall","p":"Google/ApiCore/Transport/GrpcTransport.html#method_startBidiStreamingCall","d":"Starts a bidi streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\GrpcTransport::startClientStreamingCall","p":"Google/ApiCore/Transport/GrpcTransport.html#method_startClientStreamingCall","d":"Starts a client streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\GrpcTransport::startServerStreamingCall","p":"Google/ApiCore/Transport/GrpcTransport.html#method_startServerStreamingCall","d":"Starts a server streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\GrpcTransport::startUnaryCall","p":"Google/ApiCore/Transport/GrpcTransport.html#method_startUnaryCall","d":"Returns a promise used to execute network requests.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ForwardingCall::__construct","p":"Google/ApiCore/Transport/Grpc/ForwardingCall.html#method___construct","d":"ForwardingCall constructor.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ForwardingCall::getMetadata","p":"Google/ApiCore/Transport/Grpc/ForwardingCall.html#method_getMetadata","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ForwardingCall::getTrailingMetadata","p":"Google/ApiCore/Transport/Grpc/ForwardingCall.html#method_getTrailingMetadata","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ForwardingCall::getPeer","p":"Google/ApiCore/Transport/Grpc/ForwardingCall.html#method_getPeer","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ForwardingCall::cancel","p":"Google/ApiCore/Transport/Grpc/ForwardingCall.html#method_cancel","d":"Cancels the call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ForwardingServerStreamingCall::responses","p":"Google/ApiCore/Transport/Grpc/ForwardingServerStreamingCall.html#method_responses","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ForwardingServerStreamingCall::getStatus","p":"Google/ApiCore/Transport/Grpc/ForwardingServerStreamingCall.html#method_getStatus","d":"Wait for the server to send the status, and return it.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ForwardingUnaryCall::wait","p":"Google/ApiCore/Transport/Grpc/ForwardingUnaryCall.html#method_wait","d":"Wait for the server to respond with data and a status.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ServerStreamingCallWrapper::__construct","p":"Google/ApiCore/Transport/Grpc/ServerStreamingCallWrapper.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ServerStreamingCallWrapper::start","p":"Google/ApiCore/Transport/Grpc/ServerStreamingCallWrapper.html#method_start","d":"Start the call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ServerStreamingCallWrapper::responses","p":"Google/ApiCore/Transport/Grpc/ServerStreamingCallWrapper.html#method_responses","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ServerStreamingCallWrapper::getStatus","p":"Google/ApiCore/Transport/Grpc/ServerStreamingCallWrapper.html#method_getStatus","d":"Return the status of the server stream.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ServerStreamingCallWrapper::getMetadata","p":"Google/ApiCore/Transport/Grpc/ServerStreamingCallWrapper.html#method_getMetadata","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ServerStreamingCallWrapper::getTrailingMetadata","p":"Google/ApiCore/Transport/Grpc/ServerStreamingCallWrapper.html#method_getTrailingMetadata","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ServerStreamingCallWrapper::getPeer","p":"Google/ApiCore/Transport/Grpc/ServerStreamingCallWrapper.html#method_getPeer","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ServerStreamingCallWrapper::cancel","p":"Google/ApiCore/Transport/Grpc/ServerStreamingCallWrapper.html#method_cancel","d":"Cancels the call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\ServerStreamingCallWrapper::setCallCredentials","p":"Google/ApiCore/Transport/Grpc/ServerStreamingCallWrapper.html#method_setCallCredentials","d":"Set the CallCredentials for the underlying Call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\UnaryInterceptorInterface::interceptUnaryUnary","p":"Google/ApiCore/Transport/Grpc/UnaryInterceptorInterface.html#method_interceptUnaryUnary","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\HttpUnaryTransportTrait::startClientStreamingCall","p":"Google/ApiCore/Transport/HttpUnaryTransportTrait.html#method_startClientStreamingCall","d":"{@inheritdoc}"},{"t":"M","n":"Google\\ApiCore\\Transport\\HttpUnaryTransportTrait::startServerStreamingCall","p":"Google/ApiCore/Transport/HttpUnaryTransportTrait.html#method_startServerStreamingCall","d":"{@inheritdoc}"},{"t":"M","n":"Google\\ApiCore\\Transport\\HttpUnaryTransportTrait::startBidiStreamingCall","p":"Google/ApiCore/Transport/HttpUnaryTransportTrait.html#method_startBidiStreamingCall","d":"{@inheritdoc}"},{"t":"M","n":"Google\\ApiCore\\Transport\\HttpUnaryTransportTrait::close","p":"Google/ApiCore/Transport/HttpUnaryTransportTrait.html#method_close","d":"{@inheritdoc}"},{"t":"M","n":"Google\\ApiCore\\Transport\\RestTransport::__construct","p":"Google/ApiCore/Transport/RestTransport.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\RestTransport::build","p":"Google/ApiCore/Transport/RestTransport.html#method_build","d":"Builds a RestTransport.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\RestTransport::startUnaryCall","p":"Google/ApiCore/Transport/RestTransport.html#method_startUnaryCall","d":"Returns a promise used to execute network requests.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\RestTransport::startServerStreamingCall","p":"Google/ApiCore/Transport/RestTransport.html#method_startServerStreamingCall","d":"Starts a server streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\JsonStreamDecoder::__construct","p":"Google/ApiCore/Transport/Rest/JsonStreamDecoder.html#method___construct","d":"JsonStreamDecoder is a HTTP-JSON response stream decoder for JSON-ecoded\nprotobuf messages. The response stream must be a JSON array, where the first\nbyte is the opening of the array (i.e. '['), and the last byte is the closing\nof the array (i.e. ']'). Each array item must be a JSON object and comma\nseparated.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\JsonStreamDecoder::decode","p":"Google/ApiCore/Transport/Rest/JsonStreamDecoder.html#method_decode","d":"Begins decoding the configured response stream. It is a generator which\nyields messages of the given decode type from the stream until the stream\ncompletes. Throws an Exception if the stream is closed before the closing\nbyte is read or if it encounters an error while decoding a message.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\JsonStreamDecoder::close","p":"Google/ApiCore/Transport/Rest/JsonStreamDecoder.html#method_close","d":"Closes the underlying stream. If the stream is actively being decoded, an\nexception will not be thrown due to the interruption.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\RestServerStreamingCall::__construct","p":"Google/ApiCore/Transport/Rest/RestServerStreamingCall.html#method___construct","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\RestServerStreamingCall::start","p":"Google/ApiCore/Transport/Rest/RestServerStreamingCall.html#method_start","d":"Start the call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\RestServerStreamingCall::responses","p":"Google/ApiCore/Transport/Rest/RestServerStreamingCall.html#method_responses","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\RestServerStreamingCall::getStatus","p":"Google/ApiCore/Transport/Rest/RestServerStreamingCall.html#method_getStatus","d":"Return the status of the server stream. If the call has not been started\nthis will be null.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\RestServerStreamingCall::getMetadata","p":"Google/ApiCore/Transport/Rest/RestServerStreamingCall.html#method_getMetadata","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\RestServerStreamingCall::getTrailingMetadata","p":"Google/ApiCore/Transport/Rest/RestServerStreamingCall.html#method_getTrailingMetadata","d":"The Rest transport does not support trailing metadata. This is a\npassthrough to getMetadata().
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\RestServerStreamingCall::getPeer","p":"Google/ApiCore/Transport/Rest/RestServerStreamingCall.html#method_getPeer","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\RestServerStreamingCall::cancel","p":"Google/ApiCore/Transport/Rest/RestServerStreamingCall.html#method_cancel","d":"Cancels the call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Rest\\RestServerStreamingCall::setCallCredentials","p":"Google/ApiCore/Transport/Rest/RestServerStreamingCall.html#method_setCallCredentials","d":"For the REST transport this is a no-op.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\TransportInterface::startBidiStreamingCall","p":"Google/ApiCore/Transport/TransportInterface.html#method_startBidiStreamingCall","d":"Starts a bidi streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\TransportInterface::startClientStreamingCall","p":"Google/ApiCore/Transport/TransportInterface.html#method_startClientStreamingCall","d":"Starts a client streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\TransportInterface::startServerStreamingCall","p":"Google/ApiCore/Transport/TransportInterface.html#method_startServerStreamingCall","d":"Starts a server streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\TransportInterface::startUnaryCall","p":"Google/ApiCore/Transport/TransportInterface.html#method_startUnaryCall","d":"Returns a promise used to execute network requests.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\TransportInterface::close","p":"Google/ApiCore/Transport/TransportInterface.html#method_close","d":"Closes the connection, if one exists.
"},{"t":"M","n":"Google\\ApiCore\\UriTrait::buildUriWithQuery","p":"Google/ApiCore/UriTrait.html#method_buildUriWithQuery","d":""},{"t":"M","n":"Google\\ApiCore\\ValidationTrait::validate","p":"Google/ApiCore/ValidationTrait.html#method_validate","d":""},{"t":"M","n":"Google\\ApiCore\\ValidationTrait::validateNotNull","p":"Google/ApiCore/ValidationTrait.html#method_validateNotNull","d":""},{"t":"M","n":"Google\\ApiCore\\Version::getApiCoreVersion","p":"Google/ApiCore/Version.html#method_getApiCoreVersion","d":""},{"t":"M","n":"Google\\ApiCore\\Version::readVersionFile","p":"Google/ApiCore/Version.html#method_readVersionFile","d":"Reads a VERSION file and returns the contents. If the file does not\nexist, returns "".
"},{"t":"M","n":"Google\\ApiCore\\Middleware\\MiddlewareInterface::__invoke","p":"Google/ApiCore/Middleware/MiddlewareInterface.html#method___invoke","d":"Modify or observe the API call request and response.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\ResourceTemplateInterface::__toString","p":"Google/ApiCore/ResourceTemplate/ResourceTemplateInterface.html#method___toString","d":""},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\ResourceTemplateInterface::render","p":"Google/ApiCore/ResourceTemplate/ResourceTemplateInterface.html#method_render","d":"Renders a resource template using the provided bindings.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\ResourceTemplateInterface::matches","p":"Google/ApiCore/ResourceTemplate/ResourceTemplateInterface.html#method_matches","d":"Check if $path matches a resource string.
"},{"t":"M","n":"Google\\ApiCore\\ResourceTemplate\\ResourceTemplateInterface::match","p":"Google/ApiCore/ResourceTemplate/ResourceTemplateInterface.html#method_match","d":"Matches a given $path to a resource template, and returns an array of bindings between\nwildcards / variables in the template and values in the path. If $path does not match the\ntemplate, then a ValidationException is thrown.
"},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::start","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_start","d":"Start the call.
"},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::responses","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_responses","d":""},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::getStatus","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_getStatus","d":"Return the status of the server stream.
"},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::getMetadata","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_getMetadata","d":""},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::getTrailingMetadata","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_getTrailingMetadata","d":""},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::getPeer","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_getPeer","d":""},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::cancel","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_cancel","d":"Cancels the call.
"},{"t":"M","n":"Google\\ApiCore\\ServerStreamingCallInterface::setCallCredentials","p":"Google/ApiCore/ServerStreamingCallInterface.html#method_setCallCredentials","d":"Set the CallCredentials for the underlying Call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\Grpc\\UnaryInterceptorInterface::interceptUnaryUnary","p":"Google/ApiCore/Transport/Grpc/UnaryInterceptorInterface.html#method_interceptUnaryUnary","d":""},{"t":"M","n":"Google\\ApiCore\\Transport\\TransportInterface::startBidiStreamingCall","p":"Google/ApiCore/Transport/TransportInterface.html#method_startBidiStreamingCall","d":"Starts a bidi streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\TransportInterface::startClientStreamingCall","p":"Google/ApiCore/Transport/TransportInterface.html#method_startClientStreamingCall","d":"Starts a client streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\TransportInterface::startServerStreamingCall","p":"Google/ApiCore/Transport/TransportInterface.html#method_startServerStreamingCall","d":"Starts a server streaming call.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\TransportInterface::startUnaryCall","p":"Google/ApiCore/Transport/TransportInterface.html#method_startUnaryCall","d":"Returns a promise used to execute network requests.
"},{"t":"M","n":"Google\\ApiCore\\Transport\\TransportInterface::close","p":"Google/ApiCore/Transport/TransportInterface.html#method_close","d":"Closes the connection, if one exists.
"},{"t":"N","n":"Google","p":"Google.html"},{"t":"N","n":"Google\\ApiCore","p":"Google/ApiCore.html"},{"t":"N","n":"Google\\ApiCore\\Middleware","p":"Google/ApiCore/Middleware.html"},{"t":"N","n":"Google\\ApiCore\\Options","p":"Google/ApiCore/Options.html"},{"t":"N","n":"Google\\ApiCore\\Options\\TransportOptions","p":"Google/ApiCore/Options/TransportOptions.html"},{"t":"N","n":"Google\\ApiCore\\ResourceTemplate","p":"Google/ApiCore/ResourceTemplate.html"},{"t":"N","n":"Google\\ApiCore\\Testing","p":"Google/ApiCore/Testing.html"},{"t":"N","n":"Google\\ApiCore\\Transport","p":"Google/ApiCore/Transport.html"},{"t":"N","n":"Google\\ApiCore\\Transport\\Grpc","p":"Google/ApiCore/Transport/Grpc.html"},{"t":"N","n":"Google\\ApiCore\\Transport\\Rest","p":"Google/ApiCore/Transport/Rest.html"}]} diff --git a/v1.34.1/doctum.js b/v1.34.1/doctum.js new file mode 100644 index 000000000..412cdcae2 --- /dev/null +++ b/v1.34.1/doctum.js @@ -0,0 +1,319 @@ +var Doctum = { + treeJson: {"tree":{"l":0,"n":"","p":"","c":[{"l":1,"n":"Google","p":"Google","c":[{"l":2,"n":"ApiCore","p":"Google/ApiCore","c":[{"l":3,"n":"Middleware","p":"Google/ApiCore/Middleware","c":[{"l":4,"n":"CredentialsWrapperMiddleware","p":"Google/ApiCore/Middleware/CredentialsWrapperMiddleware"},{"l":4,"n":"FixedHeaderMiddleware","p":"Google/ApiCore/Middleware/FixedHeaderMiddleware"},{"l":4,"n":"MiddlewareInterface","p":"Google/ApiCore/Middleware/MiddlewareInterface"},{"l":4,"n":"OperationsMiddleware","p":"Google/ApiCore/Middleware/OperationsMiddleware"},{"l":4,"n":"OptionsFilterMiddleware","p":"Google/ApiCore/Middleware/OptionsFilterMiddleware"},{"l":4,"n":"PagedMiddleware","p":"Google/ApiCore/Middleware/PagedMiddleware"},{"l":4,"n":"RequestAutoPopulationMiddleware","p":"Google/ApiCore/Middleware/RequestAutoPopulationMiddleware"},{"l":4,"n":"ResponseMetadataMiddleware","p":"Google/ApiCore/Middleware/ResponseMetadataMiddleware"},{"l":4,"n":"RetryMiddleware","p":"Google/ApiCore/Middleware/RetryMiddleware"}]},{"l":3,"n":"Options","p":"Google/ApiCore/Options","c":[{"l":4,"n":"TransportOptions","p":"Google/ApiCore/Options/TransportOptions","c":[{"l":5,"n":"GrpcFallbackTransportOptions","p":"Google/ApiCore/Options/TransportOptions/GrpcFallbackTransportOptions"},{"l":5,"n":"GrpcTransportOptions","p":"Google/ApiCore/Options/TransportOptions/GrpcTransportOptions"},{"l":5,"n":"RestTransportOptions","p":"Google/ApiCore/Options/TransportOptions/RestTransportOptions"}]},{"l":4,"n":"CallOptions","p":"Google/ApiCore/Options/CallOptions"},{"l":4,"n":"ClientOptions","p":"Google/ApiCore/Options/ClientOptions"},{"l":4,"n":"OptionsTrait","p":"Google/ApiCore/Options/OptionsTrait"},{"l":4,"n":"TransportOptions","p":"Google/ApiCore/Options/TransportOptions"}]},{"l":3,"n":"ResourceTemplate","p":"Google/ApiCore/ResourceTemplate","c":[{"l":4,"n":"AbsoluteResourceTemplate","p":"Google/ApiCore/ResourceTemplate/AbsoluteResourceTemplate"},{"l":4,"n":"Parser","p":"Google/ApiCore/ResourceTemplate/Parser"},{"l":4,"n":"RelativeResourceTemplate","p":"Google/ApiCore/ResourceTemplate/RelativeResourceTemplate"},{"l":4,"n":"ResourceTemplateInterface","p":"Google/ApiCore/ResourceTemplate/ResourceTemplateInterface"},{"l":4,"n":"Segment","p":"Google/ApiCore/ResourceTemplate/Segment"}]},{"l":3,"n":"Testing","p":"Google/ApiCore/Testing","c":[{"l":4,"n":"GeneratedTest","p":"Google/ApiCore/Testing/GeneratedTest"},{"l":4,"n":"MessageAwareArrayComparator","p":"Google/ApiCore/Testing/MessageAwareArrayComparator"},{"l":4,"n":"MessageAwareExporter","p":"Google/ApiCore/Testing/MessageAwareExporter"},{"l":4,"n":"MockBidiStreamingCall","p":"Google/ApiCore/Testing/MockBidiStreamingCall"},{"l":4,"n":"MockClientStreamingCall","p":"Google/ApiCore/Testing/MockClientStreamingCall"},{"l":4,"n":"MockGrpcTransport","p":"Google/ApiCore/Testing/MockGrpcTransport"},{"l":4,"n":"MockRequest","p":"Google/ApiCore/Testing/MockRequest"},{"l":4,"n":"MockRequestBody","p":"Google/ApiCore/Testing/MockRequestBody"},{"l":4,"n":"MockResponse","p":"Google/ApiCore/Testing/MockResponse"},{"l":4,"n":"MockServerStreamingCall","p":"Google/ApiCore/Testing/MockServerStreamingCall"},{"l":4,"n":"MockStatus","p":"Google/ApiCore/Testing/MockStatus"},{"l":4,"n":"MockStubTrait","p":"Google/ApiCore/Testing/MockStubTrait"},{"l":4,"n":"MockTransport","p":"Google/ApiCore/Testing/MockTransport"},{"l":4,"n":"MockUnaryCall","p":"Google/ApiCore/Testing/MockUnaryCall"},{"l":4,"n":"ProtobufGPBEmptyComparator","p":"Google/ApiCore/Testing/ProtobufGPBEmptyComparator"},{"l":4,"n":"ProtobufMessageComparator","p":"Google/ApiCore/Testing/ProtobufMessageComparator"},{"l":4,"n":"ReceivedRequest","p":"Google/ApiCore/Testing/ReceivedRequest"},{"l":4,"n":"SerializationTrait","p":"Google/ApiCore/Testing/SerializationTrait"}]},{"l":3,"n":"Transport","p":"Google/ApiCore/Transport","c":[{"l":4,"n":"Grpc","p":"Google/ApiCore/Transport/Grpc","c":[{"l":5,"n":"ForwardingCall","p":"Google/ApiCore/Transport/Grpc/ForwardingCall"},{"l":5,"n":"ForwardingServerStreamingCall","p":"Google/ApiCore/Transport/Grpc/ForwardingServerStreamingCall"},{"l":5,"n":"ForwardingUnaryCall","p":"Google/ApiCore/Transport/Grpc/ForwardingUnaryCall"},{"l":5,"n":"ServerStreamingCallWrapper","p":"Google/ApiCore/Transport/Grpc/ServerStreamingCallWrapper"},{"l":5,"n":"UnaryInterceptorInterface","p":"Google/ApiCore/Transport/Grpc/UnaryInterceptorInterface"}]},{"l":4,"n":"Rest","p":"Google/ApiCore/Transport/Rest","c":[{"l":5,"n":"JsonStreamDecoder","p":"Google/ApiCore/Transport/Rest/JsonStreamDecoder"},{"l":5,"n":"RestServerStreamingCall","p":"Google/ApiCore/Transport/Rest/RestServerStreamingCall"}]},{"l":4,"n":"GrpcFallbackTransport","p":"Google/ApiCore/Transport/GrpcFallbackTransport"},{"l":4,"n":"GrpcTransport","p":"Google/ApiCore/Transport/GrpcTransport"},{"l":4,"n":"HttpUnaryTransportTrait","p":"Google/ApiCore/Transport/HttpUnaryTransportTrait"},{"l":4,"n":"RestTransport","p":"Google/ApiCore/Transport/RestTransport"},{"l":4,"n":"TransportInterface","p":"Google/ApiCore/Transport/TransportInterface"}]},{"l":3,"n":"AgentHeader","p":"Google/ApiCore/AgentHeader"},{"l":3,"n":"ApiException","p":"Google/ApiCore/ApiException"},{"l":3,"n":"ApiStatus","p":"Google/ApiCore/ApiStatus"},{"l":3,"n":"ArrayTrait","p":"Google/ApiCore/ArrayTrait"},{"l":3,"n":"BidiStream","p":"Google/ApiCore/BidiStream"},{"l":3,"n":"Call","p":"Google/ApiCore/Call"},{"l":3,"n":"ClientOptionsTrait","p":"Google/ApiCore/ClientOptionsTrait"},{"l":3,"n":"ClientStream","p":"Google/ApiCore/ClientStream"},{"l":3,"n":"CredentialsWrapper","p":"Google/ApiCore/CredentialsWrapper"},{"l":3,"n":"FixedSizeCollection","p":"Google/ApiCore/FixedSizeCollection"},{"l":3,"n":"GPBLabel","p":"Google/ApiCore/GPBLabel"},{"l":3,"n":"GPBType","p":"Google/ApiCore/GPBType"},{"l":3,"n":"GapicClientTrait","p":"Google/ApiCore/GapicClientTrait"},{"l":3,"n":"GrpcSupportTrait","p":"Google/ApiCore/GrpcSupportTrait"},{"l":3,"n":"InsecureCredentialsWrapper","p":"Google/ApiCore/InsecureCredentialsWrapper"},{"l":3,"n":"OperationResponse","p":"Google/ApiCore/OperationResponse"},{"l":3,"n":"Page","p":"Google/ApiCore/Page"},{"l":3,"n":"PageStreamingDescriptor","p":"Google/ApiCore/PageStreamingDescriptor"},{"l":3,"n":"PagedListResponse","p":"Google/ApiCore/PagedListResponse"},{"l":3,"n":"PathTemplate","p":"Google/ApiCore/PathTemplate"},{"l":3,"n":"PollingTrait","p":"Google/ApiCore/PollingTrait"},{"l":3,"n":"RequestBuilder","p":"Google/ApiCore/RequestBuilder"},{"l":3,"n":"RequestParamsHeaderDescriptor","p":"Google/ApiCore/RequestParamsHeaderDescriptor"},{"l":3,"n":"ResourceHelperTrait","p":"Google/ApiCore/ResourceHelperTrait"},{"l":3,"n":"RetrySettings","p":"Google/ApiCore/RetrySettings"},{"l":3,"n":"Serializer","p":"Google/ApiCore/Serializer"},{"l":3,"n":"ServerStream","p":"Google/ApiCore/ServerStream"},{"l":3,"n":"ServerStreamingCallInterface","p":"Google/ApiCore/ServerStreamingCallInterface"},{"l":3,"n":"ServiceAddressTrait","p":"Google/ApiCore/ServiceAddressTrait"},{"l":3,"n":"UriTrait","p":"Google/ApiCore/UriTrait"},{"l":3,"n":"ValidationException","p":"Google/ApiCore/ValidationException"},{"l":3,"n":"ValidationTrait","p":"Google/ApiCore/ValidationTrait"},{"l":3,"n":"Version","p":"Google/ApiCore/Version"}]}]}]},"treeOpenLevel":1}, + /** @var boolean */ + treeLoaded: false, + /** @var boolean */ + listenersRegistered: false, + autoCompleteData: null, + /** @var boolean */ + autoCompleteLoading: false, + /** @var boolean */ + autoCompleteLoaded: false, + /** @var string|null */ + rootPath: null, + /** @var string|null */ + autoCompleteDataUrl: null, + /** @var HTMLElement|null */ + doctumSearchAutoComplete: null, + /** @var HTMLElement|null */ + doctumSearchAutoCompleteProgressBarContainer: null, + /** @var HTMLElement|null */ + doctumSearchAutoCompleteProgressBar: null, + /** @var number */ + doctumSearchAutoCompleteProgressBarPercent: 0, + /** @var autoComplete|null */ + autoCompleteJS: null, + querySearchSecurityRegex: /([^0-9a-zA-Z:\\\\_\s])/gi, + buildTreeNode: function (treeNode, htmlNode, treeOpenLevel) { + var ulNode = document.createElement('ul'); + for (var childKey in treeNode.c) { + var child = treeNode.c[childKey]; + var liClass = document.createElement('li'); + var hasChildren = child.hasOwnProperty('c'); + var nodeSpecialName = (hasChildren ? 'namespace:' : 'class:') + child.p.replace(/\//g, '_'); + liClass.setAttribute('data-name', nodeSpecialName); + + // Create the node that will have the text + var divHd = document.createElement('div'); + var levelCss = child.l - 1; + divHd.className = hasChildren ? 'hd' : 'hd leaf'; + divHd.style.paddingLeft = (hasChildren ? (levelCss * 18) : (8 + (levelCss * 18))) + 'px'; + if (hasChildren) { + if (child.l <= treeOpenLevel) { + liClass.className = 'opened'; + } + var spanIcon = document.createElement('span'); + spanIcon.className = 'icon icon-play'; + divHd.appendChild(spanIcon); + } + var aLink = document.createElement('a'); + + // Edit the HTML link to work correctly based on the current depth + aLink.href = Doctum.rootPath + child.p + '.html'; + aLink.innerText = child.n; + divHd.appendChild(aLink); + liClass.appendChild(divHd); + + // It has children + if (hasChildren) { + var divBd = document.createElement('div'); + divBd.className = 'bd'; + Doctum.buildTreeNode(child, divBd, treeOpenLevel); + liClass.appendChild(divBd); + } + ulNode.appendChild(liClass); + } + htmlNode.appendChild(ulNode); + }, + initListeners: function () { + if (Doctum.listenersRegistered) { + // Quick exit, already registered + return; + } + Doctum.listenersRegistered = true; + }, + loadTree: function () { + if (Doctum.treeLoaded) { + // Quick exit, already registered + return; + } + Doctum.rootPath = document.body.getAttribute('data-root-path'); + Doctum.buildTreeNode(Doctum.treeJson.tree, document.getElementById('api-tree'), Doctum.treeJson.treeOpenLevel); + + // Toggle left-nav divs on click + $('#api-tree .hd span').on('click', function () { + $(this).parent().parent().toggleClass('opened'); + }); + + // Expand the parent namespaces of the current page. + var expected = $('body').attr('data-name'); + + if (expected) { + // Open the currently selected node and its parents. + var container = $('#api-tree'); + var node = $('#api-tree li[data-name="' + expected + '"]'); + // Node might not be found when simulating namespaces + if (node.length > 0) { + node.addClass('active').addClass('opened'); + node.parents('li').addClass('opened'); + var scrollPos = node.offset().top - container.offset().top + container.scrollTop(); + // Position the item nearer to the top of the screen. + scrollPos -= 200; + container.scrollTop(scrollPos); + } + } + Doctum.treeLoaded = true; + }, + pagePartiallyLoaded: function (event) { + Doctum.initListeners(); + Doctum.loadTree(); + Doctum.loadAutoComplete(); + }, + pageFullyLoaded: function (event) { + // it may not have received DOMContentLoaded event + Doctum.initListeners(); + Doctum.loadTree(); + Doctum.loadAutoComplete(); + // Fire the event in the search page too + if (typeof DoctumSearch === 'object') { + DoctumSearch.pageFullyLoaded(); + } + }, + loadAutoComplete: function () { + if (Doctum.autoCompleteLoaded) { + // Quick exit, already loaded + return; + } + Doctum.autoCompleteDataUrl = document.body.getAttribute('data-search-index-url'); + Doctum.doctumSearchAutoComplete = document.getElementById('doctum-search-auto-complete'); + Doctum.doctumSearchAutoCompleteProgressBarContainer = document.getElementById('search-progress-bar-container'); + Doctum.doctumSearchAutoCompleteProgressBar = document.getElementById('search-progress-bar'); + if (Doctum.doctumSearchAutoComplete !== null) { + // Wait for it to be loaded + Doctum.doctumSearchAutoComplete.addEventListener('init', function (_) { + Doctum.autoCompleteLoaded = true; + Doctum.doctumSearchAutoComplete.addEventListener('selection', function (event) { + // Go to selection page + window.location = Doctum.rootPath + event.detail.selection.value.p; + }); + Doctum.doctumSearchAutoComplete.addEventListener('navigate', function (event) { + // Set selection in text box + if (typeof event.detail.selection.value === 'object') { + Doctum.doctumSearchAutoComplete.value = event.detail.selection.value.n; + } + }); + Doctum.doctumSearchAutoComplete.addEventListener('results', function (event) { + Doctum.markProgressFinished(); + }); + }); + } + // Check if the lib is loaded + if (typeof autoComplete === 'function') { + Doctum.bootAutoComplete(); + } + }, + markInProgress: function () { + Doctum.doctumSearchAutoCompleteProgressBarContainer.className = 'search-bar'; + Doctum.doctumSearchAutoCompleteProgressBar.className = 'progress-bar indeterminate'; + if (typeof DoctumSearch === 'object' && DoctumSearch.pageFullyLoaded) { + DoctumSearch.doctumSearchPageAutoCompleteProgressBarContainer.className = 'search-bar'; + DoctumSearch.doctumSearchPageAutoCompleteProgressBar.className = 'progress-bar indeterminate'; + } + }, + markProgressFinished: function () { + Doctum.doctumSearchAutoCompleteProgressBarContainer.className = 'search-bar hidden'; + Doctum.doctumSearchAutoCompleteProgressBar.className = 'progress-bar'; + if (typeof DoctumSearch === 'object' && DoctumSearch.pageFullyLoaded) { + DoctumSearch.doctumSearchPageAutoCompleteProgressBarContainer.className = 'search-bar hidden'; + DoctumSearch.doctumSearchPageAutoCompleteProgressBar.className = 'progress-bar'; + } + }, + makeProgess: function () { + Doctum.makeProgressOnProgressBar( + Doctum.doctumSearchAutoCompleteProgressBarPercent, + Doctum.doctumSearchAutoCompleteProgressBar + ); + if (typeof DoctumSearch === 'object' && DoctumSearch.pageFullyLoaded) { + Doctum.makeProgressOnProgressBar( + Doctum.doctumSearchAutoCompleteProgressBarPercent, + DoctumSearch.doctumSearchPageAutoCompleteProgressBar + ); + } + }, + loadAutoCompleteData: function (query) { + return new Promise(function (resolve, reject) { + if (Doctum.autoCompleteData !== null) { + resolve(Doctum.autoCompleteData); + return; + } + Doctum.markInProgress(); + function reqListener() { + Doctum.autoCompleteLoading = false; + Doctum.autoCompleteData = JSON.parse(this.responseText).items; + Doctum.markProgressFinished(); + + setTimeout(function () { + resolve(Doctum.autoCompleteData); + }, 50);// Let the UI render once before sending the results for processing. This gives time to the progress bar to hide + } + function reqError(err) { + Doctum.autoCompleteLoading = false; + Doctum.autoCompleteData = null; + console.error(err); + reject(err); + } + + var oReq = new XMLHttpRequest(); + oReq.onload = reqListener; + oReq.onerror = reqError; + oReq.onprogress = function (pe) { + if (pe.lengthComputable) { + Doctum.doctumSearchAutoCompleteProgressBarPercent = parseInt(pe.loaded / pe.total * 100, 10); + Doctum.makeProgess(); + } + }; + oReq.onloadend = function (_) { + Doctum.markProgressFinished(); + }; + oReq.open('get', Doctum.autoCompleteDataUrl, true); + oReq.send(); + }); + }, + /** + * Make some progress on a progress bar + * + * @param number percentage + * @param HTMLElement progressBar + * @return void + */ + makeProgressOnProgressBar: function(percentage, progressBar) { + progressBar.className = 'progress-bar'; + progressBar.style.width = percentage + '%'; + progressBar.setAttribute( + 'aria-valuenow', percentage + ); + }, + searchEngine: function (query, record) { + if (typeof query !== 'string') { + return ''; + } + // replace all (mode = g) spaces and non breaking spaces (\s) by pipes + // g = global mode to mark also the second word searched + // i = case insensitive + // how this function works: + // First: search if the query has the keywords in sequence + // Second: replace the keywords by a mark and leave all the text in between non marked + + if (record.match(new RegExp('(' + query.replace(/\s/g, ').*(') + ')', 'gi')) === null) { + return '';// Does not match + } + + var replacedRecord = record.replace(new RegExp('(' + query.replace(/\s/g, '|') + ')', 'gi'), function (group) { + return '' + group + ''; + }); + + if (replacedRecord !== record) { + return replacedRecord;// This should not happen but just in case there was no match done + } + + return ''; + }, + /** + * Clean the search query + * + * @param string|null query + * @return string + */ + cleanSearchQuery: function (query) { + if (typeof query !== 'string') { + return ''; + } + // replace any chars that could lead to injecting code in our regex + // remove start or end spaces + // replace backslashes by an escaped version, use case in search: \myRootFunction + return query.replace(Doctum.querySearchSecurityRegex, '').trim().replace(/\\/g, '\\\\'); + }, + bootAutoComplete: function () { + Doctum.autoCompleteJS = new autoComplete( + { + selector: '#doctum-search-auto-complete', + searchEngine: function (query, record) { + return Doctum.searchEngine(query, record); + }, + submit: true, + data: { + src: function (q) { + Doctum.markInProgress(); + return Doctum.loadAutoCompleteData(q); + }, + keys: ['n'],// Data 'Object' key to be searched + cache: false, // Is not compatible with async fetch of data + }, + query: (input) => { + return Doctum.cleanSearchQuery(input); + }, + trigger: (query) => { + return Doctum.cleanSearchQuery(query).length > 0; + }, + resultsList: { + tag: 'ul', + class: 'auto-complete-dropdown-menu', + destination: '#auto-complete-results', + position: 'afterbegin', + maxResults: 500, + noResults: false, + }, + resultItem: { + tag: 'li', + class: 'auto-complete-result', + highlight: 'auto-complete-highlight', + selected: 'auto-complete-selected' + }, + } + ); + } +}; + + +document.addEventListener('DOMContentLoaded', Doctum.pagePartiallyLoaded, false); +window.addEventListener('load', Doctum.pageFullyLoaded, false); diff --git a/v1.34.1/fonts/doctum-font.css b/v1.34.1/fonts/doctum-font.css new file mode 100644 index 000000000..d022b4c34 --- /dev/null +++ b/v1.34.1/fonts/doctum-font.css @@ -0,0 +1,61 @@ +@font-face { + font-family: "doctum"; + src: url("./doctum.eot?39101248"); + src: url("./doctum.eot?39101248#iefix") format("embedded-opentype"), + url("./doctum.woff2?39101248") format("woff2"), url("./doctum.woff?39101248") format("woff"), + url("./doctum.ttf?39101248") format("truetype"), url("./doctum.svg?39101248#doctum") format("svg"); + font-weight: normal; + font-style: normal; +} +/* Chrome hack: SVG is rendered more smooth in Windozze. 100% magic, uncomment if you need it. */ +/* Note, that will break hinting! In other OS-es font will be not as sharp as it could be */ +/* +@media screen and (-webkit-min-device-pixel-ratio:0) { + @font-face { + font-family: 'doctum'; + src: url('./doctum.svg?39101248#doctum') format('svg'); + } +} +*/ + +.icon { + font-family: "doctum"; + font-style: normal; + font-weight: normal; + speak: never; + + display: inline-block; + text-decoration: inherit; + width: 1em; + margin-right: 0.2em; + text-align: center; + /* opacity: .8; */ + + /* For safety - reset parent styles, that can break glyph codes*/ + font-variant: normal; + text-transform: none; + + /* fix buttons height, for twitter bootstrap */ + line-height: 1em; + + /* Animation center compensation - margins should be symmetric */ + /* remove if not needed */ + margin-left: 0.2em; + + /* you can be more comfortable with increased icons size */ + /* font-size: 120%; */ + + /* Font smoothing. That was taken from TWBS */ + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + + /* Uncomment for 3D effect */ + /* text-shadow: 1px 1px 1px rgba(127, 127, 127, 0.3); */ +} + +.icon-search:before { + content: "\e800"; +} /* '' */ +.icon-play:before { + content: "\e801"; +} /* '' */ diff --git a/v1.34.1/fonts/doctum.eot b/v1.34.1/fonts/doctum.eot new file mode 100644 index 000000000..0daf464c7 Binary files /dev/null and b/v1.34.1/fonts/doctum.eot differ diff --git a/v1.34.1/fonts/doctum.svg b/v1.34.1/fonts/doctum.svg new file mode 100644 index 000000000..341469b6c --- /dev/null +++ b/v1.34.1/fonts/doctum.svg @@ -0,0 +1,14 @@ + + + \ No newline at end of file diff --git a/v1.34.1/fonts/doctum.ttf b/v1.34.1/fonts/doctum.ttf new file mode 100644 index 000000000..cf3f81625 Binary files /dev/null and b/v1.34.1/fonts/doctum.ttf differ diff --git a/v1.34.1/fonts/doctum.woff b/v1.34.1/fonts/doctum.woff new file mode 100644 index 000000000..6e1ca3b57 Binary files /dev/null and b/v1.34.1/fonts/doctum.woff differ diff --git a/v1.34.1/fonts/doctum.woff2 b/v1.34.1/fonts/doctum.woff2 new file mode 100644 index 000000000..e7b1a3e81 Binary files /dev/null and b/v1.34.1/fonts/doctum.woff2 differ diff --git a/v1.34.1/index.html b/v1.34.1/index.html new file mode 100644 index 000000000..274d542be --- /dev/null +++ b/v1.34.1/index.html @@ -0,0 +1,102 @@ + + + + + +Middlewares must take a MiddlewareInterface as their first constructor
+argument {Google\ApiCore\Middleware\ResponseMetadataMiddleware}, which
+represents the next middleware in the chain. This next middleware MUST be
+invoked by this MiddlewareInterface, and the result must be returned as part
+of the __invoke method implementation.
Represents a resource template that may or may not contain a leading slash, and if a leading
+slash is present may contain a trailing verb (":
Temporary class to support an interceptor-like interface until gRPC interceptor support is +available.
This page allows you to search through the API documentation for + specific terms. Enter your search words into the box below and click + "submit". The search will be performed on namespaces, classes, interfaces, + traits, functions, and methods.
+ + + +Provides basic array helper methods.
+Common functions used to work with various clients.
+Common functions used to work with various clients.
+Provides helper methods for gRPC support.
+Trait implemented by any class representing an associative array of PHP options.
+Provides functionality for loading a resource name template map from a descriptor config, +retrieving a PathTemplate, and parsing values using registered templates.
+Provides helper methods for service address handling.
+The MockStubTrait is used by generated mock stub classes which extent \Grpc\BaseStub +(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) +It provides functionality to add responses, get received calls, and overrides the _simpleRequest +method so that the elements of $responses are returned instead of making a call to the API.
+A trait for shared functionality between transports that support only unary RPCs using simple +HTTP requests.
+Provides a light wrapper around often used URI related functions.
+