google-cloud-logging-v2 0.5.3 → 0.6.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 (25) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -1
  3. data/AUTHENTICATION.md +7 -25
  4. data/README.md +1 -1
  5. data/lib/google/cloud/logging/v2/config_service/client.rb +1087 -230
  6. data/lib/google/cloud/logging/v2/config_service/operations.rb +767 -0
  7. data/lib/google/cloud/logging/v2/config_service/paths.rb +53 -0
  8. data/lib/google/cloud/logging/v2/config_service.rb +1 -0
  9. data/lib/google/cloud/logging/v2/logging_service/client.rb +213 -89
  10. data/lib/google/cloud/logging/v2/metrics_service/client.rb +150 -56
  11. data/lib/google/cloud/logging/v2/version.rb +1 -1
  12. data/lib/google/logging/v2/log_entry_pb.rb +10 -4
  13. data/lib/google/logging/v2/logging_config_pb.rb +52 -3
  14. data/lib/google/logging/v2/logging_config_services_pb.rb +79 -40
  15. data/lib/google/logging/v2/logging_metrics_pb.rb +4 -3
  16. data/lib/google/logging/v2/logging_metrics_services_pb.rb +1 -1
  17. data/lib/google/logging/v2/logging_pb.rb +3 -3
  18. data/lib/google/logging/v2/logging_services_pb.rb +5 -5
  19. data/proto_docs/google/api/resource.rb +10 -71
  20. data/proto_docs/google/logging/v2/log_entry.rb +42 -4
  21. data/proto_docs/google/logging/v2/logging.rb +50 -45
  22. data/proto_docs/google/logging/v2/logging_config.rb +416 -155
  23. data/proto_docs/google/logging/v2/logging_metrics.rb +9 -5
  24. data/proto_docs/google/longrunning/operations.rb +164 -0
  25. metadata +7 -5
data/lib/google/logging/v2/logging_config_services_pb.rb CHANGED
@@ -27,49 +27,56 @@ module Google
27
27
  # Service for configuring sinks used to route log entries.
28
28
  class Service
29
29
 
30
- include GRPC::GenericService
30
+ include ::GRPC::GenericService
31
31
 
32
32
  self.marshal_class_method = :encode
33
33
  self.unmarshal_class_method = :decode
34
34
  self.service_name = 'google.logging.v2.ConfigServiceV2'
35
35
 
36
- # Lists buckets.
36
+ # Lists log buckets.
37
37
  rpc :ListBuckets, ::Google::Cloud::Logging::V2::ListBucketsRequest, ::Google::Cloud::Logging::V2::ListBucketsResponse
38
- # Gets a bucket.
38
+ # Gets a log bucket.
39
39
  rpc :GetBucket, ::Google::Cloud::Logging::V2::GetBucketRequest, ::Google::Cloud::Logging::V2::LogBucket
40
- # Creates a bucket that can be used to store log entries. Once a bucket has
41
- # been created, the region cannot be changed.
40
+ # Creates a log bucket that can be used to store log entries. After a bucket
41
+ # has been created, the bucket's location cannot be changed.
42
42
  rpc :CreateBucket, ::Google::Cloud::Logging::V2::CreateBucketRequest, ::Google::Cloud::Logging::V2::LogBucket
43
- # Updates a bucket. This method replaces the following fields in the
43
+ # Updates a log bucket. This method replaces the following fields in the
44
44
  # existing bucket with values from the new bucket: `retention_period`
45
45
  #
46
46
  # If the retention period is decreased and the bucket is locked,
47
- # FAILED_PRECONDITION will be returned.
47
+ # `FAILED_PRECONDITION` will be returned.
48
48
  #
49
- # If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION
50
- # will be returned.
49
+ # If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then
50
+ # `FAILED_PRECONDITION` will be returned.
51
51
  #
52
- # A buckets region may not be modified after it is created.
52
+ # After a bucket has been created, the bucket's location cannot be changed.
53
53
  rpc :UpdateBucket, ::Google::Cloud::Logging::V2::UpdateBucketRequest, ::Google::Cloud::Logging::V2::LogBucket
