google-cloud-logging-v2 0.1.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 (50) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +203 -0
  5. data/README.md +75 -0
  6. data/lib/google-cloud-logging-v2.rb +21 -0
  7. data/lib/google/cloud/logging/v2.rb +37 -0
  8. data/lib/google/cloud/logging/v2/config_service.rb +49 -0
  9. data/lib/google/cloud/logging/v2/config_service/client.rb +1723 -0
  10. data/lib/google/cloud/logging/v2/config_service/credentials.rb +54 -0
  11. data/lib/google/cloud/logging/v2/config_service/paths.rb +413 -0
  12. data/lib/google/cloud/logging/v2/logging_service.rb +49 -0
  13. data/lib/google/cloud/logging/v2/logging_service/client.rb +826 -0
  14. data/lib/google/cloud/logging/v2/logging_service/credentials.rb +55 -0
  15. data/lib/google/cloud/logging/v2/logging_service/paths.rb +154 -0
  16. data/lib/google/cloud/logging/v2/metrics_service.rb +49 -0
  17. data/lib/google/cloud/logging/v2/metrics_service/client.rb +726 -0
  18. data/lib/google/cloud/logging/v2/metrics_service/credentials.rb +55 -0
  19. data/lib/google/cloud/logging/v2/metrics_service/paths.rb +64 -0
  20. data/lib/google/cloud/logging/v2/version.rb +28 -0
  21. data/lib/google/logging/type/http_request_pb.rb +38 -0
  22. data/lib/google/logging/type/log_severity_pb.rb +31 -0
  23. data/lib/google/logging/v2/log_entry_pb.rb +62 -0
  24. data/lib/google/logging/v2/logging_config_pb.rb +176 -0
  25. data/lib/google/logging/v2/logging_config_services_pb.rb +113 -0
  26. data/lib/google/logging/v2/logging_metrics_pb.rb +75 -0
  27. data/lib/google/logging/v2/logging_metrics_services_pb.rb +53 -0
  28. data/lib/google/logging/v2/logging_pb.rb +83 -0
  29. data/lib/google/logging/v2/logging_services_pb.rb +65 -0
  30. data/proto_docs/README.md +4 -0
  31. data/proto_docs/google/api/distribution.rb +225 -0
  32. data/proto_docs/google/api/field_behavior.rb +59 -0
  33. data/proto_docs/google/api/label.rb +49 -0
  34. data/proto_docs/google/api/metric.rb +203 -0
  35. data/proto_docs/google/api/monitored_resource.rb +137 -0
  36. data/proto_docs/google/api/resource.rb +247 -0
  37. data/proto_docs/google/logging/type/http_request.rb +95 -0
  38. data/proto_docs/google/logging/type/log_severity.rb +71 -0
  39. data/proto_docs/google/logging/v2/log_entry.rb +203 -0
  40. data/proto_docs/google/logging/v2/logging.rb +303 -0
  41. data/proto_docs/google/logging/v2/logging_config.rb +735 -0
  42. data/proto_docs/google/logging/v2/logging_metrics.rb +256 -0
  43. data/proto_docs/google/protobuf/any.rb +138 -0
  44. data/proto_docs/google/protobuf/duration.rb +98 -0
  45. data/proto_docs/google/protobuf/empty.rb +36 -0
  46. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  47. data/proto_docs/google/protobuf/struct.rb +96 -0
  48. data/proto_docs/google/protobuf/timestamp.rb +120 -0
  49. data/proto_docs/google/rpc/status.rb +46 -0
  50. metadata +231 -0
