Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Refresh GAPIC documentation #677

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Dlp/V2beta1/Gapic/DlpServiceGapicClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,7 @@ public function redactContent($inspectConfig, $items, $replaceConfigs, $optional
* is not set.
* }
*
* @return \Google\Longrunning\Operation
* @return \Google\GAX\OperationResponse
*
* @throws \Google\GAX\ApiException if the remote call fails
* @experimental
Expand Down
17 changes: 7 additions & 10 deletions src/Logging/V2/Gapic/ConfigServiceV2GapicClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -575,13 +575,10 @@ public function createSink($parent, $sink, $optionalArgs = [])
}

/**
* Updates a sink. If the named sink doesn't exist, then this method is
* identical to
* [sinks.create](https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create).
* If the named sink does exist, then this method replaces the following
* fields in the existing sink with values from the new sink: `destination`,
* `filter`, `output_version_format`, `start_time`, and `end_time`.
* The updated filter might also have a new `writer_identity`; see the
* Updates a sink. This method replaces the following fields in the existing
* sink with values from the new sink: `destination`, `filter`,
* `output_version_format`, `start_time`, and `end_time`.
* The updated sink might also have a new `writer_identity`; see the
* `unique_writer_identity` field.
*
* Sample code:
Expand All @@ -606,8 +603,7 @@ public function createSink($parent, $sink, $optionalArgs = [])
*
* Example: `"projects/my-project-id/sinks/my-sink-id"`.
* @param LogSink $sink Required. The updated sink, whose name is the same identifier that appears
* as part of `sink_name`. If `sink_name` does not exist, then
* this method creates a new sink.
* as part of `sink_name`.
* @param array $optionalArgs {
* Optional.
*
Expand All @@ -622,7 +618,8 @@ public function createSink($parent, $sink, $optionalArgs = [])
* then there is no change to the sink's `writer_identity`.
* + If the old value is false and the new value is true, then
* `writer_identity` is changed to a unique service account.
* + It is an error if the old value is true and the new value is false.
* + It is an error if the old value is true and the new value is
* set to false or defaulted to false.
* @type \Google\GAX\RetrySettings $retrySettings
* Retry settings to use for this call. If present, then
* $timeoutMillis is ignored.
Expand Down
36 changes: 24 additions & 12 deletions src/Logging/V2/Gapic/LoggingServiceV2GapicClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,13 @@ public function deleteLog($logName, $optionalArgs = [])
}

/**
* Writes log entries to Stackdriver Logging.
* ## Log entry resources.
*
* Writes log entries to Stackdriver Logging. This API method is the
* only way to send log entries to Stackdriver Logging. This method
* is used, directly or indirectly, by the Stackdriver Logging agent
* (fluentd) and all logging libraries configured to use Stackdriver
* Logging.
*
* Sample code:
* ```
Expand All @@ -435,21 +441,27 @@ public function deleteLog($logName, $optionalArgs = [])
* }
* ```
*
* @param LogEntry[] $entries Required. The log entries to write. Values supplied for the fields
* `log_name`, `resource`, and `labels` in this `entries.write` request are
* inserted into those log entries in this list that do not provide their own
* values.
* @param LogEntry[] $entries Required. The log entries to send to Stackdriver Logging. The order of log
* entries in this list does not matter. Values supplied in this method's
* `log_name`, `resource`, and `labels` fields are copied into those log
* entries in this list that do not include values for their corresponding
* fields. For more information, see the [LogEntry][google.logging.v2.LogEntry] type.
*
* If the `timestamp` or `insert_id` fields are missing in log entries, then
* this method supplies the current time or a unique identifier, respectively.
* The supplied values are chosen so that, among the log entries that did not
* supply their own values, the entries earlier in the list will sort before
* the entries later in the list. See the `entries.list` method.
*
* Stackdriver Logging also creates and inserts values for `timestamp` and
* `insert_id` if the entries do not provide them. The created `insert_id` for
* the N'th entry in this list will be greater than earlier entries and less
* than later entries. Otherwise, the order of log entries in this list does
* not matter.
* Log entries with timestamps that are more than the
* [logs retention period](https://cloud.google.com/logging/quota-policy) in the past or more than
* 24 hours in the future might be discarded. Discarding does not return
* an error.
*
* To improve throughput and to avoid exceeding the
* [quota limit](https://cloud.google.com/logging/quota-policy) for calls to `entries.write`,
* you should write multiple log entries at once rather than
* calling this method for each individual log entry.
* you should try to include several log entries in this list,
* rather than calling this method for each individual log entry.
* @param array $optionalArgs {
* Optional.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ public function listDatabases($parent, $optionalArgs = [])
* is not set.
* }
*
* @return \Google\Longrunning\Operation
* @return \Google\GAX\OperationResponse
*
* @throws \Google\GAX\ApiException if the remote call fails
* @experimental
Expand Down Expand Up @@ -768,7 +768,7 @@ public function getDatabase($name, $optionalArgs = [])
* is not set.
* }
*
* @return \Google\Longrunning\Operation
* @return \Google\GAX\OperationResponse
*
* @throws \Google\GAX\ApiException if the remote call fails
* @experimental
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -895,7 +895,7 @@ public function getInstance($name, $optionalArgs = [])
* is not set.
* }
*
* @return \Google\Longrunning\Operation
* @return \Google\GAX\OperationResponse
*
* @throws \Google\GAX\ApiException if the remote call fails
* @experimental
Expand Down Expand Up @@ -1019,7 +1019,7 @@ public function createInstance($parent, $instanceId, $instance, $optionalArgs =
* is not set.
* }
*
* @return \Google\Longrunning\Operation
* @return \Google\GAX\OperationResponse
*
* @throws \Google\GAX\ApiException if the remote call fails
* @experimental
Expand Down
2 changes: 1 addition & 1 deletion src/Speech/V1/Gapic/SpeechGapicClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ public function recognize($config, $audio, $optionalArgs = [])
* is not set.
* }
*
* @return \Google\Longrunning\Operation
* @return \Google\GAX\OperationResponse
*
* @throws \Google\GAX\ApiException if the remote call fails
* @experimental
Expand Down
2 changes: 1 addition & 1 deletion src/Speech/V1beta1/Gapic/SpeechGapicClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@ public function syncRecognize($config, $audio, $optionalArgs = [])
* is not set.
* }
*
* @return \Google\Longrunning\Operation
* @return \Google\GAX\OperationResponse
*
* @throws \Google\GAX\ApiException if the remote call fails
* @experimental
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ public function __construct($options = [])
* is not set.
* }
*
* @return \Google\Longrunning\Operation
* @return \Google\GAX\OperationResponse
*
* @throws \Google\GAX\ApiException if the remote call fails
* @experimental
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ public function __construct($options = [])
* is not set.
* }
*
* @return \Google\Longrunning\Operation
* @return \Google\GAX\OperationResponse
*
* @throws \Google\GAX\ApiException if the remote call fails
* @experimental
Expand Down