google-cloud-logging 1.5.4 → 1.5.5

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 (28) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -0
  3. data/INSTRUMENTATION.md +1 -1
  4. data/LOGGING.md +1 -1
  5. data/lib/google-cloud-logging.rb +1 -1
  6. data/lib/google/cloud/logging.rb +1 -1
  7. data/lib/google/cloud/logging/logger.rb +27 -18
  8. data/lib/google/cloud/logging/middleware.rb +1 -1
  9. data/lib/google/cloud/logging/rails.rb +1 -1
  10. data/lib/google/cloud/logging/v2/config_service_v2_client.rb +35 -35
  11. data/lib/google/cloud/logging/v2/doc/google/api/distribution.rb +18 -18
  12. data/lib/google/cloud/logging/v2/doc/google/api/metric.rb +69 -48
  13. data/lib/google/cloud/logging/v2/doc/google/api/monitored_resource.rb +20 -21
  14. data/lib/google/cloud/logging/v2/doc/google/logging/type/http_request.rb +5 -5
  15. data/lib/google/cloud/logging/v2/doc/google/logging/v2/log_entry.rb +17 -17
  16. data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb +50 -50
  17. data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging_config.rb +55 -55
  18. data/lib/google/cloud/logging/v2/doc/google/logging/v2/logging_metrics.rb +28 -28
  19. data/lib/google/cloud/logging/v2/doc/google/protobuf/any.rb +8 -8
  20. data/lib/google/cloud/logging/v2/doc/google/protobuf/duration.rb +3 -3
  21. data/lib/google/cloud/logging/v2/doc/google/protobuf/empty.rb +1 -1
  22. data/lib/google/cloud/logging/v2/doc/google/protobuf/field_mask.rb +7 -7
  23. data/lib/google/cloud/logging/v2/doc/google/protobuf/struct.rb +11 -11
  24. data/lib/google/cloud/logging/v2/doc/google/protobuf/timestamp.rb +7 -7
  25. data/lib/google/cloud/logging/v2/logging_service_v2_client.rb +27 -27
  26. data/lib/google/cloud/logging/v2/metrics_service_v2_client.rb +4 -4
  27. data/lib/google/cloud/logging/version.rb +1 -1
  28. metadata +3 -3
@@ -24,73 +24,74 @@ module Google
24
24
  # @!attribute [rw] type
25
25
  # @return [String]
26
26
  # The metric type, including its DNS name prefix. The type is not
27
- # URL-encoded. All user-defined custom metric types have the DNS name
28
- # +custom.googleapis.com+. Metric types should use a natural hierarchical
29
- # grouping. For example:
27
+ # URL-encoded. All user-defined metric types have the DNS name
28
+ # `custom.googleapis.com` or `external.googleapis.com`. Metric types should
29
+ # use a natural hierarchical grouping. For example:
30
30
  #
31
31
  # "custom.googleapis.com/invoice/paid/amount"
32
+ # "external.googleapis.com/prometheus/up"
32
33
  # "appengine.googleapis.com/http/server/response_latencies"
33
34
  # @!attribute [rw] labels
34
35
  # @return [Array<Google::Api::LabelDescriptor>]
35
36
  # The set of labels that can be used to describe a specific
36
37
  # instance of this metric type. For example, the
37
- # +appengine.googleapis.com/http/server/response_latencies+ metric
38
- # type has a label for the HTTP response code, +response_code+, so
38
+ # `appengine.googleapis.com/http/server/response_latencies` metric
39
+ # type has a label for the HTTP response code, `response_code`, so
39
40
  # you can look at latencies for successful responses or just
40
41
  # for responses that failed.
41
42
  # @!attribute [rw] metric_kind
42
43
  # @return [Google::Api::MetricDescriptor::MetricKind]
43
44
  # Whether the metric records instantaneous values, changes to a value, etc.
44
- # Some combinations of +metric_kind+ and +value_type+ might not be supported.
45
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
45
46
  # @!attribute [rw] value_type
46
47
  # @return [Google::Api::MetricDescriptor::ValueType]
47
48
  # Whether the measurement is an integer, a floating-point number, etc.
48
- # Some combinations of +metric_kind+ and +value_type+ might not be supported.
49
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
49
50
  # @!attribute [rw] unit
50
51
  # @return [String]
51
52
  # The unit in which the metric value is reported. It is only applicable
52
- # if the +value_type+ is +INT64+, +DOUBLE+, or +DISTRIBUTION+. The
53
+ # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
53
54
  # supported units are a subset of [The Unified Code for Units of
54
55
  # Measure](http://unitsofmeasure.org/ucum.html) standard:
55
56
  #
56
57
  # **Basic units (UNIT)**
57
58
  #
58
- # * +bit+ bit
59
- # * +By+ byte
60
- # * +s+ second
61
- # * +min+ minute
62
- # * +h+ hour
63
- # * +d+ day
59
+ # * `bit` bit
60
+ # * `By` byte
61
+ # * `s` second
62
+ # * `min` minute
63
+ # * `h` hour
64
+ # * `d` day
64
65
  #
