google-cloud-logging 1.2.3 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. checksums.yaml +5 -5
  2. data/lib/google-cloud-logging.rb +13 -10
  3. data/lib/google/cloud/logging.rb +41 -17
  4. data/lib/google/cloud/logging/async_writer.rb +5 -2
  5. data/lib/google/cloud/logging/credentials.rb +31 -15
  6. data/lib/google/cloud/logging/entry.rb +13 -0
  7. data/lib/google/cloud/logging/entry/http_request.rb +35 -12
  8. data/lib/google/cloud/logging/logger.rb +14 -0
  9. data/lib/google/cloud/logging/middleware.rb +1 -1
  10. data/lib/google/cloud/logging/project.rb +55 -8
  11. data/lib/google/cloud/logging/rails.rb +1 -1
  12. data/lib/google/cloud/logging/service.rb +8 -27
  13. data/lib/google/cloud/logging/v2/config_service_v2_client.rb +360 -93
  14. data/lib/google/cloud/logging/v2/config_service_v2_client_config.json +43 -8
  15. data/lib/google/cloud/logging/v2/doc/google/api/distribution.rb +172 -0
  16. data/lib/google/cloud/logging/v2/doc/google/api/metric.rb +187 -0
  17. data/lib/google/cloud/logging/v2/doc/google/api/monitored_resource.rb +4 -4
  18. data/lib/google/cloud/logging/v2/doc/google/logging/type/http_request.rb +4 -1
  19. data/lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb +13 -6
  20. data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb +55 -21
  21. data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb +185 -23
  22. data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb +89 -5
  23. data/lib/google/cloud/logging/v2/doc/google/protobuf/any.rb +12 -2
  24. data/lib/google/cloud/logging/v2/doc/google/protobuf/duration.rb +14 -1
  25. data/lib/google/cloud/logging/v2/doc/google/protobuf/field_mask.rb +223 -0
  26. data/lib/google/cloud/logging/v2/doc/google/protobuf/timestamp.rb +26 -1
  27. data/lib/google/cloud/logging/v2/doc/overview.rb +67 -0
  28. data/lib/google/cloud/logging/v2/logging_service_v2_client.rb +116 -91
  29. data/lib/google/cloud/logging/v2/logging_service_v2_client_config.json +12 -11
  30. data/lib/google/cloud/logging/v2/metrics_service_v2_client.rb +87 -76
  31. data/lib/google/cloud/logging/v2/metrics_service_v2_client_config.json +9 -8
  32. data/lib/google/cloud/logging/version.rb +1 -1
  33. metadata +11 -7
@@ -53,7 +53,7 @@ module Google
53
53
  # @!attribute [rw] referer
54
54
  # @return [String]
55
55
  # The referer URL of the request, as defined in
56
- # {HTTP/1.1 Header Field Definitions}[http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html].
56
+ # [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
57
57
  # @!attribute [rw] latency
58
58
  # @return [Google::Protobuf::Duration]
59
59
  # The request processing latency on the server, from the time the request was
@@ -74,6 +74,9 @@ module Google
74
74
  # @return [Integer]
75
75
  # The number of HTTP response bytes inserted into cache. Set only when a
76
76
  # cache fill was attempted.
77
+ # @!attribute [rw] protocol
78
+ # @return [String]
79
+ # Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
77
80
  class HttpRequest; end
78
81
  end
79
82
  end
@@ -56,11 +56,18 @@ module Google
56
56
  # expressed as a JSON object.
57
57
  # @!attribute [rw] timestamp
58
58
  # @return [Google::Protobuf::Timestamp]
