Skip to content

Commit

Permalink
docs: Specify client retry behavior and rename Stackdriver Logging to…
Browse files Browse the repository at this point in the history
… Cloud Logging

PiperOrigin-RevId: 320016414

Source-Author: Google APIs <noreply@google.com>
Source-Date: Tue Jul 7 10:52:01 2020 -0700
Source-Repo: googleapis/googleapis
Source-Sha: aba9760d6abc15f724753c26d6f306e0f76dd11a
Source-Link: googleapis/googleapis@aba9760
  • Loading branch information
yoshi-automation committed Jul 8, 2020
1 parent 6aa3a82 commit 98e71af
Show file tree
Hide file tree
Showing 10 changed files with 330 additions and 275 deletions.

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions apis/Google.Cloud.Logging.V2/Google.Cloud.Logging.V2/LogEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -249,11 +249,11 @@ public sealed partial class LogEntry : pb::IMessage<LogEntry> {
/// current time. Timestamps have nanosecond accuracy, but trailing zeros in
/// the fractional seconds might be omitted when the timestamp is displayed.
///
/// Incoming log entries should have timestamps that are no more than the [logs
/// retention period](https://cloud.google.com/logging/quotas) in the past, and no more than 24 hours
/// in the future. Log entries outside those time boundaries will not be
/// available when calling `entries.list`, but those log entries can still be
/// [exported with LogSinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
/// Incoming log entries must have timestamps that don't exceed the
/// [logs retention
/// period](https://cloud.google.com/logging/quotas#logs_retention_periods) in
/// the past, and that don't exceed 24 hours in the future. Log entries outside
/// those time boundaries aren't ingested by Logging.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
public global::Google.Protobuf.WellKnownTypes.Timestamp Timestamp {
Expand Down
169 changes: 86 additions & 83 deletions apis/Google.Cloud.Logging.V2/Google.Cloud.Logging.V2/Logging.cs

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -708,7 +708,8 @@ public sealed partial class LogSink : pb::IMessage<LogSink> {
/// The sink's `writer_identity`, set when the sink is created, must
/// have permission to write to the destination or else the log
/// entries are not exported. For more information, see
/// [Exporting Logs with Sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
/// [Exporting Logs with
/// Sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
public string Destination {
Expand All @@ -722,9 +723,10 @@ public sealed partial class LogSink : pb::IMessage<LogSink> {
public const int FilterFieldNumber = 5;
private string filter_ = "";
/// <summary>
/// Optional. An [advanced logs filter](https://cloud.google.com/logging/docs/view/advanced-queries). The only
/// exported log entries are those that are in the resource owning the sink and
/// that match the filter. For example:
/// Optional. An [advanced logs
/// filter](https://cloud.google.com/logging/docs/view/advanced-queries). The
/// only exported log entries are those that are in the resource owning the
/// sink and that match the filter. For example:
///
/// logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
/// </summary>
Expand Down Expand Up @@ -770,8 +772,7 @@ public sealed partial class LogSink : pb::IMessage<LogSink> {
public const int OutputVersionFormatFieldNumber = 6;
private global::Google.Cloud.Logging.V2.LogSink.Types.VersionFormat outputVersionFormat_ = global::Google.Cloud.Logging.V2.LogSink.Types.VersionFormat.Unspecified;
/// <summary>
/// Deprecated. The log entry format to use for this sink's exported log
/// entries. The v2 format is used by default and cannot be changed.
/// Deprecated. This field is unused.
/// </summary>
[global::System.ObsoleteAttribute]
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
Expand Down Expand Up @@ -1169,9 +1170,7 @@ public enum OptionsOneofCase {
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
public static partial class Types {
/// <summary>
/// Available log entry formats. Log entries can be written to
/// Logging in either format and can be exported in either format.
/// Version 2 is the preferred format.
/// Deprecated. This is unused.
/// </summary>
public enum VersionFormat {
/// <summary>
Expand Down Expand Up @@ -1236,12 +1235,13 @@ public sealed partial class BigQueryOptions : pb::IMessage<BigQueryOptions> {
private bool usePartitionedTables_;
/// <summary>
/// Optional. Whether to use [BigQuery's partition
/// tables](https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Logging
/// creates dated tables based on the log entries' timestamps, e.g.
/// syslog_20170523. With partitioned tables the date suffix is no longer
/// tables](https://cloud.google.com/bigquery/docs/partitioned-tables). By
/// default, Logging creates dated tables based on the log entries' timestamps,
/// e.g. syslog_20170523. With partitioned tables the date suffix is no longer
/// present and [special query
/// syntax](https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead.
/// In both cases, tables are sharded based on UTC timezone.
/// syntax](https://cloud.google.com/bigquery/docs/querying-partitioned-tables)
/// has to be used instead. In both cases, tables are sharded based on UTC
/// timezone.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
public bool UsePartitionedTables {
Expand Down Expand Up @@ -3337,9 +3337,10 @@ public sealed partial class LogExclusion : pb::IMessage<LogExclusion> {
public const int FilterFieldNumber = 3;
private string filter_ = "";
/// <summary>
/// Required. An [advanced logs filter](https://cloud.google.com/logging/docs/view/advanced-queries)
/// that matches the log entries to be excluded. By using the
/// [sample function](https://cloud.google.com/logging/docs/view/advanced-queries#sample),
/// Required. An [advanced logs
/// filter](https://cloud.google.com/logging/docs/view/advanced-queries) that
/// matches the log entries to be excluded. By using the [sample
/// function](https://cloud.google.com/logging/docs/view/advanced-queries#sample),
/// you can exclude less than 100% of the matching log entries.
/// For example, the following query matches 99% of low-severity log
/// entries from Google Cloud Storage buckets:
Expand Down Expand Up @@ -4637,8 +4638,9 @@ public sealed partial class DeleteExclusionRequest : pb::IMessage<DeleteExclusio
/// The parameters to
/// [GetCmekSettings][google.logging.v2.ConfigServiceV2.GetCmekSettings].
///
/// See [Enabling CMEK for Logs Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for
/// more information.
/// </summary>
public sealed partial class GetCmekSettingsRequest : pb::IMessage<GetCmekSettingsRequest> {
private static readonly pb::MessageParser<GetCmekSettingsRequest> _parser = new pb::MessageParser<GetCmekSettingsRequest>(() => new GetCmekSettingsRequest());
Expand Down Expand Up @@ -4787,8 +4789,9 @@ public sealed partial class GetCmekSettingsRequest : pb::IMessage<GetCmekSetting
/// The parameters to
/// [UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings].
///
/// See [Enabling CMEK for Logs Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for
/// more information.
/// </summary>
public sealed partial class UpdateCmekSettingsRequest : pb::IMessage<UpdateCmekSettingsRequest> {
private static readonly pb::MessageParser<UpdateCmekSettingsRequest> _parser = new pb::MessageParser<UpdateCmekSettingsRequest>(() => new UpdateCmekSettingsRequest());
Expand Down Expand Up @@ -4858,7 +4861,8 @@ public sealed partial class UpdateCmekSettingsRequest : pb::IMessage<UpdateCmekS
/// Required. The CMEK settings to update.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
public global::Google.Cloud.Logging.V2.CmekSettings CmekSettings {
Expand Down Expand Up @@ -5024,8 +5028,9 @@ public sealed partial class UpdateCmekSettingsRequest : pb::IMessage<UpdateCmekS
/// organizations. Once configured, it applies to all projects and folders in the
/// GCP organization.
///
/// See [Enabling CMEK for Logs Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for
/// more information.
/// </summary>
public sealed partial class CmekSettings : pb::IMessage<CmekSettings> {
private static readonly pb::MessageParser<CmekSettings> _parser = new pb::MessageParser<CmekSettings>(() => new CmekSettings());
Expand Down Expand Up @@ -5102,7 +5107,8 @@ public sealed partial class CmekSettings : pb::IMessage<CmekSettings> {
/// To disable CMEK for the Logs Router, set this field to an empty string.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
public string KmsKeyName {
Expand All @@ -5126,7 +5132,8 @@ public sealed partial class CmekSettings : pb::IMessage<CmekSettings> {
/// obtain the service account ID.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
public string ServiceAccountId {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,8 @@ public abstract partial class ConfigServiceV2Base
/// the GCP organization.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
/// <param name="request">The request received from the client.</param>
/// <param name="context">The context of the server-side call handler being invoked.</param>
Expand All @@ -364,7 +365,8 @@ public abstract partial class ConfigServiceV2Base
/// 3) access to the key is disabled.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
/// <param name="request">The request received from the client.</param>
/// <param name="context">The context of the server-side call handler being invoked.</param>
Expand Down Expand Up @@ -1059,7 +1061,8 @@ protected ConfigServiceV2Client(ClientBaseConfiguration configuration) : base(co
/// the GCP organization.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="headers">The initial metadata to send with the call. This parameter is optional.</param>
Expand All @@ -1078,7 +1081,8 @@ protected ConfigServiceV2Client(ClientBaseConfiguration configuration) : base(co
/// the GCP organization.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="options">The options for the call.</param>
Expand All @@ -1095,7 +1099,8 @@ protected ConfigServiceV2Client(ClientBaseConfiguration configuration) : base(co
/// the GCP organization.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="headers">The initial metadata to send with the call. This parameter is optional.</param>
Expand All @@ -1114,7 +1119,8 @@ protected ConfigServiceV2Client(ClientBaseConfiguration configuration) : base(co
/// the GCP organization.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="options">The options for the call.</param>
Expand All @@ -1137,7 +1143,8 @@ protected ConfigServiceV2Client(ClientBaseConfiguration configuration) : base(co
/// 3) access to the key is disabled.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="headers">The initial metadata to send with the call. This parameter is optional.</param>
Expand All @@ -1162,7 +1169,8 @@ protected ConfigServiceV2Client(ClientBaseConfiguration configuration) : base(co
/// 3) access to the key is disabled.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="options">The options for the call.</param>
Expand All @@ -1185,7 +1193,8 @@ protected ConfigServiceV2Client(ClientBaseConfiguration configuration) : base(co
/// 3) access to the key is disabled.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="headers">The initial metadata to send with the call. This parameter is optional.</param>
Expand All @@ -1210,7 +1219,8 @@ protected ConfigServiceV2Client(ClientBaseConfiguration configuration) : base(co
/// 3) access to the key is disabled.
///
/// See [Enabling CMEK for Logs
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
/// Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
/// for more information.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="options">The options for the call.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,8 @@ public abstract partial class LoggingServiceV2Base
/// <summary>
/// Lists log entries. Use this method to retrieve log entries that originated
/// from a project/folder/organization/billing account. For ways to export log
/// entries, see [Exporting Logs](https://cloud.google.com/logging/docs/export).
/// entries, see [Exporting
/// Logs](https://cloud.google.com/logging/docs/export).
/// </summary>
/// <param name="request">The request received from the client.</param>
/// <param name="context">The context of the server-side call handler being invoked.</param>
Expand Down Expand Up @@ -305,7 +306,8 @@ protected LoggingServiceV2Client(ClientBaseConfiguration configuration) : base(c
/// <summary>
/// Lists log entries. Use this method to retrieve log entries that originated
/// from a project/folder/organization/billing account. For ways to export log
/// entries, see [Exporting Logs](https://cloud.google.com/logging/docs/export).
/// entries, see [Exporting
/// Logs](https://cloud.google.com/logging/docs/export).
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="headers">The initial metadata to send with the call. This parameter is optional.</param>
Expand All @@ -319,7 +321,8 @@ protected LoggingServiceV2Client(ClientBaseConfiguration configuration) : base(c
/// <summary>
/// Lists log entries. Use this method to retrieve log entries that originated
/// from a project/folder/organization/billing account. For ways to export log
/// entries, see [Exporting Logs](https://cloud.google.com/logging/docs/export).
/// entries, see [Exporting
/// Logs](https://cloud.google.com/logging/docs/export).
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="options">The options for the call.</param>
Expand All @@ -331,7 +334,8 @@ protected LoggingServiceV2Client(ClientBaseConfiguration configuration) : base(c
/// <summary>
/// Lists log entries. Use this method to retrieve log entries that originated
/// from a project/folder/organization/billing account. For ways to export log
/// entries, see [Exporting Logs](https://cloud.google.com/logging/docs/export).
/// entries, see [Exporting
/// Logs](https://cloud.google.com/logging/docs/export).
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="headers">The initial metadata to send with the call. This parameter is optional.</param>
Expand All @@ -345,7 +349,8 @@ protected LoggingServiceV2Client(ClientBaseConfiguration configuration) : base(c
/// <summary>
/// Lists log entries. Use this method to retrieve log entries that originated
/// from a project/folder/organization/billing account. For ways to export log
/// entries, see [Exporting Logs](https://cloud.google.com/logging/docs/export).
/// entries, see [Exporting
/// Logs](https://cloud.google.com/logging/docs/export).
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="options">The options for the call.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,9 @@ public sealed partial class LogMetric : pb::IMessage<LogMetric> {
public const int FilterFieldNumber = 3;
private string filter_ = "";
/// <summary>
/// Required. An [advanced logs filter](https://cloud.google.com/logging/docs/view/advanced_filters) which is
/// used to match log entries.
/// Example:
/// Required. An [advanced logs
/// filter](https://cloud.google.com/logging/docs/view/advanced_filters) which
/// is used to match log entries. Example:
///
/// "resource.type=gae_app AND severity>=ERROR"
///
Expand Down
Loading

0 comments on commit 98e71af

Please sign in to comment.