65
66
  # **Prefixes (PREFIX)**
66
67
  #
67
- # * +k+ kilo (10**3)
68
- # * +M+ mega (10**6)
69
- # * +G+ giga (10**9)
70
- # * +T+ tera (10**12)
71
- # * +P+ peta (10**15)
72
- # * +E+ exa (10**18)
73
- # * +Z+ zetta (10**21)
74
- # * +Y+ yotta (10**24)
75
- # * +m+ milli (10**-3)
76
- # * +u+ micro (10**-6)
77
- # * +n+ nano (10**-9)
78
- # * +p+ pico (10**-12)
79
- # * +f+ femto (10**-15)
80
- # * +a+ atto (10**-18)
81
- # * +z+ zepto (10**-21)
82
- # * +y+ yocto (10**-24)
83
- # * +Ki+ kibi (2**10)
84
- # * +Mi+ mebi (2**20)
85
- # * +Gi+ gibi (2**30)
86
- # * +Ti+ tebi (2**40)
68
+ # * `k` kilo (10**3)
69
+ # * `M` mega (10**6)
70
+ # * `G` giga (10**9)
71
+ # * `T` tera (10**12)
72
+ # * `P` peta (10**15)
73
+ # * `E` exa (10**18)
74
+ # * `Z` zetta (10**21)
75
+ # * `Y` yotta (10**24)
76
+ # * `m` milli (10**-3)
77
+ # * `u` micro (10**-6)
78
+ # * `n` nano (10**-9)
79
+ # * `p` pico (10**-12)
80
+ # * `f` femto (10**-15)
81
+ # * `a` atto (10**-18)
82
+ # * `z` zepto (10**-21)
83
+ # * `y` yocto (10**-24)
84
+ # * `Ki` kibi (2**10)
85
+ # * `Mi` mebi (2**20)
86
+ # * `Gi` gibi (2**30)
87
+ # * `Ti` tebi (2**40)
87
88
  #
88
89
  # **Grammar**
89
90
  #
90
91
  # The grammar also includes these connectors:
91
92
  #
92
- # * +/+ division (as an infix operator, e.g. +1/s+).
93
- # * +.+ multiplication (as an infix operator, e.g. +GBy.d+)
93
+ # * `/` division (as an infix operator, e.g. `1/s`).
94
+ # * `.` multiplication (as an infix operator, e.g. `GBy.d`)
94
95
  #
95
96
  # The grammar for a unit is as follows:
96
97
  #
@@ -105,13 +106,13 @@ module Google
105
106
  #
106
107
  # Notes:
107
108
  #
108
- # * +Annotation+ is just a comment if it follows a +UNIT+ and is
109
- # equivalent to +1+ if it is used alone. For examples,
110
- # +\\{requests}/s == 1/s+, +By\\{transmitted}/s == By/s+.
111
- # * +NAME+ is a sequence of non-blank printable ASCII characters not
109
+ # * `Annotation` is just a comment if it follows a `UNIT` and is
110
+ # equivalent to `1` if it is used alone. For examples,
111
+ # `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
112
+ # * `NAME` is a sequence of non-blank printable ASCII characters not
112
113
  # containing '{' or '}'.
113
- # * +1+ represents dimensionless value 1, such as in +1/s+.
114
- # * +%+ represents dimensionless value 1/100, and annotates values giving
114
+ # * `1` represents dimensionless value 1, such as in `1/s`.
115
+ # * `%` represents dimensionless value 1/100, and annotates values giving
115
116
  # a percentage.
116
117
  # @!attribute [rw] description
117
118
  # @return [String]
@@ -122,7 +123,27 @@ module Google
122
123
  # Use sentence case without an ending period, for example "Request count".
123
124
  # This field is optional but it is recommended to be set for any metrics
124
125
  # associated with user-visible concepts, such as Quota.
126
+ # @!attribute [rw] metadata
127
+ # @return [Google::Api::MetricDescriptor::MetricDescriptorMetadata]
128
+ # Optional. Metadata which can be used to guide usage of the metric.
125
129
  class MetricDescriptor
130
+ # Additional annotations that can be used to guide the usage of a metric.
131
+ # @!attribute [rw] launch_stage
132
+ # @return [Google::Api::LaunchStage]
133
+ # The launch stage of the metric definition.
134
+ # @!attribute [rw] sample_period
135
+ # @return [Google::Protobuf::Duration]
136
+ # The sampling period of metric data points. For metrics which are written
137
+ # periodically, consecutive data points are stored at this time interval,
138
+ # excluding data loss due to errors. Metrics with a higher granularity have
139
+ # a smaller sampling period.
140
+ # @!attribute [rw] ingest_delay
141
+ # @return [Google::Protobuf::Duration]
142
+ # The delay of data points caused by ingestion. Data points older than this
143
+ # age are guaranteed to be ingested and available to be read, excluding
144
+ # data loss due to errors.
145
+ class MetricDescriptorMetadata; end
146
+
126
147
  # The kind of measurement. It describes how the data is reported.