59
- # Optional. The time the event described by the log entry occurred. If
60
- # omitted in a new log entry, Stackdriver Logging will insert the time the
61
- # log entry is received. Stackdriver Logging might reject log entries whose
62
- # time stamps are more than a couple of hours in the future. Log entries
63
- # with time stamps in the past are accepted.
59
+ # Optional. The time the event described by the log entry occurred.
60
+ # This time is used to compute the log entry's age and to enforce
61
+ # the logs retention period. If this field is omitted in a new log
62
+ # entry, then Stackdriver Logging assigns it the current time.
63
+ #
64
+ # Incoming log entries should have timestamps that are no more than
65
+ # the [logs retention period](https://cloud.google.com/logging/quota-policy) in the past,
66
+ # and no more than 24 hours in the future.
67
+ # See the +entries.write+ API method for more information.
68
+ # @!attribute [rw] receive_timestamp
69
+ # @return [Google::Protobuf::Timestamp]
70
+ # Output only. The time the log entry was received by Stackdriver Logging.
64
71
  # @!attribute [rw] severity
65
72
  # @return [Google::Logging::Type::LogSeverity]
66
73
  # Optional. The severity of the log entry. The default value is
@@ -71,7 +78,7 @@ module Google
71
78
  # then Stackdriver Logging considers other log entries in the same project,
72
79
  # with the same +timestamp+, and with the same +insert_id+ to be duplicates
73
80
  # which can be removed. If omitted in new log entries, then Stackdriver
74
- # Logging will insert its own unique identifier. The +insert_id+ is used
81
+ # Logging assigns its own unique identifier. The +insert_id+ is also used
75
82
  # to order log entries that have the same +timestamp+ value.
76
83
  # @!attribute [rw] http_request
77
84
  # @return [Google::Logging::Type::HttpRequest]
@@ -14,6 +14,21 @@
14
14
 
15
15
  module Google
16
16
  module Logging
17
+ ##
18
+ # # Stackdriver Logging API Contents
19
+ #
20
+ # | Class | Description |
21
+ # | ----- | ----------- |
22
+ # | [LoggingServiceV2Client][] | The Stackdriver Logging API lets you write log entries and manage your logs, log sinks and logs-based metrics. |
23
+ # | [ConfigServiceV2Client][] | The Stackdriver Logging API lets you write log entries and manage your logs, log sinks and logs-based metrics. |
24
+ # | [MetricsServiceV2Client][] | The Stackdriver Logging API lets you write log entries and manage your logs, log sinks and logs-based metrics. |
25
+ # | [Data Types][] | Data types for Google::Cloud::Logging::V2 |
26
+ #
27
+ # [LoggingServiceV2Client]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/logging/v2/loggingservicev2client
28
+ # [ConfigServiceV2Client]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/logging/v2/configservicev2client
29
+ # [MetricsServiceV2Client]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/logging/v2/metricsservicev2client
30
+ # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/logging/v2/datatypes
31
+ #
17
32
  module V2
18
33
  # The parameters to DeleteLog.
19
34
  # @!attribute [rw] log_name
@@ -26,10 +41,10 @@ module Google
26
41
  # "folders/[FOLDER_ID]/logs/[LOG_ID]"
27
42
  #
28
43
  # +[LOG_ID]+ must be URL-encoded. For example,
29
- # +"projects/my-project-id/logs/syslog"+,
44
+ # +"projects/my-project/logs/syslog"+,
30
45
  # +"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"+.
31
46
  # For more information about log names, see
32
- # LogEntry.
47
+ # {Google::Logging::V2::LogEntry LogEntry}.
33
48
  class DeleteLogRequest; end
34
49
 
35
50
  # The parameters to WriteLogEntries.
@@ -44,10 +59,10 @@ module Google
44
59
  # "folders/[FOLDER_ID]/logs/[LOG_ID]"
45
60
  #
46
61
  # +[LOG_ID]+ must be URL-encoded. For example,
47
- # +"projects/my-project-id/logs/syslog"+ or
62
+ # +"projects/my-project/logs/syslog"+ or
48
63
  # +"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"+.
49
64
  # For more information about log names, see
50
- # LogEntry.
65
+ # {Google::Logging::V2::LogEntry LogEntry}.
51
66
  # @!attribute [rw] resource
52
67
  # @return [Google::Api::MonitoredResource]