@@ -0,0 +1,113 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/logging/v2/logging_config.proto for package 'Google.Cloud.Logging.V2'
3
+ # Original file comments:
4
+ # Copyright 2020 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/logging/v2/logging_config_pb'
21
+
22
+ module Google
23
+ module Cloud
24
+ module Logging
25
+ module V2
26
+ module ConfigServiceV2
27
+ # Service for configuring sinks used to route log entries.
28
+ class Service
29
+
30
+ include GRPC::GenericService
31
+
32
+ self.marshal_class_method = :encode
33
+ self.unmarshal_class_method = :decode
34
+ self.service_name = 'google.logging.v2.ConfigServiceV2'
35
+
36
+ # Lists buckets (Beta).
37
+ rpc :ListBuckets, Google::Cloud::Logging::V2::ListBucketsRequest, Google::Cloud::Logging::V2::ListBucketsResponse
38
+ # Gets a bucket (Beta).
39
+ rpc :GetBucket, Google::Cloud::Logging::V2::GetBucketRequest, Google::Cloud::Logging::V2::LogBucket
40
+ # Updates a bucket. This method replaces the following fields in the
41
+ # existing bucket with values from the new bucket: `retention_period`
42
+ #
43
+ # If the retention period is decreased and the bucket is locked,
44
+ # FAILED_PRECONDITION will be returned.
45
+ #
46
+ # If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION
47
+ # will be returned.
48
+ #
49
+ # A buckets region may not be modified after it is created.
50
+ # This method is in Beta.
51
+ rpc :UpdateBucket, Google::Cloud::Logging::V2::UpdateBucketRequest, Google::Cloud::Logging::V2::LogBucket
52
+ # Lists sinks.
53
+ rpc :ListSinks, Google::Cloud::Logging::V2::ListSinksRequest, Google::Cloud::Logging::V2::ListSinksResponse
54
+ # Gets a sink.
55
+ rpc :GetSink, Google::Cloud::Logging::V2::GetSinkRequest, Google::Cloud::Logging::V2::LogSink
56
+ # Creates a sink that exports specified log entries to a destination. The
57
+ # export of newly-ingested log entries begins immediately, unless the sink's
58
+ # `writer_identity` is not permitted to write to the destination. A sink can
59
+ # export log entries only from the resource owning the sink.
60
+ rpc :CreateSink, Google::Cloud::Logging::V2::CreateSinkRequest, Google::Cloud::Logging::V2::LogSink
61
+ # Updates a sink. This method replaces the following fields in the existing
62
+ # sink with values from the new sink: `destination`, and `filter`.
63
+ #
64
+ # The updated sink might also have a new `writer_identity`; see the
65
+ # `unique_writer_identity` field.
66
+ rpc :UpdateSink, Google::Cloud::Logging::V2::UpdateSinkRequest, Google::Cloud::Logging::V2::LogSink
67
+ # Deletes a sink. If the sink has a unique `writer_identity`, then that
68
+ # service account is also deleted.
69
+ rpc :DeleteSink, Google::Cloud::Logging::V2::DeleteSinkRequest, Google::Protobuf::Empty
70
+ # Lists all the exclusions in a parent resource.
71
+ rpc :ListExclusions, Google::Cloud::Logging::V2::ListExclusionsRequest, Google::Cloud::Logging::V2::ListExclusionsResponse
72
+ # Gets the description of an exclusion.
73
+ rpc :GetExclusion, Google::Cloud::Logging::V2::GetExclusionRequest, Google::Cloud::Logging::V2::LogExclusion
74
+ # Creates a new exclusion in a specified parent resource.
75
+ # Only log entries belonging to that resource can be excluded.
76
+ # You can have up to 10 exclusions in a resource.
77
+ rpc :CreateExclusion, Google::Cloud::Logging::V2::CreateExclusionRequest, Google::Cloud::Logging::V2::LogExclusion
78
+ # Changes one or more properties of an existing exclusion.
79
+ rpc :UpdateExclusion, Google::Cloud::Logging::V2::UpdateExclusionRequest, Google::Cloud::Logging::V2::LogExclusion
80
+ # Deletes an exclusion.
81
+ rpc :DeleteExclusion, Google::Cloud::Logging::V2::DeleteExclusionRequest, Google::Protobuf::Empty
82
+ # Gets the Logs Router CMEK settings for the given resource.
83
+ #
84
+ # Note: CMEK for the Logs Router can currently only be configured for GCP
85
+ # organizations. Once configured, it applies to all projects and folders in
86
+ # the GCP organization.
87
+ #
88
+ # See [Enabling CMEK for Logs
89
+ # Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
90
+ rpc :GetCmekSettings, Google::Cloud::Logging::V2::GetCmekSettingsRequest, Google::Cloud::Logging::V2::CmekSettings
91
+ # Updates the Logs Router CMEK settings for the given resource.
92
+ #
93
+ # Note: CMEK for the Logs Router can currently only be configured for GCP
94
+ # organizations. Once configured, it applies to all projects and folders in
95
+ # the GCP organization.
96
+ #
97
+ # [UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings]
98
+ # will fail if 1) `kms_key_name` is invalid, or 2) the associated service
99
+ # account does not have the required
100
+ # `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or
101
+ # 3) access to the key is disabled.
102
+ #
103
+ # See [Enabling CMEK for Logs
104
+ # Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
105
+ rpc :UpdateCmekSettings, Google::Cloud::Logging::V2::UpdateCmekSettingsRequest, Google::Cloud::Logging::V2::CmekSettings
106
+ end
107
+
108
+ Stub = Service.rpc_stub_class
109
+ end
110
+ end
111
+ end
112
+ end
113
+ end
@@ -0,0 +1,75 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/logging/v2/logging_metrics.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/client_pb'
7
+ require 'google/api/distribution_pb'
8
+ require 'google/api/field_behavior_pb'
9
+ require 'google/api/metric_pb'
10
+ require 'google/api/resource_pb'
11
+ require 'google/protobuf/duration_pb'
12
+ require 'google/protobuf/empty_pb'
13
+ require 'google/protobuf/field_mask_pb'
14
+ require 'google/protobuf/timestamp_pb'
15
+ require 'google/api/annotations_pb'
16
+ Google::Protobuf::DescriptorPool.generated_pool.build do
17
+ add_file("google/logging/v2/logging_metrics.proto", :syntax => :proto3) do
18
+ add_message "google.logging.v2.LogMetric" do
19
+ optional :name, :string, 1
20
+ optional :description, :string, 2
21
+ optional :filter, :string, 3
22
+ optional :metric_descriptor, :message, 5, "google.api.MetricDescriptor"
23
+ optional :value_extractor, :string, 6
24
+ map :label_extractors, :string, :string, 7
25
+ optional :bucket_options, :message, 8, "google.api.Distribution.BucketOptions"
26
+ optional :create_time, :message, 9, "google.protobuf.Timestamp"
27
+ optional :update_time, :message, 10, "google.protobuf.Timestamp"
28
+ optional :version, :enum, 4, "google.logging.v2.LogMetric.ApiVersion"
29
+ end
30
+ add_enum "google.logging.v2.LogMetric.ApiVersion" do
31
+ value :V2, 0
32
+ value :V1, 1
33
+ end
34
+ add_message "google.logging.v2.ListLogMetricsRequest" do
35
+ optional :parent, :string, 1
36
+ optional :page_token, :string, 2
37
+ optional :page_size, :int32, 3
38
+ end
39
+ add_message "google.logging.v2.ListLogMetricsResponse" do
40
+ repeated :metrics, :message, 1, "google.logging.v2.LogMetric"
41
+ optional :next_page_token, :string, 2
42
+ end
43
+ add_message "google.logging.v2.GetLogMetricRequest" do
44
+ optional :metric_name, :string, 1
45
+ end
46
+ add_message "google.logging.v2.CreateLogMetricRequest" do
47
+ optional :parent, :string, 1
48
+ optional :metric, :message, 2, "google.logging.v2.LogMetric"
49
+ end
50
+ add_message "google.logging.v2.UpdateLogMetricRequest" do
51
+ optional :metric_name, :string, 1
52
+ optional :metric, :message, 2, "google.logging.v2.LogMetric"
53
+ end
54
+ add_message "google.logging.v2.DeleteLogMetricRequest" do
55
+ optional :metric_name, :string, 1
56
+ end
57
+ end
58
+ end
59
+
60
+ module Google
61
+ module Cloud
62
+ module Logging
63
+ module V2
64
+ LogMetric = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.LogMetric").msgclass
65
+ LogMetric::ApiVersion = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.LogMetric.ApiVersion").enummodule
66
+ ListLogMetricsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListLogMetricsRequest").msgclass
67
+ ListLogMetricsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListLogMetricsResponse").msgclass
68
+ GetLogMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.GetLogMetricRequest").msgclass
69
+ CreateLogMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.CreateLogMetricRequest").msgclass
70
+ UpdateLogMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.UpdateLogMetricRequest").msgclass
71
+ DeleteLogMetricRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.DeleteLogMetricRequest").msgclass
72
+ end
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,53 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/logging/v2/logging_metrics.proto for package 'Google.Cloud.Logging.V2'
3
+ # Original file comments:
4
+ # Copyright 2020 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/logging/v2/logging_metrics_pb'
21
+
22
+ module Google
23
+ module Cloud
24
+ module Logging
25
+ module V2
26
+ module MetricsServiceV2
27
+ # Service for configuring logs-based metrics.
28
+ class Service
29
+
30
+ include GRPC::GenericService
31
+
32
+ self.marshal_class_method = :encode
33
+ self.unmarshal_class_method = :decode
34
+ self.service_name = 'google.logging.v2.MetricsServiceV2'
35
+
36
+ # Lists logs-based metrics.
37
+ rpc :ListLogMetrics, Google::Cloud::Logging::V2::ListLogMetricsRequest, Google::Cloud::Logging::V2::ListLogMetricsResponse
38
+ # Gets a logs-based metric.
39
+ rpc :GetLogMetric, Google::Cloud::Logging::V2::GetLogMetricRequest, Google::Cloud::Logging::V2::LogMetric
40
+ # Creates a logs-based metric.
41
+ rpc :CreateLogMetric, Google::Cloud::Logging::V2::CreateLogMetricRequest, Google::Cloud::Logging::V2::LogMetric
42
+ # Creates or updates a logs-based metric.
43
+ rpc :UpdateLogMetric, Google::Cloud::Logging::V2::UpdateLogMetricRequest, Google::Cloud::Logging::V2::LogMetric
44
+ # Deletes a logs-based metric.
45
+ rpc :DeleteLogMetric, Google::Cloud::Logging::V2::DeleteLogMetricRequest, Google::Protobuf::Empty
46
+ end
47
+
48
+ Stub = Service.rpc_stub_class
49
+ end
50
+ end
51
+ end
52
+ end
53
+ end
@@ -0,0 +1,83 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/logging/v2/logging.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/client_pb'
7
+ require 'google/api/field_behavior_pb'
8
+ require 'google/api/monitored_resource_pb'
9
+ require 'google/api/resource_pb'
10
+ require 'google/logging/v2/log_entry_pb'
11
+ require 'google/logging/v2/logging_config_pb'
12
+ require 'google/protobuf/duration_pb'
13
+ require 'google/protobuf/empty_pb'
14
+ require 'google/protobuf/timestamp_pb'
15
+ require 'google/rpc/status_pb'
16
+ require 'google/api/annotations_pb'
17
+ Google::Protobuf::DescriptorPool.generated_pool.build do
18
+ add_file("google/logging/v2/logging.proto", :syntax => :proto3) do
19
+ add_message "google.logging.v2.DeleteLogRequest" do
20
+ optional :log_name, :string, 1
21
+ end
22
+ add_message "google.logging.v2.WriteLogEntriesRequest" do
23
+ optional :log_name, :string, 1
24
+ optional :resource, :message, 2, "google.api.MonitoredResource"
25
+ map :labels, :string, :string, 3
26
+ repeated :entries, :message, 4, "google.logging.v2.LogEntry"
27
+ optional :partial_success, :bool, 5
28
+ optional :dry_run, :bool, 6
29
+ end
30
+ add_message "google.logging.v2.WriteLogEntriesResponse" do
31
+ end
32
+ add_message "google.logging.v2.WriteLogEntriesPartialErrors" do
33
+ map :log_entry_errors, :int32, :message, 1, "google.rpc.Status"
34
+ end
35
+ add_message "google.logging.v2.ListLogEntriesRequest" do
36
+ repeated :resource_names, :string, 8
37
+ optional :filter, :string, 2
38
+ optional :order_by, :string, 3
39
+ optional :page_size, :int32, 4
40
+ optional :page_token, :string, 5
41
+ end
42
+ add_message "google.logging.v2.ListLogEntriesResponse" do
43
+ repeated :entries, :message, 1, "google.logging.v2.LogEntry"
44
+ optional :next_page_token, :string, 2
45
+ end
46
+ add_message "google.logging.v2.ListMonitoredResourceDescriptorsRequest" do
47
+ optional :page_size, :int32, 1
48
+ optional :page_token, :string, 2
49
+ end
50
+ add_message "google.logging.v2.ListMonitoredResourceDescriptorsResponse" do
51
+ repeated :resource_descriptors, :message, 1, "google.api.MonitoredResourceDescriptor"
52
+ optional :next_page_token, :string, 2
53
+ end
54
+ add_message "google.logging.v2.ListLogsRequest" do
55
+ optional :parent, :string, 1
56
+ optional :page_size, :int32, 2
57
+ optional :page_token, :string, 3
58
+ end
59
+ add_message "google.logging.v2.ListLogsResponse" do
60
+ repeated :log_names, :string, 3
61
+ optional :next_page_token, :string, 2
62
+ end
63
+ end
64
+ end
65
+
66
+ module Google
67
+ module Cloud
68
+ module Logging
69
+ module V2
70
+ DeleteLogRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.DeleteLogRequest").msgclass
71
+ WriteLogEntriesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.WriteLogEntriesRequest").msgclass
72
+ WriteLogEntriesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.WriteLogEntriesResponse").msgclass
73
+ WriteLogEntriesPartialErrors = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.WriteLogEntriesPartialErrors").msgclass
74
+ ListLogEntriesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListLogEntriesRequest").msgclass
75
+ ListLogEntriesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListLogEntriesResponse").msgclass
76
+ ListMonitoredResourceDescriptorsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListMonitoredResourceDescriptorsRequest").msgclass
77
+ ListMonitoredResourceDescriptorsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListMonitoredResourceDescriptorsResponse").msgclass
78
+ ListLogsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListLogsRequest").msgclass
79
+ ListLogsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.ListLogsResponse").msgclass
80
+ end
81
+ end
82
+ end
83
+ end
@@ -0,0 +1,65 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/logging/v2/logging.proto for package 'Google.Cloud.Logging.V2'
3
+ # Original file comments:
4
+ # Copyright 2020 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/logging/v2/logging_pb'
21
+
22
+ module Google
23
+ module Cloud
24
+ module Logging
25
+ module V2
26
+ module LoggingServiceV2
27
+ # Service for ingesting and querying logs.
28
+ class Service
29
+
30
+ include GRPC::GenericService
31
+
32
+ self.marshal_class_method = :encode
33
+ self.unmarshal_class_method = :decode
34
+ self.service_name = 'google.logging.v2.LoggingServiceV2'
35
+
36
+ # Deletes all the log entries in a log. The log reappears if it receives new
37
+ # entries. Log entries written shortly before the delete operation might not
38
+ # be deleted. Entries received after the delete operation with a timestamp
39
+ # before the operation will be deleted.
40
+ rpc :DeleteLog, Google::Cloud::Logging::V2::DeleteLogRequest, Google::Protobuf::Empty
41
+ # Writes log entries to Logging. This API method is the
42
+ # only way to send log entries to Logging. This method
43
+ # is used, directly or indirectly, by the Logging agent
44
+ # (fluentd) and all logging libraries configured to use Logging.
45
+ # A single request may contain log entries for a maximum of 1000
46
+ # different resources (projects, organizations, billing accounts or
47
+ # folders)
48
+ rpc :WriteLogEntries, Google::Cloud::Logging::V2::WriteLogEntriesRequest, Google::Cloud::Logging::V2::WriteLogEntriesResponse
49
+ # Lists log entries. Use this method to retrieve log entries that originated
50
+ # from a project/folder/organization/billing account. For ways to export log
51
+ # entries, see [Exporting Logs](https://cloud.google.com/logging/docs/export).
52
+ rpc :ListLogEntries, Google::Cloud::Logging::V2::ListLogEntriesRequest, Google::Cloud::Logging::V2::ListLogEntriesResponse
53
+ # Lists the descriptors for monitored resource types used by Logging.
54
+ rpc :ListMonitoredResourceDescriptors, Google::Cloud::Logging::V2::ListMonitoredResourceDescriptorsRequest, Google::Cloud::Logging::V2::ListMonitoredResourceDescriptorsResponse
55
+ # Lists the logs in projects, organizations, folders, or billing accounts.
56
+ # Only logs that have entries are listed.
57
+ rpc :ListLogs, Google::Cloud::Logging::V2::ListLogsRequest, Google::Cloud::Logging::V2::ListLogsResponse
58
+ end
59
+
60
+ Stub = Service.rpc_stub_class
61
+ end
62
+ end
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,4 @@
1
+ # Cloud Logging V2 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,225 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # `Distribution` contains summary statistics for a population of values. It
23
+ # optionally contains a histogram representing the distribution of those values
24
+ # across a set of buckets.
25
+ #
26
+ # The summary statistics are the count, mean, sum of the squared deviation from
27
+ # the mean, the minimum, and the maximum of the set of population of values.
28
+ # The histogram is based on a sequence of buckets and gives a count of values
29
+ # that fall into each bucket. The boundaries of the buckets are given either
30
+ # explicitly or by formulas for buckets of fixed or exponentially increasing
31
+ # widths.
32
+ #
33
+ # Although it is not forbidden, it is generally a bad idea to include
34
+ # non-finite values (infinities or NaNs) in the population of values, as this
35
+ # will render the `mean` and `sum_of_squared_deviation` fields meaningless.
36
+ # @!attribute [rw] count
37
+ # @return [::Integer]
38
+ # The number of values in the population. Must be non-negative. This value
39
+ # must equal the sum of the values in `bucket_counts` if a histogram is
40
+ # provided.
41
+ # @!attribute [rw] mean
42
+ # @return [::Float]
43
+ # The arithmetic mean of the values in the population. If `count` is zero
44
+ # then this field must be zero.
45
+ # @!attribute [rw] sum_of_squared_deviation
46
+ # @return [::Float]
47
+ # The sum of squared deviations from the mean of the values in the
48
+ # population. For values x_i this is:
49
+ #
50
+ # Sum[i=1..n]((x_i - mean)^2)
51
+ #
52
+ # Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
53
+ # describes Welford's method for accumulating this sum in one pass.
54
+ #
55
+ # If `count` is zero then this field must be zero.
56
+ # @!attribute [rw] range
57
+ # @return [::Google::Api::Distribution::Range]
58
+ # If specified, contains the range of the population values. The field
59
+ # must not be present if the `count` is zero.
60
+ # @!attribute [rw] bucket_options
61
+ # @return [::Google::Api::Distribution::BucketOptions]
62
+ # Defines the histogram bucket boundaries. If the distribution does not
63
+ # contain a histogram, then omit this field.
64
+ # @!attribute [rw] bucket_counts
65
+ # @return [::Array<::Integer>]
66
+ # The number of values in each bucket of the histogram, as described in
67
+ # `bucket_options`. If the distribution does not have a histogram, then omit
68
+ # this field. If there is a histogram, then the sum of the values in
69
+ # `bucket_counts` must equal the value in the `count` field of the
70
+ # distribution.
71
+ #
72
+ # If present, `bucket_counts` should contain N values, where N is the number
73
+ # of buckets specified in `bucket_options`. If you supply fewer than N
74
+ # values, the remaining values are assumed to be 0.
75
+ #
76
+ # The order of the values in `bucket_counts` follows the bucket numbering
77
+ # schemes described for the three bucket types. The first value must be the
78
+ # count for the underflow bucket (number 0). The next N-2 values are the
79
+ # counts for the finite buckets (number 1 through N-2). The N'th value in
80
+ # `bucket_counts` is the count for the overflow bucket (number N-1).
81
+ # @!attribute [rw] exemplars
82
+ # @return [::Array<::Google::Api::Distribution::Exemplar>]
83
+ # Must be in increasing order of `value` field.
84
+ class Distribution
85
+ include ::Google::Protobuf::MessageExts
86
+ extend ::Google::Protobuf::MessageExts::ClassMethods
87
+
88
+ # The range of the population values.
89
+ # @!attribute [rw] min
90
+ # @return [::Float]
91
+ # The minimum of the population values.
92
+ # @!attribute [rw] max
93
+ # @return [::Float]
94
+ # The maximum of the population values.
95
+ class Range
96
+ include ::Google::Protobuf::MessageExts
97
+ extend ::Google::Protobuf::MessageExts::ClassMethods
98
+ end
99
+
100
+ # `BucketOptions` describes the bucket boundaries used to create a histogram
101
+ # for the distribution. The buckets can be in a linear sequence, an
102
+ # exponential sequence, or each bucket can be specified explicitly.
103
+ # `BucketOptions` does not include the number of values in each bucket.
104
+ #
105
+ # A bucket has an inclusive lower bound and exclusive upper bound for the
106
+ # values that are counted for that bucket. The upper bound of a bucket must
107
+ # be strictly greater than the lower bound. The sequence of N buckets for a
108
+ # distribution consists of an underflow bucket (number 0), zero or more
109
+ # finite buckets (number 1 through N - 2) and an overflow bucket (number N -
110
+ # 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the
111
+ # same as the upper bound of bucket i - 1. The buckets span the whole range
112
+ # of finite values: lower bound of the underflow bucket is -infinity and the
113
+ # upper bound of the overflow bucket is +infinity. The finite buckets are
114
+ # so-called because both bounds are finite.
115
+ # @!attribute [rw] linear_buckets
116
+ # @return [::Google::Api::Distribution::BucketOptions::Linear]
117
+ # The linear bucket.
118
+ # @!attribute [rw] exponential_buckets
119
+ # @return [::Google::Api::Distribution::BucketOptions::Exponential]
120
+ # The exponential buckets.
121
+ # @!attribute [rw] explicit_buckets
122
+ # @return [::Google::Api::Distribution::BucketOptions::Explicit]
123
+ # The explicit buckets.
124
+ class BucketOptions
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+
128
+ # Specifies a linear sequence of buckets that all have the same width
129
+ # (except overflow and underflow). Each bucket represents a constant
130
+ # absolute uncertainty on the specific value in the bucket.
131
+ #
132
+ # There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
133
+ # following boundaries:
134
+ #
135
+ # Upper bound (0 <= i < N-1): offset + (width * i).
136
+ # Lower bound (1 <= i < N): offset + (width * (i - 1)).
137
+ # @!attribute [rw] num_finite_buckets
138
+ # @return [::Integer]
139
+ # Must be greater than 0.
140
+ # @!attribute [rw] width
141
+ # @return [::Float]
142
+ # Must be greater than 0.
143
+ # @!attribute [rw] offset
144
+ # @return [::Float]
145
+ # Lower bound of the first bucket.
146
+ class Linear
147
+ include ::Google::Protobuf::MessageExts
148
+ extend ::Google::Protobuf::MessageExts::ClassMethods
149
+ end
150
+
151
+ # Specifies an exponential sequence of buckets that have a width that is
152
+ # proportional to the value of the lower bound. Each bucket represents a
153
+ # constant relative uncertainty on a specific value in the bucket.
154
+ #
155
+ # There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
156
+ # following boundaries:
157
+ #
158
+ # Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).
159
+ # Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
160
+ # @!attribute [rw] num_finite_buckets
161
+ # @return [::Integer]
162
+ # Must be greater than 0.
163
+ # @!attribute [rw] growth_factor
164
+ # @return [::Float]
165
+ # Must be greater than 1.
166
+ # @!attribute [rw] scale
167
+ # @return [::Float]
168
+ # Must be greater than 0.
169
+ class Exponential
170
+ include ::Google::Protobuf::MessageExts
171
+ extend ::Google::Protobuf::MessageExts::ClassMethods
172
+ end
173
+
174
+ # Specifies a set of buckets with arbitrary widths.
175
+ #
176
+ # There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following
177
+ # boundaries:
178
+ #
179
+ # Upper bound (0 <= i < N-1): bounds[i]
180
+ # Lower bound (1 <= i < N); bounds[i - 1]
181
+ #
182
+ # The `bounds` field must contain at least one element. If `bounds` has
183
+ # only one element, then there are no finite buckets, and that single
184
+ # element is the common boundary of the overflow and underflow buckets.
185
+ # @!attribute [rw] bounds
186
+ # @return [::Array<::Float>]
187
+ # The values must be monotonically increasing.
188
+ class Explicit
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+ end
193
+
194
+ # Exemplars are example points that may be used to annotate aggregated
195
+ # distribution values. They are metadata that gives information about a
196
+ # particular value added to a Distribution bucket, such as a trace ID that
197
+ # was active when a value was added. They may contain further information,
198
+ # such as a example values and timestamps, origin, etc.
199
+ # @!attribute [rw] value
200
+ # @return [::Float]
201
+ # Value of the exemplar point. This value determines to which bucket the
202
+ # exemplar belongs.
203
+ # @!attribute [rw] timestamp
204
+ # @return [::Google::Protobuf::Timestamp]
205
+ # The observation (sampling) time of the above value.
206
+ # @!attribute [rw] attachments
207
+ # @return [::Array<::Google::Protobuf::Any>]
208
+ # Contextual information about the example value. Examples are:
209
+ #
210
+ # Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace
211
+ #
212
+ # Literal string: type.googleapis.com/google.protobuf.StringValue
213
+ #
214
+ # Labels dropped during aggregation:
215
+ # type.googleapis.com/google.monitoring.v3.DroppedLabels
216
+ #
217
+ # There may be only a single attachment of any given message type in a
218
+ # single exemplar, and this is enforced by the system.
219
+ class Exemplar
220
+ include ::Google::Protobuf::MessageExts
221
+ extend ::Google::Protobuf::MessageExts::ClassMethods
222
+ end
223
+ end
224
+ end
225
+ end