127
148
  module MetricKind
128
149
  # Do not use this default value.
@@ -148,7 +169,7 @@ module Google
148
169
  VALUE_TYPE_UNSPECIFIED = 0
149
170
 
150
171
  # The value is a boolean.
151
- # This value type can be used only if the metric kind is +GAUGE+.
172
+ # This value type can be used only if the metric kind is `GAUGE`.
152
173
  BOOL = 1
153
174
 
154
175
  # The value is a signed 64-bit integer.
@@ -158,10 +179,10 @@ module Google
158
179
  DOUBLE = 3
159
180
 
160
181
  # The value is a text string.
161
- # This value type can be used only if the metric kind is +GAUGE+.
182
+ # This value type can be used only if the metric kind is `GAUGE`.
162
183
  STRING = 4
163
184
 
164
- # The value is a {Google::Api::Distribution +Distribution+}.
185
+ # The value is a {Google::Api::Distribution `Distribution`}.
165
186
  DISTRIBUTION = 5
166
187
 
167
188
  # The value is money.
@@ -170,15 +191,15 @@ module Google
170
191
  end
171
192
 
172
193
  # A specific metric, identified by specifying values for all of the
173
- # labels of a {Google::Api::MetricDescriptor +MetricDescriptor+}.
194
+ # labels of a {Google::Api::MetricDescriptor `MetricDescriptor`}.
174
195
  # @!attribute [rw] type
175
196
  # @return [String]
176
197
  # An existing metric type, see {Google::Api::MetricDescriptor}.
177
- # For example, +custom.googleapis.com/invoice/paid/amount+.
198
+ # For example, `custom.googleapis.com/invoice/paid/amount`.
178
199
  # @!attribute [rw] labels
179
200
  # @return [Hash{String => String}]
180
201
  # The set of label values that uniquely identify this metric. All
181
- # labels listed in the +MetricDescriptor+ must be assigned values.
202
+ # labels listed in the `MetricDescriptor` must be assigned values.
182
203
  class Metric; end
183
204
  end
184
205
  end
@@ -18,31 +18,31 @@ module Google
18
18
  # An object that describes the schema of a {Google::Api::MonitoredResource MonitoredResource} object using a
19
19
  # type name and a set of labels. For example, the monitored resource
20
20
  # descriptor for Google Compute Engine VM instances has a type of
21
- # +"gce_instance"+ and specifies the use of the labels +"instance_id"+ and
22
- # +"zone"+ to identify particular VM instances.
21
+ # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
22
+ # `"zone"` to identify particular VM instances.
23
23
  #
24
24
  # Different APIs can support different monitored resource types. APIs generally
25
- # provide a +list+ method that returns the monitored resource descriptors used
25
+ # provide a `list` method that returns the monitored resource descriptors used
26
26
  # by the API.
27
27
  # @!attribute [rw] name
28
28
  # @return [String]
29
29
  # Optional. The resource name of the monitored resource descriptor:
30
- # +"projects/\\{project_id}/monitoredResourceDescriptors/\\{type}"+ where
31
- # \\{type} is the value of the +type+ field in this object and
30
+ # `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
31
+ # \\{type} is the value of the `type` field in this object and
32
32
  # \\{project_id} is a project ID that provides API-specific context for
33
33
  # accessing the type. APIs that do not use project information can use the
34
- # resource name format +"monitoredResourceDescriptors/\\{type}"+.
34
+ # resource name format `"monitoredResourceDescriptors/{type}"`.
35
35
  # @!attribute [rw] type
36
36
  # @return [String]
37
37
  # Required. The monitored resource type. For example, the type
38
- # +"cloudsql_database"+ represents databases in Google Cloud SQL.
38
+ # `"cloudsql_database"` represents databases in Google Cloud SQL.
39
39
  # The maximum length of this value is 256 characters.
40
40
  # @!attribute [rw] display_name
41
41
  # @return [String]
42
42
  # Optional. A concise name for the monitored resource type that might be
43
43
  # displayed in user interfaces. It should be a Title Cased Noun Phrase,
44
44
  # without any article or other determiners. For example,
45
- # +"Google Cloud SQL Database"+.
45
+ # `"Google Cloud SQL Database"`.
46
46
  # @!attribute [rw] description
47
47
  # @return [String]
48
48
  # Optional. A detailed description of the monitored resource type that might
@@ -51,18 +51,18 @@ module Google
51
51
  # @return [Array<Google::Api::LabelDescriptor>]
52
52
  # Required. A set of labels used to describe instances of this monitored
53
53
  # resource type. For example, an individual Google Cloud SQL database is
54
- # identified by values for the labels +"database_id"+ and +"zone"+.
54
+ # identified by values for the labels `"database_id"` and `"zone"`.
55
55
  class MonitoredResourceDescriptor; end