53
68
  # Optional. A default monitored resource object that is assigned to all log
@@ -57,30 +72,36 @@ module Google
57
72
  # "labels": {
58
73
  # "zone": "us-central1-a", "instance_id": "00000000000000000000" }}
59
74
  #
60
- # See LogEntry.
75
+ # See {Google::Logging::V2::LogEntry LogEntry}.
61
76
  # @!attribute [rw] labels
62
77
  # @return [Hash{String => String}]
63
78
  # Optional. Default labels that are added to the +labels+ field of all log
64
79
  # entries in +entries+. If a log entry already has a label with the same key
65
80
  # as a label in this parameter, then the log entry's label is not changed.
66
- # See LogEntry.
81
+ # See {Google::Logging::V2::LogEntry LogEntry}.
67
82
  # @!attribute [rw] entries
68
83
  # @return [Array<Google::Logging::V2::LogEntry>]
69
- # Required. The log entries to write. Values supplied for the fields
70
- # +log_name+, +resource+, and +labels+ in this +entries.write+ request are
71
- # inserted into those log entries in this list that do not provide their own
72
- # values.
84
+ # Required. The log entries to send to Stackdriver Logging. The order of log
85
+ # entries in this list does not matter. Values supplied in this method's
86
+ # +log_name+, +resource+, and +labels+ fields are copied into those log
87
+ # entries in this list that do not include values for their corresponding
88
+ # fields. For more information, see the {Google::Logging::V2::LogEntry LogEntry} type.
73
89
  #
74
- # Stackdriver Logging also creates and inserts values for +timestamp+ and
75
- # +insert_id+ if the entries do not provide them. The created +insert_id+ for
76
- # the N'th entry in this list will be greater than earlier entries and less
77
- # than later entries. Otherwise, the order of log entries in this list does
78
- # not matter.
90
+ # If the +timestamp+ or +insert_id+ fields are missing in log entries, then
91
+ # this method supplies the current time or a unique identifier, respectively.
92
+ # The supplied values are chosen so that, among the log entries that did not
93
+ # supply their own values, the entries earlier in the list will sort before
94
+ # the entries later in the list. See the +entries.list+ method.
95
+ #
96
+ # Log entries with timestamps that are more than the
97
+ # [logs retention period](https://cloud.google.com/logging/quota-policy) in the past or more than
98
+ # 24 hours in the future might be discarded. Discarding does not return
99
+ # an error.
79
100
  #
80
101
  # To improve throughput and to avoid exceeding the
81
- # {quota limit}[https://cloud.google.com/logging/quota-policy] for calls to +entries.write+,
82
- # you should write multiple log entries at once rather than
83
- # calling this method for each individual log entry.
102
+ # [quota limit](https://cloud.google.com/logging/quota-policy) for calls to +entries.write+,
103
+ # you should try to include several log entries in this list,
104
+ # rather than calling this method for each individual log entry.
84
105
  # @!attribute [rw] partial_success
85
106
  # @return [true, false]
86
107
  # Optional. Whether valid entries should be written even if some other
@@ -94,6 +115,17 @@ module Google
94
115
  # empty
95
116
  class WriteLogEntriesResponse; end
96
117
 
118
+ # Error details for WriteLogEntries with partial success.
119
+ # @!attribute [rw] log_entry_errors
120
+ # @return [Hash{Integer => Google::Rpc::Status}]
121
+ # When +WriteLogEntriesRequest.partial_success+ is true, records the error
122
+ # status for entries that were not written due to a permanent error, keyed
123
+ # by the entry's zero-based index in +WriteLogEntriesRequest.entries+.
124
+ #
125
+ # Failed requests for which no entries are written will not include
126
+ # per-entry errors.
127
+ class WriteLogEntriesPartialErrors; end
128
+
97
129
  # The parameters to +ListLogEntries+.
98
130
  # @!attribute [rw] project_ids
99
131
  # @return [Array<String>]
