Skip to content

Commit

Permalink
use correct type in documentation for keyFile (#297)
Browse files Browse the repository at this point in the history 
* use correct type in documentation for keyFile

* add an example
  • Loading branch information
@dwsupplee @jdpedrie
dwsupplee authored and jdpedrie committed Dec 28, 2016
1 parent 1bf3f1c commit 4e9840b
Show file tree
Hide file tree
Showing 11 changed files with 33 additions and 33 deletions.
6 changes: 3 additions & 3 deletions src/BigQuery/BigQueryClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ class BigQueryClient
* requests specifically for authentication.
* @type callable $httpHandler A handler used to deliver Psr7 requests.
* Only valid for requests sent over REST.
* @type string $keyFile The contents of the service account
* credentials .json file retrieved from the Google Developers
* Console.
* @type array $keyFile The contents of the service account credentials
* .json file retrieved from the Google Developer's Console.
* Ex: `json_decode(file_get_contents($path), true)`.
* @type string $keyFilePath The full path to your service account
* credentials .json file retrieved from the Google Developers
* Console.
Expand Down
6 changes: 3 additions & 3 deletions src/Datastore/DatastoreClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,9 @@ class DatastoreClient
* requests specifically for authentication.
* @type callable $httpHandler A handler used to deliver Psr7 requests.
* Only valid for requests sent over REST.
* @type string $keyFile The contents of the service account
* credentials .json file retrieved from the Google Developers
* Console.
* @type array $keyFile The contents of the service account credentials
* .json file retrieved from the Google Developer's Console.
* Ex: `json_decode(file_get_contents($path), true)`.
* @type string $keyFilePath The full path to your service account
* credentials .json file retrieved from the Google Developers
* Console.
Expand Down
6 changes: 3 additions & 3 deletions src/Logging/LoggingClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ class LoggingClient
* requests specifically for authentication.
* @type callable $httpHandler A handler used to deliver Psr7 requests.
* Only valid for requests sent over REST.
* @type string $keyFile The contents of the service account
* credentials .json file retrieved from the Google Developers
* Console.
* @type array $keyFile The contents of the service account credentials
* .json file retrieved from the Google Developer's Console.
* Ex: `json_decode(file_get_contents($path), true)`.
* @type string $keyFilePath The full path to your service account
* credentials .json file retrieved from the Google Developers
* Console.
Expand Down
6 changes: 3 additions & 3 deletions src/NaturalLanguage/NaturalLanguageClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ class NaturalLanguageClient
* requests specifically for authentication.
* @type callable $httpHandler A handler used to deliver Psr7 requests.
* Only valid for requests sent over REST.
* @type string $keyFile The contents of the service account
* credentials .json file retrieved from the Google Developers
* Console.
* @type array $keyFile The contents of the service account credentials
* .json file retrieved from the Google Developer's Console.
* Ex: `json_decode(file_get_contents($path), true)`.
* @type string $keyFilePath The full path to your service account
* credentials .json file retrieved from the Google Developers
* Console.
Expand Down
6 changes: 3 additions & 3 deletions src/PubSub/PubSubClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,9 @@ class PubSubClient
* requests specifically for authentication.
* @type callable $httpHandler A handler used to deliver Psr7 requests.
* Only valid for requests sent over REST.
* @type string $keyFile The contents of the service account
* credentials .json file retrieved from the Google Developers
* Console.
* @type array $keyFile The contents of the service account credentials
* .json file retrieved from the Google Developer's Console.
* Ex: `json_decode(file_get_contents($path), true)`.
* @type string $keyFilePath The full path to your service account
* credentials .json file retrieved from the Google Developers
* Console.
Expand Down
6 changes: 3 additions & 3 deletions src/RequestWrapperTrait.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ trait RequestWrapperTrait
* @type array $authCacheOptions Cache configuration options.
* @type FetchAuthTokenInterface $credentialsFetcher A credentials
* fetcher instance.
* @type string $keyFile The contents of the service account
* credentials .json file retrieved from the Google Developers
* Console.
* @type array $keyFile The contents of the service account credentials
* .json file retrieved from the Google Developer's Console.
* Ex: `json_decode(file_get_contents($path), true)`.
* @type int $retries Number of retries for a failed request.
* **Defaults to** `3`.
* @type array $scopes Scopes to be used for the request.
Expand Down
6 changes: 3 additions & 3 deletions src/ServiceBuilder.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ class ServiceBuilder
* requests specifically for authentication.
* @type callable $httpHandler A handler used to deliver Psr7 requests.
* Only valid for requests sent over REST.
* @type string $keyFile The contents of the service account
* credentials .json file retrieved from the Google Developer's
* Console.
* @type array $keyFile The contents of the service account credentials
* .json file retrieved from the Google Developer's Console.
* Ex: `json_decode(file_get_contents($path), true)`.
* @type string $keyFilePath The full path to your service account
* credentials .json file retrieved from the Google Developers
* Console.
Expand Down
6 changes: 3 additions & 3 deletions src/Speech/SpeechClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ class SpeechClient
* requests specifically for authentication.
* @type callable $httpHandler A handler used to deliver Psr7 requests.
* Only valid for requests sent over REST.
* @type string $keyFile The contents of the service account
* credentials .json file retrieved from the Google Developers
* Console.
* @type array $keyFile The contents of the service account credentials
* .json file retrieved from the Google Developer's Console.
* Ex: `json_decode(file_get_contents($path), true)`.
* @type string $keyFilePath The full path to your service account
* credentials .json file retrieved from the Google Developers
* Console.
Expand Down
6 changes: 3 additions & 3 deletions src/Storage/StorageClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ class StorageClient
* requests specifically for authentication.
* @type callable $httpHandler A handler used to deliver Psr7 requests.
* Only valid for requests sent over REST.
* @type string $keyFile The contents of the service account
* credentials .json file retrieved from the Google Developers
* Console.
* @type array $keyFile The contents of the service account credentials
* .json file retrieved from the Google Developer's Console.
* Ex: `json_decode(file_get_contents($path), true)`.
* @type string $keyFilePath The full path to your service account
* credentials .json file retrieved from the Google Developers
* Console.
Expand Down
6 changes: 3 additions & 3 deletions src/Translate/TranslateClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ class TranslateClient
* requests specifically for authentication.
* @type callable $httpHandler A handler used to deliver Psr7 requests.
* Only valid for requests sent over REST.
* @type string $keyFile The contents of the service account
* credentials .json file retrieved from the Google Developers
* Console.
* @type array $keyFile The contents of the service account credentials
* .json file retrieved from the Google Developer's Console.
* Ex: `json_decode(file_get_contents($path), true)`.
* @type string $keyFilePath The full path to your service account
* credentials .json file retrieved from the Google Developers
* Console.
Expand Down
6 changes: 3 additions & 3 deletions src/Vision/VisionClient.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ class VisionClient
* @type callable $authHttpHandler A handler used to deliver Psr7
* requests specifically for authentication.
* @type callable $httpHandler A handler used to deliver Psr7 requests.
* @type string $keyFile The contents of the service account
* credentials .json file retrieved from the Google Developers
* Console.
* @type array $keyFile The contents of the service account credentials
* .json file retrieved from the Google Developer's Console.
* Ex: `json_decode(file_get_contents($path), true)`.
* @type string $keyFilePath The full path to your service account
* credentials .json file retrieved from the Google Developers
* Console.
Expand Down

0 comments on commit 4e9840b

Please sign in to comment.