56
56
 
57
57
  # An object representing a resource that can be used for monitoring, logging,
58
58
  # billing, or other purposes. Examples include virtual machine instances,
59
- # databases, and storage devices such as disks. The +type+ field identifies a
59
+ # databases, and storage devices such as disks. The `type` field identifies a
60
60
  # {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object that describes the resource's
61
- # schema. Information in the +labels+ field identifies the actual resource and
61
+ # schema. Information in the `labels` field identifies the actual resource and
62
62
  # its attributes according to the schema. For example, a particular Compute
63
63
  # Engine VM instance could be represented by the following object, because the
64
- # {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} for +"gce_instance"+ has labels
65
- # +"instance_id"+ and +"zone"+:
64
+ # {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} for `"gce_instance"` has labels
65
+ # `"instance_id"` and `"zone"`:
66
66
  #
67
67
  # { "type": "gce_instance",
68
68
  # "labels": { "instance_id": "12345678901234",
@@ -70,27 +70,26 @@ module Google
70
70
  # @!attribute [rw] type
71
71
  # @return [String]
72
72
  # Required. The monitored resource type. This field must match
73
- # the +type+ field of a {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object. For
74
- # example, the type of a Compute Engine VM instance is +gce_instance+.
73
+ # the `type` field of a {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object. For
74
+ # example, the type of a Compute Engine VM instance is `gce_instance`.
75
75
  # @!attribute [rw] labels
76
76
  # @return [Hash{String => String}]
77
77
  # Required. Values for all of the labels listed in the associated monitored
78
78
  # resource descriptor. For example, Compute Engine VM instances use the
79
- # labels +"project_id"+, +"instance_id"+, and +"zone"+.
79
+ # labels `"project_id"`, `"instance_id"`, and `"zone"`.
80
80
  class MonitoredResource; end
81
81
 
82
82
  # Auxiliary metadata for a {Google::Api::MonitoredResource MonitoredResource} object.
83
83
  # {Google::Api::MonitoredResource MonitoredResource} objects contain the minimum set of information to
84
84
  # uniquely identify a monitored resource instance. There is some other useful
85
- # auxiliary metadata. Google Stackdriver Monitoring & Logging uses an ingestion
86
- # pipeline to extract metadata for cloud resources of all types , and stores
85
+ # auxiliary metadata. Monitoring and Logging use an ingestion
86
+ # pipeline to extract metadata for cloud resources of all types, and store
87
87
  # the metadata in this message.
88
88
  # @!attribute [rw] system_labels
89
89
  # @return [Google::Protobuf::Struct]
90
90
  # Output only. Values for predefined system metadata labels.
91
- # System labels are a kind of metadata extracted by Google Stackdriver.
92
- # Stackdriver determines what system labels are useful and how to obtain
93
- # their values. Some examples: "machine_image", "vpc", "subnet_id",
91
+ # System labels are a kind of metadata extracted by Google, including
92
+ # "machine_image", "vpc", "subnet_id",
94
93
  # "security_group", "name", etc.
95
94
  # System label values can be only strings, Boolean values, or a list of
96
95
  # strings. For example:
@@ -21,12 +21,12 @@ module Google
21
21
  # information MUST be defined in a separate message.
22
22
  # @!attribute [rw] request_method
23
23
  # @return [String]
24
- # The request method. Examples: +"GET"+, +"HEAD"+, +"PUT"+, +"POST"+.
24
+ # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
25
25
  # @!attribute [rw] request_url
26
26
  # @return [String]
27
27
  # The scheme (http, https), the host name, the path and the query
28
28
  # portion of the URL that was requested.
29
- # Example: +"http://example.com/some/info?color=red"+.
29
+ # Example: `"http://example.com/some/info?color=red"`.
30
30
  # @!attribute [rw] request_size
31
31
  # @return [Integer]
32
32
  # The size of the HTTP request message in bytes, including the request
@@ -42,11 +42,11 @@ module Google
42
42
  # @!attribute [rw] user_agent
43
43
  # @return [String]
44
44
  # The user agent sent by the client. Example:
45
- # +"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"+.
45
+ # `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
46
46
  # @!attribute [rw] remote_ip
47
47
  # @return [String]
48
48
  # The IP address (IPv4 or IPv6) of the client that issued the HTTP
49
- # request. Examples: +"192.168.1.1"+, +"FE80::0202:B3FF:FE1E:8329"+.
49
+ # request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
50
50
  # @!attribute [rw] server_ip
51
51
  # @return [String]
52
52
  # The IP address (IPv4 or IPv6) of the origin server that the request was
@@ -69,7 +69,7 @@ module Google
69
69
  # @!attribute [rw] cache_validated_with_origin_server
70
70
  # @return [true, false]
71
71
  # Whether or not the response was validated with the origin server before
72
- # being served from cache. This field is only meaningful if +cache_hit+ is
72
+ # being served from cache. This field is only meaningful if `cache_hit` is
73
73
  # True.