@@ -115,8 +147,8 @@ module Google
115
147
  # Projects listed in the +project_ids+ field are added to this list.
116
148
  # @!attribute [rw] filter
117
149
  # @return [String]
118
- # Optional. A filter that chooses which log entries to return. See {Advanced
119
- # Logs Filters}[https://cloud.google.com/logging/docs/view/advanced_filters]. Only log entries that
150
+ # Optional. A filter that chooses which log entries to return. See [Advanced
151
+ # Logs Filters](/logging/docs/view/advanced_filters). Only log entries that
120
152
  # match the filter are returned. An empty filter matches all log entries in
121
153
  # the resources listed in +resource_names+. Referencing a parent resource
122
154
  # that is not listed in +resource_names+ will cause the filter to return no
@@ -146,7 +178,9 @@ module Google
146
178
  # Result returned from +ListLogEntries+.
147
179
  # @!attribute [rw] entries
148
180
  # @return [Array<Google::Logging::V2::LogEntry>]
149
- # A list of log entries.
181
+ # A list of log entries. If +entries+ is empty, +nextPageToken+ may still be
182
+ # returned, indicating that more entries may exist. See +nextPageToken+ for
183
+ # more information.
150
184
  # @!attribute [rw] next_page_token
151
185
  # @return [String]
152
186
  # If there might be more results than those appearing in this response, then
@@ -14,6 +14,21 @@
14
14
 
15
15
  module Google
16
16
  module Logging
17
+ ##
18
+ # # Stackdriver Logging API Contents
19
+ #
20
+ # | Class | Description |
21
+ # | ----- | ----------- |
22
+ # | [LoggingServiceV2Client][] | The Stackdriver Logging API lets you write log entries and manage your logs, log sinks and logs-based metrics. |
23
+ # | [ConfigServiceV2Client][] | The Stackdriver Logging API lets you write log entries and manage your logs, log sinks and logs-based metrics. |
24
+ # | [MetricsServiceV2Client][] | The Stackdriver Logging API lets you write log entries and manage your logs, log sinks and logs-based metrics. |
25
+ # | [Data Types][] | Data types for Google::Cloud::Logging::V2 |
26
+ #
27
+ # [LoggingServiceV2Client]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/logging/v2/loggingservicev2client
28
+ # [ConfigServiceV2Client]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/logging/v2/configservicev2client
29
+ # [MetricsServiceV2Client]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/logging/v2/metricsservicev2client
30
+ # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/logging/v2/datatypes
31
+ #
17
32
  module V2
18
33
  # Describes a sink used to export log entries to one of the following
19
34
  # destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a
@@ -38,11 +53,11 @@ module Google
38
53
  # The sink's +writer_identity+, set when the sink is created, must
39
54
  # have permission to write to the destination or else the log
40
55
  # entries are not exported. For more information, see
41
- # {Exporting Logs With Sinks}[https://cloud.google.com/logging/docs/api/tasks/exporting-logs].
56
+ # [Exporting Logs With Sinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
42
57
  # @!attribute [rw] filter
43
58
  # @return [String]
44
59
  # Optional.
45
- # An {advanced logs filter}[https://cloud.google.com/logging/docs/view/advanced_filters]. The only
60
+ # An [advanced logs filter](https://cloud.google.com/logging/docs/view/advanced_filters). The only
46
61
  # exported log entries are those that are in the resource owning the sink and
47
62
  # that match the filter. The filter must use the log entry format specified
48
63
  # by the +output_version_format+ parameter. For example, in the v2 format:
@@ -50,27 +65,39 @@ module Google
50
65
  # logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
51
66
  # @!attribute [rw] output_version_format
52
67
  # @return [Google::Logging::V2::LogSink::VersionFormat]