54
- # Deletes a bucket.
55
- # Moves the bucket to the DELETE_REQUESTED state. After 7 days, the
56
- # bucket will be purged and all logs in the bucket will be permanently
57
- # deleted.
54
+ # Deletes a log bucket.
55
+ #
56
+ # Changes the bucket's `lifecycle_state` to the `DELETE_REQUESTED` state.
57
+ # After 7 days, the bucket will be purged and all log entries in the bucket
58
+ # will be permanently deleted.
58
59
  rpc :DeleteBucket, ::Google::Cloud::Logging::V2::DeleteBucketRequest, ::Google::Protobuf::Empty
59
- # Undeletes a bucket. A bucket that has been deleted may be undeleted within
60
- # the grace period of 7 days.
60
+ # Undeletes a log bucket. A bucket that has been deleted can be undeleted
61
+ # within the grace period of 7 days.
61
62
  rpc :UndeleteBucket, ::Google::Cloud::Logging::V2::UndeleteBucketRequest, ::Google::Protobuf::Empty
62
- # Lists views on a bucket.
63
+ # Lists views on a log bucket.
63
64
  rpc :ListViews, ::Google::Cloud::Logging::V2::ListViewsRequest, ::Google::Cloud::Logging::V2::ListViewsResponse
64
- # Gets a view.
65
+ # Gets a view on a log bucket..
65
66
  rpc :GetView, ::Google::Cloud::Logging::V2::GetViewRequest, ::Google::Cloud::Logging::V2::LogView
66
- # Creates a view over logs in a bucket. A bucket may contain a maximum of
67
- # 50 views.
67
+ # Creates a view over log entries in a log bucket. A bucket may contain a
68
+ # maximum of 30 views.
68
69
  rpc :CreateView, ::Google::Cloud::Logging::V2::CreateViewRequest, ::Google::Cloud::Logging::V2::LogView
69
- # Updates a view. This method replaces the following fields in the existing
70
- # view with values from the new view: `filter`.
70
+ # Updates a view on a log bucket. This method replaces the following fields
71
+ # in the existing view with values from the new view: `filter`.
72
+ # If an `UNAVAILABLE` error is returned, this indicates that system is not in
73
+ # a state where it can update the view. If this occurs, please try again in a
74
+ # few minutes.
71
75
  rpc :UpdateView, ::Google::Cloud::Logging::V2::UpdateViewRequest, ::Google::Cloud::Logging::V2::LogView
72
- # Deletes a view from a bucket.
76
+ # Deletes a view on a log bucket.
77
+ # If an `UNAVAILABLE` error is returned, this indicates that system is not in
78
+ # a state where it can delete the view. If this occurs, please try again in a
79
+ # few minutes.
73
80
  rpc :DeleteView, ::Google::Cloud::Logging::V2::DeleteViewRequest, ::Google::Protobuf::Empty
74
81
  # Lists sinks.
75
82
  rpc :ListSinks, ::Google::Cloud::Logging::V2::ListSinksRequest, ::Google::Cloud::Logging::V2::ListSinksResponse
@@ -89,33 +96,35 @@ module Google
89
96
  # Deletes a sink. If the sink has a unique `writer_identity`, then that
90
97
  # service account is also deleted.
91
98
  rpc :DeleteSink, ::Google::Cloud::Logging::V2::DeleteSinkRequest, ::Google::Protobuf::Empty
92
- # Lists all the exclusions in a parent resource.
99
+ # Lists all the exclusions on the _Default sink in a parent resource.
93
100
  rpc :ListExclusions, ::Google::Cloud::Logging::V2::ListExclusionsRequest, ::Google::Cloud::Logging::V2::ListExclusionsResponse
94
- # Gets the description of an exclusion.
101
+ # Gets the description of an exclusion in the _Default sink.
95
102
  rpc :GetExclusion, ::Google::Cloud::Logging::V2::GetExclusionRequest, ::Google::Cloud::Logging::V2::LogExclusion