74
74
  # @!attribute [rw] cache_fill_bytes
75
75
  # @return [Integer]
@@ -28,16 +28,16 @@ module Google
28
28
  #
29
29
  # A project number may optionally be used in place of PROJECT_ID. The
30
30
  # project number is translated to its corresponding PROJECT_ID internally
31
- # and the +log_name+ field will contain PROJECT_ID in queries and exports.
31
+ # and the `log_name` field will contain PROJECT_ID in queries and exports.
32
32
  #
33
- # +[LOG_ID]+ must be URL-encoded within +log_name+. Example:
34
- # +"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"+.
35
- # +[LOG_ID]+ must be less than 512 characters long and can only include the
33
+ # `[LOG_ID]` must be URL-encoded within `log_name`. Example:
34
+ # `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
35
+ # `[LOG_ID]` must be less than 512 characters long and can only include the
36
36
  # following characters: upper and lower case alphanumeric characters,
37
37
  # forward-slash, underscore, hyphen, and period.
38
38
  #
39
- # For backward compatibility, if +log_name+ begins with a forward-slash, such
40
- # as +/projects/...+, then the log entry is ingested as usual but the
39
+ # For backward compatibility, if `log_name` begins with a forward-slash, such
40
+ # as `/projects/...`, then the log entry is ingested as usual but the
41
41
  # forward-slash is removed. Listing the log entry will not show the leading
42
42
  # slash and filtering for a log name with a leading slash will never return
43
43
  # any results.
@@ -71,7 +71,7 @@ module Google
71
71
  # Incoming log entries should have timestamps that are no more than
72
72
  # the [logs retention period](https://cloud.google.com/logging/quotas) in the past,
73
73
  # and no more than 24 hours in the future. Log entries outside those time
74
- # boundaries will not be available when calling +entries.list+, but
74
+ # boundaries will not be available when calling `entries.list`, but
75
75
  # those log entries can still be exported with
76
76
  # [LogSinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
77
77
  # @!attribute [rw] receive_timestamp
@@ -80,15 +80,15 @@ module Google
80
80
  # @!attribute [rw] severity
81
81
  # @return [Google::Logging::Type::LogSeverity]
82
82
  # Optional. The severity of the log entry. The default value is
83
- # +LogSeverity.DEFAULT+.
83
+ # `LogSeverity.DEFAULT`.
84
84
  # @!attribute [rw] insert_id
85
85
  # @return [String]
86
86
  # Optional. A unique identifier for the log entry. If you provide a value,
87
87
  # then Stackdriver Logging considers other log entries in the same project,
88
- # with the same +timestamp+, and with the same +insert_id+ to be duplicates
88
+ # with the same `timestamp`, and with the same `insert_id` to be duplicates
89
89
  # which can be removed. If omitted in new log entries, then Stackdriver
90
- # Logging assigns its own unique identifier. The +insert_id+ is also used
91
- # to order log entries that have the same +timestamp+ value.
90
+ # Logging assigns its own unique identifier. The `insert_id` is also used
91
+ # to order log entries that have the same `timestamp` value.
92
92
  # @!attribute [rw] http_request
93
93
  # @return [Google::Logging::Type::HttpRequest]
94
94
  # Optional. Information about the HTTP request associated with this
@@ -100,7 +100,7 @@ module Google
100
100
  # @!attribute [rw] metadata
101
101
  # @return [Google::Api::MonitoredResourceMetadata]
102
102
  # Output only. Additional metadata about the monitored resource.
103
- # Only +k8s_container+, +k8s_pod+, and +k8s_node+ MonitoredResources have
103
+ # Only `k8s_container`, `k8s_pod`, and `k8s_node` MonitoredResources have
104
104
  # this field populated.
105
105
  # @!attribute [rw] operation
106
106
  # @return [Google::Logging::V2::LogEntryOperation]
@@ -110,8 +110,8 @@ module Google
110
110
  # @return [String]
111
111
  # Optional. Resource name of the trace associated with the log entry, if any.
112
112
  # If it contains a relative resource name, the name is assumed to be relative
113
- # to +//tracing.googleapis.com+. Example:
114
- # +projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824+
113
+ # to `//tracing.googleapis.com`. Example:
114
+ # `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`
115
115
  # @!attribute [rw] span_id
116
116
  # @return [String]
117
117
  # Optional. The span ID within the trace associated with the log entry. For
@@ -133,8 +133,8 @@ module Google
133
133
  # @!attribute [rw] producer
134
134
  # @return [String]
135
135
  # Optional. An arbitrary producer identifier. The combination of
136
- # +id+ and +producer+ must be globally unique. Examples for +producer+:
137
- # +"MyDivision.MyBigCompany.com"+, +"github.com/MyProject/MyApplication"+.
136
+ # `id` and `producer` must be globally unique. Examples for `producer`:
137
+ # `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`.
138
138
  # @!attribute [rw] first
139
139
  # @return [true, false]