53
- # Optional. The log entry format to use for this sink's exported log
54
- # entries. The v2 format is used by default.
55
- # **The v1 format is deprecated** and should be used only as part of a
56
- # migration effort to v2.
57
- # See {Migration to the v2 API}[https://cloud.google.com/logging/docs/api/v2/migration-to-v2].
68
+ # Deprecated. The log entry format to use for this sink's exported log
69
+ # entries. The v2 format is used by default and cannot be changed.
58
70
  # @!attribute [rw] writer_identity
59
71
  # @return [String]
60
72
  # Output only. An IAM identity&mdash;a service account or group&mdash;under
61
73
  # which Stackdriver Logging writes the exported log entries to the sink's
62
74
  # destination. This field is set by
63
- # {sinks.create}[https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create]
75
+ # [sinks.create](https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create)
64
76
  # and
65
- # {sinks.update}[https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/update],
77
+ # [sinks.update](https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/update),
66
78
  # based on the setting of +unique_writer_identity+ in those methods.
67
79
  #
68
80
  # Until you grant this identity write-access to the destination, log entry
69
81
  # exports from this sink will fail. For more information,
70
- # see {Granting access for a
71
- # resource}[https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource].
82
+ # see [Granting access for a
83
+ # resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource).
72
84
  # Consult the destination service's documentation to determine the
73
85
  # appropriate IAM roles to assign to the identity.
86
+ # @!attribute [rw] include_children
87
+ # @return [true, false]
88
+ # Optional. This field applies only to sinks owned by organizations and
89
+ # folders. If the field is false, the default, only the logs owned by the
90
+ # sink's parent resource are available for export. If the field is true, then
91
+ # logs from all the projects, folders, and billing accounts contained in the
92
+ # sink's parent resource are also available for export. Whether a particular
93
+ # log entry from the children is exported depends on the sink's filter
94
+ # expression. For example, if this field is true, then the filter
95
+ # +resource.type=gce_instance+ would export all Compute Engine VM instance
96
+ # log entries from all projects in the sink's parent. To only export entries
97
+ # from certain child projects, filter on the project part of the log name:
98
+ #
99
+ # logName:("projects/test-project1/" OR "projects/test-project2/") AND
100
+ # resource.type=gce_instance
74
101
  # @!attribute [rw] start_time
75
102
  # @return [Google::Protobuf::Timestamp]
76
103
  # Optional. The time at which this sink will begin exporting log entries.
@@ -143,7 +170,7 @@ module Google
143
170
  # "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
144
171
  # "folders/[FOLDER_ID]/sinks/[SINK_ID]"
145
172
  #
146
- # Example: +"projects/my-project-id/sinks/my-sink-id"+.
173
+ # Example: +"projects/my-project/sinks/my-sink-id"+.
147
174
  class GetSinkRequest; end
148
175
 
149
176
  # The parameters to +CreateSink+.
@@ -173,7 +200,7 @@ module Google
173
200
  # If this field is set to true, or if the sink is owned by a non-project
174
201
  # resource such as an organization, then the value of +writer_identity+ will
175
202
  # be a unique service account used only for exports from the new sink. For
176
- # more information, see +writer_identity+ in LogSink.
203
+ # more information, see +writer_identity+ in {Google::Logging::V2::LogSink LogSink}.
177
204
  class CreateSinkRequest; end
178
205
 
179
206
  # The parameters to +UpdateSink+.
@@ -187,25 +214,25 @@ module Google
187
214
  # "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
188
215
  # "folders/[FOLDER_ID]/sinks/[SINK_ID]"
189
216
  #
190
- # Example: +"projects/my-project-id/sinks/my-sink-id"+.
217
+ # Example: +"projects/my-project/sinks/my-sink-id"+.
191
218
  # @!attribute [rw] sink
192
219
  # @return [Google::Logging::V2::LogSink]
193
220
  # Required. The updated sink, whose name is the same identifier that appears
194
- # as part of +sink_name+. If +sink_name+ does not exist, then
195
- # this method creates a new sink.
221
+ # as part of +sink_name+.
196
222
  # @!attribute [rw] unique_writer_identity
197
223
  # @return [true, false]