96
- # Creates a new exclusion in a specified parent resource.
97
- # Only log entries belonging to that resource can be excluded.
98
- # You can have up to 10 exclusions in a resource.
103
+ # Creates a new exclusion in the _Default sink in a specified parent
104
+ # resource. Only log entries belonging to that resource can be excluded. You
105
+ # can have up to 10 exclusions in a resource.
99
106
  rpc :CreateExclusion, ::Google::Cloud::Logging::V2::CreateExclusionRequest, ::Google::Cloud::Logging::V2::LogExclusion
100
- # Changes one or more properties of an existing exclusion.
107
+ # Changes one or more properties of an existing exclusion in the _Default
108
+ # sink.
101
109
  rpc :UpdateExclusion, ::Google::Cloud::Logging::V2::UpdateExclusionRequest, ::Google::Cloud::Logging::V2::LogExclusion
102
- # Deletes an exclusion.
110
+ # Deletes an exclusion in the _Default sink.
103
111
  rpc :DeleteExclusion, ::Google::Cloud::Logging::V2::DeleteExclusionRequest, ::Google::Protobuf::Empty
104
- # Gets the Logs Router CMEK settings for the given resource.
112
+ # Gets the Logging CMEK settings for the given resource.
105
113
  #
106
- # Note: CMEK for the Logs Router can currently only be configured for GCP
107
- # organizations. Once configured, it applies to all projects and folders in
108
- # the GCP organization.
114
+ # Note: CMEK for the Log Router can be configured for Google Cloud projects,
115
+ # folders, organizations and billing accounts. Once configured for an
116
+ # organization, it applies to all projects and folders in the Google Cloud
117
+ # organization.
109
118
  #
110
- # See [Enabling CMEK for Logs
119
+ # See [Enabling CMEK for Log
111
120
  # Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
112
121
  # for more information.
113
122
  rpc :GetCmekSettings, ::Google::Cloud::Logging::V2::GetCmekSettingsRequest, ::Google::Cloud::Logging::V2::CmekSettings
114
- # Updates the Logs Router CMEK settings for the given resource.
123
+ # Updates the Log Router CMEK settings for the given resource.
115
124
  #
116
- # Note: CMEK for the Logs Router can currently only be configured for GCP
117
- # organizations. Once configured, it applies to all projects and folders in
118
- # the GCP organization.
125
+ # Note: CMEK for the Log Router can currently only be configured for Google
126
+ # Cloud organizations. Once configured, it applies to all projects and
127
+ # folders in the Google Cloud organization.
119
128
  #
120
129
  # [UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings]
121
130
  # will fail if 1) `kms_key_name` is invalid, or 2) the associated service
@@ -123,10 +132,40 @@ module Google
123
132
  # `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or
124
133
  # 3) access to the key is disabled.
125
134
  #
126
- # See [Enabling CMEK for Logs
135
+ # See [Enabling CMEK for Log
127
136
  # Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
128
137
  # for more information.
129
138
  rpc :UpdateCmekSettings, ::Google::Cloud::Logging::V2::UpdateCmekSettingsRequest, ::Google::Cloud::Logging::V2::CmekSettings
139
+ # Gets the Log Router settings for the given resource.
140
+ #
141
+ # Note: Settings for the Log Router can be get for Google Cloud projects,
142
+ # folders, organizations and billing accounts. Currently it can only be
143
+ # configured for organizations. Once configured for an organization, it
144
+ # applies to all projects and folders in the Google Cloud organization.
145
+ #
146
+ # See [Enabling CMEK for Log
147
+ # Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
148
+ # for more information.
149
+ rpc :GetSettings, ::Google::Cloud::Logging::V2::GetSettingsRequest, ::Google::Cloud::Logging::V2::Settings
150
+ # Updates the Log Router settings for the given resource.
151
+ #
152
+ # Note: Settings for the Log Router can currently only be configured for
153
+ # Google Cloud organizations. Once configured, it applies to all projects and
154
+ # folders in the Google Cloud organization.
155
+ #
156
+ # [UpdateSettings][google.logging.v2.ConfigServiceV2.UpdateSettings]
157
+ # will fail if 1) `kms_key_name` is invalid, or 2) the associated service
158
+ # account does not have the required
159
+ # `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or
160
+ # 3) access to the key is disabled. 4) `location_id` is not supported by
161
+ # Logging. 5) `location_id` violate OrgPolicy.
162
+ #
163
+ # See [Enabling CMEK for Log
164
+ # Router](https://cloud.google.com/logging/docs/routing/managed-encryption)
165
+ # for more information.
166
+ rpc :UpdateSettings, ::Google::Cloud::Logging::V2::UpdateSettingsRequest, ::Google::Cloud::Logging::V2::Settings
167
+ # Copies a set of log entries from a log bucket to a Cloud Storage bucket.
168
+ rpc :CopyLogEntries, ::Google::Cloud::Logging::V2::CopyLogEntriesRequest, ::Google::Longrunning::Operation
130
169
  end