140
140
  # Optional. Set this to True if this is the first log entry in the operation.
@@ -159,7 +159,7 @@ module Google
159
159
  # optional context such as the class or package name. This information may be
160
160
  # used in contexts such as the logs viewer, where a file and line number are
161
161
  # less meaningful. The format can vary by language. For example:
162
- # +qual.if.ied.Class.method+ (Java), +dir/package.func+ (Go), +function+
162
+ # `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function`
163
163
  # (Python).
164
164
  class LogEntrySourceLocation; end
165
165
  end
@@ -26,9 +26,9 @@ module Google
26
26
  # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
27
27
  # "folders/[FOLDER_ID]/logs/[LOG_ID]"
28
28
  #
29
- # +[LOG_ID]+ must be URL-encoded. For example,
30
- # +"projects/my-project-id/logs/syslog"+,
31
- # +"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"+.
29
+ # `[LOG_ID]` must be URL-encoded. For example,
30
+ # `"projects/my-project-id/logs/syslog"`,
31
+ # `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
32
32
  # For more information about log names, see
33
33
  # {Google::Logging::V2::LogEntry LogEntry}.
34
34
  class DeleteLogRequest; end
@@ -37,22 +37,22 @@ module Google
37
37
  # @!attribute [rw] log_name
38
38
  # @return [String]
39
39
  # Optional. A default log resource name that is assigned to all log entries
40
- # in +entries+ that do not specify a value for +log_name+:
40
+ # in `entries` that do not specify a value for `log_name`:
41
41
  #
42
42
  # "projects/[PROJECT_ID]/logs/[LOG_ID]"
43
43
  # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
44
44
  # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
45
45
  # "folders/[FOLDER_ID]/logs/[LOG_ID]"
46
46
  #
47
- # +[LOG_ID]+ must be URL-encoded. For example,
48
- # +"projects/my-project-id/logs/syslog"+ or
49
- # +"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"+.
47
+ # `[LOG_ID]` must be URL-encoded. For example,
48
+ # `"projects/my-project-id/logs/syslog"` or
49
+ # `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
50
50
  # For more information about log names, see
51
51
  # {Google::Logging::V2::LogEntry LogEntry}.
52
52
  # @!attribute [rw] resource
53
53
  # @return [Google::Api::MonitoredResource]
54
54
  # Optional. A default monitored resource object that is assigned to all log
55
- # entries in +entries+ that do not specify a value for +resource+. Example:
55
+ # entries in `entries` that do not specify a value for `resource`. Example:
56
56
  #
57
57
  # { "type": "gce_instance",
58
58
  # "labels": {
@@ -61,33 +61,33 @@ module Google
61
61
  # See {Google::Logging::V2::LogEntry LogEntry}.
62
62
  # @!attribute [rw] labels
63
63
  # @return [Hash{String => String}]
64
- # Optional. Default labels that are added to the +labels+ field of all log
65
- # entries in +entries+. If a log entry already has a label with the same key
64
+ # Optional. Default labels that are added to the `labels` field of all log
65
+ # entries in `entries`. If a log entry already has a label with the same key
66
66
  # as a label in this parameter, then the log entry's label is not changed.
67
67
  # See {Google::Logging::V2::LogEntry LogEntry}.
68
68
  # @!attribute [rw] entries
69
69
  # @return [Array<Google::Logging::V2::LogEntry>]
70
70
  # Required. The log entries to send to Stackdriver Logging. The order of log
71
71
  # entries in this list does not matter. Values supplied in this method's
72
- # +log_name+, +resource+, and +labels+ fields are copied into those log
72
+ # `log_name`, `resource`, and `labels` fields are copied into those log
73
73
  # entries in this list that do not include values for their corresponding
74
74
  # fields. For more information, see the
75
75
  # {Google::Logging::V2::LogEntry LogEntry} type.
76
76
  #
77
- # If the +timestamp+ or +insert_id+ fields are missing in log entries, then
77
+ # If the `timestamp` or `insert_id` fields are missing in log entries, then
78
78
  # this method supplies the current time or a unique identifier, respectively.
79
79
  # The supplied values are chosen so that, among the log entries that did not
80
80
  # supply their own values, the entries earlier in the list will sort before
81
- # the entries later in the list. See the +entries.list+ method.
81
+ # the entries later in the list. See the `entries.list` method.
82
82
  #
83
83
  # Log entries with timestamps that are more than the
84
84
  # [logs retention period](https://cloud.google.com/logging/quota-policy) in the past or more than
85
- # 24 hours in the future will not be available when calling +entries.list+.
85
+ # 24 hours in the future will not be available when calling `entries.list`.
86
86
  # However, those log entries can still be exported with
87
87
  # [LogSinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
88
88
  #
89
89
  # To improve throughput and to avoid exceeding the
90
- # [quota limit](https://cloud.google.com/logging/quota-policy) for calls to +entries.write+,
90
+ # [quota limit](https://cloud.google.com/logging/quota-policy) for calls to `entries.write`,
91
91
  # you should try to include several log entries in this list,