198
224
  # Optional. See
199
- # {sinks.create}[https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create]
225
+ # [sinks.create](https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create)
200
226
  # for a description of this field. When updating a sink, the effect of this
201
227
  # field on the value of +writer_identity+ in the updated sink depends on both
202
228
  # the old and new values of this field:
203
229
  #
204
- # + If the old and new values of this field are both false or both true,
205
- # then there is no change to the sink's +writer_identity+.
206
- # + If the old value is false and the new value is true, then
207
- # +writer_identity+ is changed to a unique service account.
208
- # + It is an error if the old value is true and the new value is false.
230
+ # * If the old and new values of this field are both false or both true,
231
+ # then there is no change to the sink's +writer_identity+.
232
+ # * If the old value is false and the new value is true, then
233
+ # +writer_identity+ is changed to a unique service account.
234
+ # * It is an error if the old value is true and the new value is
235
+ # set to false or defaulted to false.
209
236
  class UpdateSinkRequest; end
210
237
 
211
238
  # The parameters to +DeleteSink+.
@@ -219,8 +246,143 @@ module Google
219
246
  # "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
220
247
  # "folders/[FOLDER_ID]/sinks/[SINK_ID]"
221
248
  #
222
- # Example: +"projects/my-project-id/sinks/my-sink-id"+.
249
+ # Example: +"projects/my-project/sinks/my-sink-id"+.
223
250
  class DeleteSinkRequest; end