131
170
 
132
171
  Stub = Service.rpc_stub_class
data/lib/google/logging/v2/logging_metrics_pb.rb CHANGED
@@ -1,8 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/logging/v2/logging_metrics.proto
3
3
 
4
- require 'google/protobuf'
5
-
4
+ require 'google/api/annotations_pb'
6
5
  require 'google/api/client_pb'
7
6
  require 'google/api/distribution_pb'
8
7
  require 'google/api/field_behavior_pb'
@@ -12,13 +11,15 @@ require 'google/protobuf/duration_pb'
12
11
  require 'google/protobuf/empty_pb'
13
12
  require 'google/protobuf/field_mask_pb'
14
13
  require 'google/protobuf/timestamp_pb'
15
- require 'google/api/annotations_pb'
14
+ require 'google/protobuf'
15
+
16
16
  Google::Protobuf::DescriptorPool.generated_pool.build do
17
17
  add_file("google/logging/v2/logging_metrics.proto", :syntax => :proto3) do
18
18
  add_message "google.logging.v2.LogMetric" do
19
19
  optional :name, :string, 1
20
20
  optional :description, :string, 2
21
21
  optional :filter, :string, 3
22
+ optional :disabled, :bool, 12
22
23
  optional :metric_descriptor, :message, 5, "google.api.MetricDescriptor"
23
24
  optional :value_extractor, :string, 6
24
25
  map :label_extractors, :string, :string, 7
data/lib/google/logging/v2/logging_metrics_services_pb.rb CHANGED
@@ -27,7 +27,7 @@ module Google
27
27
  # Service for configuring logs-based metrics.
28
28
  class Service
29
29
 
30
- include GRPC::GenericService
30
+ include ::GRPC::GenericService
31
31
 
32
32
  self.marshal_class_method = :encode
33
33
  self.unmarshal_class_method = :decode
data/lib/google/logging/v2/logging_pb.rb CHANGED
@@ -1,8 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/logging/v2/logging.proto
3
3
 
4
- require 'google/protobuf'
5
-
4
+ require 'google/api/annotations_pb'
6
5
  require 'google/api/client_pb'
7
6
  require 'google/api/field_behavior_pb'
8
7
  require 'google/api/monitored_resource_pb'
@@ -14,7 +13,8 @@ require 'google/protobuf/empty_pb'
14
13
  require 'google/protobuf/field_mask_pb'
15
14
  require 'google/protobuf/timestamp_pb'
16
15
  require 'google/rpc/status_pb'
17
- require 'google/api/annotations_pb'
16
+ require 'google/protobuf'
17
+
18
18
  Google::Protobuf::DescriptorPool.generated_pool.build do
19
19
  add_file("google/logging/v2/logging.proto", :syntax => :proto3) do
20
20
  add_message "google.logging.v2.DeleteLogRequest" do
data/lib/google/logging/v2/logging_services_pb.rb CHANGED
@@ -27,16 +27,16 @@ module Google
27
27
  # Service for ingesting and querying logs.
28
28
  class Service
29
29
 
30
- include GRPC::GenericService
30
+ include ::GRPC::GenericService
31
31
 
32
32
  self.marshal_class_method = :encode
33
33
  self.unmarshal_class_method = :decode