92
92
  # rather than calling this method for each individual log entry.
93
93
  # @!attribute [rw] partial_success
@@ -96,7 +96,7 @@ module Google
96
96
  # entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
97
97
  # entry is not written, then the response status is the error associated
98
98
  # with one of the failed entries and the response includes error details
99
- # keyed by the entries' zero-based index in the +entries.write+ method.
99
+ # keyed by the entries' zero-based index in the `entries.write` method.
100
100
  # @!attribute [rw] dry_run
101
101
  # @return [true, false]
102
102
  # Optional. If true, the request should expect normal response, but the
@@ -111,22 +111,22 @@ module Google
111
111
  # Error details for WriteLogEntries with partial success.
112
112
  # @!attribute [rw] log_entry_errors
113
113
  # @return [Hash{Integer => Google::Rpc::Status}]
114
- # When +WriteLogEntriesRequest.partial_success+ is true, records the error
114
+ # When `WriteLogEntriesRequest.partial_success` is true, records the error
115
115
  # status for entries that were not written due to a permanent error, keyed
116
- # by the entry's zero-based index in +WriteLogEntriesRequest.entries+.
116
+ # by the entry's zero-based index in `WriteLogEntriesRequest.entries`.
117
117
  #
118
118
  # Failed requests for which no entries are written will not include
119
119
  # per-entry errors.
120
120
  class WriteLogEntriesPartialErrors; end
121
121
 
122
- # The parameters to +ListLogEntries+.
122
+ # The parameters to `ListLogEntries`.
123
123
  # @!attribute [rw] project_ids
124
124
  # @return [Array<String>]
125
- # Deprecated. Use +resource_names+ instead. One or more project identifiers
125
+ # Deprecated. Use `resource_names` instead. One or more project identifiers
126
126
  # or project numbers from which to retrieve log entries. Example:
127
- # +"my-project-1A"+. If present, these project identifiers are converted to
127
+ # `"my-project-1A"`. If present, these project identifiers are converted to
128
128
  # resource name format and added to the list of resources in
129
- # +resource_names+.
129
+ # `resource_names`.
130
130
  # @!attribute [rw] resource_names
131
131
  # @return [Array<String>]
132
132
  # Required. Names of one or more parent resources from which to
@@ -137,53 +137,53 @@ module Google
137
137
  # "billingAccounts/[BILLING_ACCOUNT_ID]"
138
138
  # "folders/[FOLDER_ID]"
139
139
  #
140
- # Projects listed in the +project_ids+ field are added to this list.
140
+ # Projects listed in the `project_ids` field are added to this list.
141
141
  # @!attribute [rw] filter
142
142
  # @return [String]
143
143
  # Optional. A filter that chooses which log entries to return. See [Advanced
144
144
  # Logs Filters](/logging/docs/view/advanced_filters). Only log entries that
145
145
  # match the filter are returned. An empty filter matches all log entries in
146
- # the resources listed in +resource_names+. Referencing a parent resource
147
- # that is not listed in +resource_names+ will cause the filter to return no
146
+ # the resources listed in `resource_names`. Referencing a parent resource
147
+ # that is not listed in `resource_names` will cause the filter to return no
148
148
  # results.
149
149
  # The maximum length of the filter is 20000 characters.
150
150
  # @!attribute [rw] order_by
151
151
  # @return [String]
152
152
  # Optional. How the results should be sorted. Presently, the only permitted
153
- # values are +"timestamp asc"+ (default) and +"timestamp desc"+. The first
153
+ # values are `"timestamp asc"` (default) and `"timestamp desc"`. The first
154
154
  # option returns entries in order of increasing values of
155
- # +LogEntry.timestamp+ (oldest first), and the second option returns entries
155
+ # `LogEntry.timestamp` (oldest first), and the second option returns entries
156
156
  # in order of decreasing timestamps (newest first). Entries with equal
157
- # timestamps are returned in order of their +insert_id+ values.
157
+ # timestamps are returned in order of their `insert_id` values.
158
158
  # @!attribute [rw] page_size
159
159
  # @return [Integer]
160
160
  # Optional. The maximum number of results to return from this request.
161
- # Non-positive values are ignored. The presence of +next_page_token+ in the
161
+ # Non-positive values are ignored. The presence of `next_page_token` in the
162
162
  # response indicates that more results might be available.
163
163
  # @!attribute [rw] page_token
164
164
  # @return [String]
165
165
  # Optional. If present, then retrieve the next batch of results from the
166
- # preceding call to this method. +page_token+ must be the value of
167
- # +next_page_token+ from the previous response. The values of other method
166
+ # preceding call to this method. `page_token` must be the value of
167
+ # `next_page_token` from the previous response. The values of other method
168
168
  # parameters should be identical to those in the previous call.
169
169
  class ListLogEntriesRequest; end
170
170
 