251
+
252
+ # Specifies a set of log entries that are not to be stored in Stackdriver
253
+ # Logging. If your project receives a large volume of logs, you might be able
254
+ # to use exclusions to reduce your chargeable logs. Exclusions are processed
255
+ # after log sinks, so you can export log entries before they are excluded.
256
+ # Audit log entries and log entries from Amazon Web Services are never
257
+ # excluded.
258
+ # @!attribute [rw] name
259
+ # @return [String]
260
+ # Required. A client-assigned identifier, such as
261
+ # +"load-balancer-exclusion"+. Identifiers are limited to 100 characters and
262
+ # can include only letters, digits, underscores, hyphens, and periods.
263
+ # @!attribute [rw] description
264
+ # @return [String]
265
+ # Optional. A description of this exclusion.
266
+ # @!attribute [rw] filter
267
+ # @return [String]
268
+ # Required.
269
+ # An [advanced logs filter](https://cloud.google.com/logging/docs/view/advanced_filters)
270
+ # that matches the log entries to be excluded. By using the
271
+ # [sample function](https://cloud.google.com/logging/docs/view/advanced_filters#sample),
272
+ # you can exclude less than 100% of the matching log entries.
273
+ # For example, the following filter matches 99% of low-severity log
274
+ # entries from load balancers:
275
+ #
276
+ # "resource.type=http_load_balancer severity<ERROR sample(insertId, 0.99)"
277
+ # @!attribute [rw] disabled
278
+ # @return [true, false]
279
+ # Optional. If set to True, then this exclusion is disabled and it does not
280
+ # exclude any log entries. You can use
281
+ # [exclusions.patch](https://cloud.google.com/logging/docs/alpha-exclusion/docs/reference/v2/rest/v2/projects.exclusions/patch)
282
+ # to change the value of this field.
283
+ class LogExclusion; end
284
+
285
+ # The parameters to +ListExclusions+.
286
+ # @!attribute [rw] parent
287
+ # @return [String]
288
+ # Required. The parent resource whose exclusions are to be listed.
289
+ #
290
+ # "projects/[PROJECT_ID]"
291
+ # "organizations/[ORGANIZATION_ID]"
292
+ # "billingAccounts/[BILLING_ACCOUNT_ID]"
293
+ # "folders/[FOLDER_ID]"
294
+ # @!attribute [rw] page_token
295
+ # @return [String]
296
+ # Optional. If present, then retrieve the next batch of results from the
297
+ # preceding call to this method. +pageToken+ must be the value of
298
+ # +nextPageToken+ from the previous response. The values of other method
299
+ # parameters should be identical to those in the previous call.
300
+ # @!attribute [rw] page_size
301
+ # @return [Integer]
302
+ # Optional. The maximum number of results to return from this request.
303
+ # Non-positive values are ignored. The presence of +nextPageToken+ in the
304
+ # response indicates that more results might be available.
305
+ class ListExclusionsRequest; end
306
+
307
+ # Result returned from +ListExclusions+.
308
+ # @!attribute [rw] exclusions
309
+ # @return [Array<Google::Logging::V2::LogExclusion>]
310
+ # A list of exclusions.
311
+ # @!attribute [rw] next_page_token
312
+ # @return [String]
313
+ # If there might be more results than appear in this response, then
314
+ # +nextPageToken+ is included. To get the next set of results, call the same
315
+ # method again using the value of +nextPageToken+ as +pageToken+.
316
+ class ListExclusionsResponse; end
317
+
318
+ # The parameters to +GetExclusion+.
319
+ # @!attribute [rw] name
320
+ # @return [String]
321
+ # Required. The resource name of an existing exclusion:
322
+ #
323
+ # "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
324
+ # "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
325
+ # "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
326
+ # "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
327
+ #
328
+ # Example: +"projects/my-project/exclusions/my-exclusion-id"+.
329
+ class GetExclusionRequest; end
330
+
331
+ # The parameters to +CreateExclusion+.
332
+ # @!attribute [rw] parent
333
+ # @return [String]
334
+ # Required. The parent resource in which to create the exclusion:
335
+ #
336
+ # "projects/[PROJECT_ID]"
337
+ # "organizations/[ORGANIZATION_ID]"
338
+ # "billingAccounts/[BILLING_ACCOUNT_ID]"
339
+ # "folders/[FOLDER_ID]"
340
+ #
341
+ # Examples: +"projects/my-logging-project"+, +"organizations/123456789"+.
342
+ # @!attribute [rw] exclusion
343
+ # @return [Google::Logging::V2::LogExclusion]
344
+ # Required. The new exclusion, whose +name+ parameter is an exclusion name
345
+ # that is not already used in the parent resource.
346
+ class CreateExclusionRequest; end
347
+
348
+ # The parameters to +UpdateExclusion+.
349
+ # @!attribute [rw] name
350
+ # @return [String]
351
+ # Required. The resource name of the exclusion to update:
352
+ #
353
+ # "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
354
+ # "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
355
+ # "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
356
+ # "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
357
+ #
358
+ # Example: +"projects/my-project/exclusions/my-exclusion-id"+.
359
+ # @!attribute [rw] exclusion
360
+ # @return [Google::Logging::V2::LogExclusion]
361
+ # Required. New values for the existing exclusion. Only the fields specified
362
+ # in +update_mask+ are relevant.
363
+ # @!attribute [rw] update_mask
364
+ # @return [Google::Protobuf::FieldMask]
365
+ # Required. A nonempty list of fields to change in the existing exclusion.
366
+ # New values for the fields are taken from the corresponding fields in the
367
+ # {Google::Logging::V2::LogExclusion LogExclusion} included in this request. Fields not mentioned in
368
+ # +update_mask+ are not changed and are ignored in the request.
369
+ #
370
+ # For example, to change the filter and description of an exclusion,
371
+ # specify an +update_mask+ of +"filter,description"+.
372
+ class UpdateExclusionRequest; end
373
+
374
+ # The parameters to +DeleteExclusion+.
375
+ # @!attribute [rw] name
376
+ # @return [String]
377
+ # Required. The resource name of an existing exclusion to delete:
378
+ #
379
+ # "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
380
+ # "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
381
+ # "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
382
+ # "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
383
+ #
384
+ # Example: +"projects/my-project/exclusions/my-exclusion-id"+.
385
+ class DeleteExclusionRequest; end
224
386
  end
225
387
  end
226
388
  end