34
34
  self.service_name = 'google.logging.v2.LoggingServiceV2'
35
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.
36
+ # Deletes all the log entries in a log for the _Default Log Bucket. The log
37
+ # reappears if it receives new entries. Log entries written shortly before
38
+ # the delete operation might not be deleted. Entries received after the
39
+ # delete operation with a timestamp before the operation will be deleted.
40
40
  rpc :DeleteLog, ::Google::Cloud::Logging::V2::DeleteLogRequest, ::Google::Protobuf::Empty
41
41
  # Writes log entries to Logging. This API method is the
42
42
  # only way to send log entries to Logging. This method
data/proto_docs/google/api/resource.rb CHANGED
@@ -33,11 +33,7 @@ module Google
33
33
  # // For Kubernetes resources, the format is {api group}/{kind}.
34
34
  # option (google.api.resource) = {
35
35
  # type: "pubsub.googleapis.com/Topic"
36
- # name_descriptor: {
37
- # pattern: "projects/{project}/topics/{topic}"
38
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
- # parent_name_extractor: "projects/{project}"
40
- # }
36
+ # pattern: "projects/{project}/topics/{topic}"
41
37
  # };
42
38
  # }
43
39
  #
@@ -45,10 +41,7 @@ module Google
45
41
  #
46
42
  # resources:
47
43
  # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/{project}/topics/{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/{project}"
44
+ # pattern: "projects/{project}/topics/{topic}"
52
45
  #
53
46
  # Sometimes, resources have multiple patterns, typically because they can
54
47
  # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
58
51
  # message LogEntry {
59
52
  # option (google.api.resource) = {
60
53
  # type: "logging.googleapis.com/LogEntry"
61
- # name_descriptor: {
62
- # pattern: "projects/{project}/logs/{log}"
63
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
- # parent_name_extractor: "projects/{project}"
65
- # }
66
- # name_descriptor: {
67
- # pattern: "folders/{folder}/logs/{log}"
68
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
69
- # parent_name_extractor: "folders/{folder}"
70
- # }
71
- # name_descriptor: {
72
- # pattern: "organizations/{organization}/logs/{log}"
73
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
74
- # parent_name_extractor: "organizations/{organization}"
75
- # }
76
- # name_descriptor: {
77
- # pattern: "billingAccounts/{billing_account}/logs/{log}"
78
- # parent_type: "billing.googleapis.com/BillingAccount"
79
- # parent_name_extractor: "billingAccounts/{billing_account}"
80
- # }
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
81
58
  # };
82
59
  # }
83
60
  #
@@ -85,48 +62,10 @@ module Google
85
62
  #
86
63
  # resources:
87
64
  # - type: 'logging.googleapis.com/LogEntry'
88
- # name_descriptor:
89
- # - pattern: "projects/{project}/logs/{log}"
90
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
- # parent_name_extractor: "projects/{project}"
92
- # - pattern: "folders/{folder}/logs/{log}"
93
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
94
- # parent_name_extractor: "folders/{folder}"
95
- # - pattern: "organizations/{organization}/logs/{log}"
96
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
97
- # parent_name_extractor: "organizations/{organization}"
98
- # - pattern: "billingAccounts/{billing_account}/logs/{log}"
99
- # parent_type: "billing.googleapis.com/BillingAccount"
100
- # parent_name_extractor: "billingAccounts/{billing_account}"
101
- #
102
- # For flexible resources, the resource name doesn't contain parent names, but
103
- # the resource itself has parents for policy evaluation.
104
- #
105
- # Example:
106
- #
107
- # message Shelf {
108
- # option (google.api.resource) = {
109
- # type: "library.googleapis.com/Shelf"
110
- # name_descriptor: {
111
- # pattern: "shelves/{shelf}"
112
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
113
- # }
114
- # name_descriptor: {
115
- # pattern: "shelves/{shelf}"
116
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
117
- # }
118
- # };
119
- # }
120
- #
121
- # The ResourceDescriptor Yaml config will look like:
122
- #
123
- # resources:
124
- # - type: 'library.googleapis.com/Shelf'
125
- # name_descriptor:
126
- # - pattern: "shelves/{shelf}"
127
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
128
- # - pattern: "shelves/{shelf}"
129
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
130
69
  # @!attribute [rw] type