171
- # Result returned from +ListLogEntries+.
171
+ # Result returned from `ListLogEntries`.
172
172
  # @!attribute [rw] entries
173
173
  # @return [Array<Google::Logging::V2::LogEntry>]
174
- # A list of log entries. If +entries+ is empty, +nextPageToken+ may still be
175
- # returned, indicating that more entries may exist. See +nextPageToken+ for
174
+ # A list of log entries. If `entries` is empty, `nextPageToken` may still be
175
+ # returned, indicating that more entries may exist. See `nextPageToken` for
176
176
  # more information.
177
177
  # @!attribute [rw] next_page_token
178
178
  # @return [String]
179
179
  # If there might be more results than those appearing in this response, then
180
- # +nextPageToken+ is included. To get the next set of results, call this
181
- # method again using the value of +nextPageToken+ as +pageToken+.
180
+ # `nextPageToken` is included. To get the next set of results, call this
181
+ # method again using the value of `nextPageToken` as `pageToken`.
182
182
  #
183
- # If a value for +next_page_token+ appears and the +entries+ field is empty,
183
+ # If a value for `next_page_token` appears and the `entries` field is empty,
184
184
  # it means that the search found no log entries so far but it did not have
185
185
  # time to search all the possible log entries. Retry the method with this
186
- # value for +page_token+ to continue the search. Alternatively, consider
186
+ # value for `page_token` to continue the search. Alternatively, consider
187
187
  # speeding up the search by changing your filter to specify a single log name
188
188
  # or resource type, or to narrow the time range of the search.
189
189
  class ListLogEntriesResponse; end
@@ -192,13 +192,13 @@ module Google
192
192
  # @!attribute [rw] page_size
193
193
  # @return [Integer]
194
194
  # Optional. The maximum number of results to return from this request.
195
- # Non-positive values are ignored. The presence of +nextPageToken+ in the
195
+ # Non-positive values are ignored. The presence of `nextPageToken` in the
196
196
  # response indicates that more results might be available.
197
197
  # @!attribute [rw] page_token
198
198
  # @return [String]
199
199
  # Optional. If present, then retrieve the next batch of results from the
200
- # preceding call to this method. +pageToken+ must be the value of
201
- # +nextPageToken+ from the previous response. The values of other method
200
+ # preceding call to this method. `pageToken` must be the value of
201
+ # `nextPageToken` from the previous response. The values of other method
202
202
  # parameters should be identical to those in the previous call.
203
203
  class ListMonitoredResourceDescriptorsRequest; end
204
204
 
@@ -209,8 +209,8 @@ module Google
209
209
  # @!attribute [rw] next_page_token
210
210
  # @return [String]
211
211
  # If there might be more results than those appearing in this response, then
212
- # +nextPageToken+ is included. To get the next set of results, call this
213
- # method again using the value of +nextPageToken+ as +pageToken+.
212
+ # `nextPageToken` is included. To get the next set of results, call this
213
+ # method again using the value of `nextPageToken` as `pageToken`.
214
214
  class ListMonitoredResourceDescriptorsResponse; end
215
215
 
216
216
  # The parameters to ListLogs.
@@ -225,13 +225,13 @@ module Google
225
225
  # @!attribute [rw] page_size
226
226
  # @return [Integer]
227
227
  # Optional. The maximum number of results to return from this request.
228
- # Non-positive values are ignored. The presence of +nextPageToken+ in the
228
+ # Non-positive values are ignored. The presence of `nextPageToken` in the
229
229
  # response indicates that more results might be available.
230
230
  # @!attribute [rw] page_token
231
231
  # @return [String]
232
232
  # Optional. If present, then retrieve the next batch of results from the
233
- # preceding call to this method. +pageToken+ must be the value of
234
- # +nextPageToken+ from the previous response. The values of other method
233
+ # preceding call to this method. `pageToken` must be the value of
234
+ # `nextPageToken` from the previous response. The values of other method
235
235
  # parameters should be identical to those in the previous call.
236
236
  class ListLogsRequest; end
237
237
 
@@ -239,13 +239,13 @@ module Google
239
239
  # @!attribute [rw] log_names
240
240
  # @return [Array<String>]
241
241
  # A list of log names. For example,
242
- # +"projects/my-project/syslog"+ or
243
- # +"organizations/123/cloudresourcemanager.googleapis.com%2Factivity"+.
242
+ # `"projects/my-project/syslog"` or
243
+ # `"organizations/123/cloudresourcemanager.googleapis.com%2Factivity"`.
244
244
  # @!attribute [rw] next_page_token
245
245
  # @return [String]
246
246
  # If there might be more results than those appearing in this response, then
247
- # +nextPageToken+ is included. To get the next set of results, call this
248
- # method again using the value of +nextPageToken+ as +pageToken+.
247
+ # `nextPageToken` is included. To get the next set of results, call this
248
+ # method again using the value of `nextPageToken` as `pageToken`.
249
249
  class ListLogsResponse; end
250
250
  end
251
251
  end