131
70
  # @return [::String]
132
71
  # The resource type. It must be in the format of
data/proto_docs/google/logging/v2/log_entry.rb CHANGED
@@ -37,12 +37,13 @@ module Google
37
37
  #
38
38
  # `[LOG_ID]` must be URL-encoded within `log_name`. Example:
39
39
  # `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
40
+ #
40
41
  # `[LOG_ID]` must be less than 512 characters long and can only include the
41
42
  # following characters: upper and lower case alphanumeric characters,
42
43
  # forward-slash, underscore, hyphen, and period.
43
44
  #
44
45
  # For backward compatibility, if `log_name` begins with a forward-slash, such
45
- # as `/projects/...`, then the log entry is ingested as usual but the
46
+ # as `/projects/...`, then the log entry is ingested as usual, but the
46
47
  # forward-slash is removed. Listing the log entry will not show the leading
47
48
  # slash and filtering for a log name with a leading slash will never return
48
49
  # any results.
@@ -98,7 +99,7 @@ module Google
98
99
  # de-duplication in the export of logs.
99
100
  #
100
101
  # If the `insert_id` is omitted when writing a log entry, the Logging API
101
- # assigns its own unique identifier in this field.
102
+ # assigns its own unique identifier in this field.
102
103
  #
103
104
  # In queries, the `insert_id` is also used to order log entries that have
104
105
  # the same `log_name` and `timestamp` values.
@@ -108,8 +109,20 @@ module Google
108
109
  # applicable.
109
110
  # @!attribute [rw] labels
110
111
  # @return [::Google::Protobuf::Map{::String => ::String}]
111
- # Optional. A set of user-defined (key, value) data that provides additional
112
- # information about the log entry.
112
+ # Optional. A map of key, value pairs that provides additional information about the
113
+ # log entry. The labels can be user-defined or system-defined.
114
+ #
115
+ # User-defined labels are arbitrary key, value pairs that you can use to
116
+ # classify logs.
117
+ #
118
+ # System-defined labels are defined by GCP services for platform logs.
119
+ # They have two components - a service namespace component and the
120
+ # attribute name. For example: `compute.googleapis.com/resource_name`.
121
+ #
122
+ # Cloud Logging truncates label keys that exceed 512 B and label
123
+ # values that exceed 64 KB upon their associated log entry being
124
+ # written. The truncation is indicated by an ellipsis at the
125
+ # end of the character string.
113
126
  # @!attribute [rw] operation
114
127
  # @return [::Google::Cloud::Logging::V2::LogEntryOperation]
115
128
  # Optional. Information about an operation associated with the log entry, if
@@ -139,6 +152,10 @@ module Google
139
152
  # @!attribute [rw] source_location
140
153
  # @return [::Google::Cloud::Logging::V2::LogEntrySourceLocation]
141
154
  # Optional. Source code location information associated with the log entry, if any.
155
+ # @!attribute [rw] split
156
+ # @return [::Google::Cloud::Logging::V2::LogSplit]
157
+ # Optional. Information indicating this LogEntry is part of a sequence of multiple log
158
+ # entries split from a single LogEntry.
142
159
  class LogEntry
143
160
  include ::Google::Protobuf::MessageExts
144
161
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -197,6 +214,27 @@ module Google
197
214
  include ::Google::Protobuf::MessageExts
198
215
  extend ::Google::Protobuf::MessageExts::ClassMethods
199
216
  end
217
+
218
+ # Additional information used to correlate multiple log entries. Used when a
219
+ # single LogEntry would exceed the Google Cloud Logging size limit and is
220
+ # split across multiple log entries.
221
+ # @!attribute [rw] uid
222
+ # @return [::String]
223
+ # A globally unique identifier for all log entries in a sequence of split log
224
+ # entries. All log entries with the same |LogSplit.uid| are assumed to be
225
+ # part of the same sequence of split log entries.
226
+ # @!attribute [rw] index
227
+ # @return [::Integer]
228
+ # The index of this LogEntry in the sequence of split log entries. Log
229
+ # entries are given |index| values 0, 1, ..., n-1 for a sequence of n log
230
+ # entries.
231
+ # @!attribute [rw] total_splits
232
+ # @return [::Integer]
233
+ # The total number of log entries that the original LogEntry was split into.
234
+ class LogSplit
235
+ include ::Google::Protobuf::MessageExts
236
+ extend ::Google::Protobuf::MessageExts::ClassMethods
237
+ end
200
238
  end
201
239
  end
202
240
  end
data/proto_docs/google/logging/v2/logging.rb CHANGED
@@ -26,14 +26,15 @@ module Google
26
26
  # @return [::String]
27
27
  # Required. The resource name of the log to delete:
28
28
  #
29
- # "projects/[PROJECT_ID]/logs/[LOG_ID]"
30
- # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
31
- # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
32
- # "folders/[FOLDER_ID]/logs/[LOG_ID]"
29
+ # * `projects/[PROJECT_ID]/logs/[LOG_ID]`
30
+ # * `organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
31
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
32
+ # * `folders/[FOLDER_ID]/logs/[LOG_ID]`
33
33
  #
34
34
  # `[LOG_ID]` must be URL-encoded. For example,
35
35
  # `"projects/my-project-id/logs/syslog"`,
36
- # `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
36
+ # `"organizations/123/logs/cloudaudit.googleapis.com%2Factivity"`.
37
+ #
37
38
  # For more information about log names, see
38
39
  # {::Google::Cloud::Logging::V2::LogEntry LogEntry}.
39
40
  class DeleteLogRequest
@@ -47,15 +48,15 @@ module Google
47
48
  # Optional. A default log resource name that is assigned to all log entries
48
49
  # in `entries` that do not specify a value for `log_name`:
49
50
  #
50
- # "projects/[PROJECT_ID]/logs/[LOG_ID]"
51
- # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
52
- # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
53
- # "folders/[FOLDER_ID]/logs/[LOG_ID]"
51
+ # * `projects/[PROJECT_ID]/logs/[LOG_ID]`
52
+ # * `organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
53
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
54
+ # * `folders/[FOLDER_ID]/logs/[LOG_ID]`
54
55
  #
55
56
  # `[LOG_ID]` must be URL-encoded. For example:
56
57
  #
57
58
  # "projects/my-project-id/logs/syslog"
58
- # "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
59
+ # "organizations/123/logs/cloudaudit.googleapis.com%2Factivity"
59
60
  #
60
61
  # The permission `logging.logEntries.create` is needed on each project,
61
62
  # organization, billing account, or folder that is receiving new log
@@ -93,14 +94,14 @@ module Google
93
94
  # the entries later in the list. See the `entries.list` method.
94
95
  #
95
96
  # Log entries with timestamps that are more than the
96
- # [logs retention period](https://cloud.google.com/logging/quota-policy) in
97
+ # [logs retention period](https://cloud.google.com/logging/quotas) in
97
98
  # the past or more than 24 hours in the future will not be available when
98
99
  # calling `entries.list`. However, those log entries can still be [exported
99
100
  # with
100
101
  # LogSinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
101
102
  #
102
103
  # To improve throughput and to avoid exceeding the
103
- # [quota limit](https://cloud.google.com/logging/quota-policy) for calls to
104
+ # [quota limit](https://cloud.google.com/logging/quotas) for calls to
104
105
  # `entries.write`, you should try to include several log entries in this
105
106
  # list, rather than calling this method for each individual log entry.
106
107
  # @!attribute [rw] partial_success
@@ -164,16 +165,17 @@ module Google
164
165
  # Required. Names of one or more parent resources from which to
165
166
  # retrieve log entries:
166
167
  #
167
- # "projects/[PROJECT_ID]"
168
- # "organizations/[ORGANIZATION_ID]"
169
- # "billingAccounts/[BILLING_ACCOUNT_ID]"
170
- # "folders/[FOLDER_ID]"
168
+ # * `projects/[PROJECT_ID]`
169
+ # * `organizations/[ORGANIZATION_ID]`
170
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]`
171
+ # * `folders/[FOLDER_ID]`
172
+ #
173
+ # May alternatively be one or more views:
171
174
  #
172
- # May alternatively be one or more views
173
- # projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
174
- # organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
175
- # billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
176
- # folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
175
+ # * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
176
+ # * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
177
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
178
+ # * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
177
179
  #
178
180
  # Projects listed in the `project_ids` field are added to this list.
179
181
  # @!attribute [rw] filter
@@ -195,10 +197,10 @@ module Google
195
197
  # timestamps are returned in order of their `insert_id` values.
196
198
  # @!attribute [rw] page_size
197
199
  # @return [::Integer]
198
- # Optional. The maximum number of results to return from this request.
199
- # Default is 50. If the value is negative or exceeds 1000,
200
- # the request is rejected. The presence of `next_page_token` in the
201
- # response indicates that more results might be available.
200
+ # Optional. The maximum number of results to return from this request. Default is 50.
201
+ # If the value is negative or exceeds 1000, the request is rejected. The
202
+ # presence of `next_page_token` in the response indicates that more results
203
+ # might be available.
202
204
  # @!attribute [rw] page_token
203
205
  # @return [::String]
204
206
  # Optional. If present, then retrieve the next batch of results from the
@@ -269,10 +271,10 @@ module Google
269
271
  # @return [::String]
270
272
  # Required. The resource name that owns the logs:
271
273
  #
272
- # "projects/[PROJECT_ID]"
273
- # "organizations/[ORGANIZATION_ID]"
274
- # "billingAccounts/[BILLING_ACCOUNT_ID]"
275
- # "folders/[FOLDER_ID]"
274
+ # * `projects/[PROJECT_ID]`
275
+ # * `organizations/[ORGANIZATION_ID]`
276
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]`
277
+ # * `folders/[FOLDER_ID]`
276
278
  # @!attribute [rw] page_size
277
279
  # @return [::Integer]
278
280
  # Optional. The maximum number of results to return from this request.
@@ -287,16 +289,18 @@ module Google
287
289
  # @!attribute [rw] resource_names
288
290
  # @return [::Array<::String>]
289
291
  # Optional. The resource name that owns the logs:
290
- # projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
291
- # organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
292
- # billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
293
- # folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
292
+ #
293
+ # * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
294
+ # * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
295
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
296
+ # * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
294
297
  #
295
298
  # To support legacy queries, it could also be:
296
- # "projects/[PROJECT_ID]"
297
- # "organizations/[ORGANIZATION_ID]"
298
- # "billingAccounts/[BILLING_ACCOUNT_ID]"
299
- # "folders/[FOLDER_ID]"
299
+ #
300
+ # * `projects/[PROJECT_ID]`
301
+ # * `organizations/[ORGANIZATION_ID]`
302
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]`
303
+ # * `folders/[FOLDER_ID]`
300
304
  class ListLogsRequest
301
305
  include ::Google::Protobuf::MessageExts
302
306
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -323,16 +327,17 @@ module Google
323
327
  # @return [::Array<::String>]
324
328
  # Required. Name of a parent resource from which to retrieve log entries:
325
329
  #
326
- # "projects/[PROJECT_ID]"
327
- # "organizations/[ORGANIZATION_ID]"
328
- # "billingAccounts/[BILLING_ACCOUNT_ID]"
329
- # "folders/[FOLDER_ID]"
330
+ # * `projects/[PROJECT_ID]`
331
+ # * `organizations/[ORGANIZATION_ID]`
332
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]`
333
+ # * `folders/[FOLDER_ID]`
330
334
  #
331
335
  # May alternatively be one or more views:
332
- # "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
333
- # "organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
334
- # "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
335
- # "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
336
+ #
337
+ # * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
338
+ # * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
339
+ # * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
340
+ # * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
336
341
  # @!attribute [rw] filter
337
342
  # @return [::String]
338
343
  # Optional. A filter that chooses which log entries to return. See [Advanced