google-apis-cloudtrace_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 8ec62aa4e7e4fe508f43146f0dfd981c0d6f46e4332ed6033ff8a929d5009852
4
+ data.tar.gz: be04cac0f1211e03ae16f1b73b352a7576d65e78d5f375db0884457ff0ac344f
5
+ SHA512:
6
+ metadata.gz: 63e98b09b496e47618c6b1e14624b2ef026508ff8aade19bc9e59967a4fa85e07ebe1c4bce3a8bc1708ce255a2be3139787bc5cde649798c14517beb9431adcd
7
+ data.tar.gz: fe6aaa3903403d57a7116f91688652802c581919b64cdfc5af47d01e79b4c442c2b20683c5d863525edc2a89f9d5a0e3289e6c969363a9c5d5ef38e2fc7c640e
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-cloudtrace_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/cloudtrace_v1/*.rb
9
+ lib/google/apis/cloudtrace_v1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-cloudtrace_v1
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20200805
7
+
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1 of the Cloud Trace API
2
+
3
+ This is a simple client library for version V1 of the Cloud Trace API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
20
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/cloudtrace.googleapis.com) in the console.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-cloudtrace_v1', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-cloudtrace_v1
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/cloudtrace_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::CloudtraceV1::CloudTraceService.new
52
+
53
+ # Authenticate calls
54
+ client.authentication = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Cloudtrace service in particular.)
67
+
68
+ For reference information on specific calls in the Cloud Trace API, see the {Google::Apis::CloudtraceV1::CloudTraceService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-cloudtrace_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
75
+
76
+ Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
77
+
78
+ Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
79
+
80
+ **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
+
82
+ The [product documentation](https://cloud.google.com/trace) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
87
+
88
+ Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/cloudtrace_v1"
@@ -0,0 +1,46 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/cloudtrace_v1/service.rb'
16
+ require 'google/apis/cloudtrace_v1/classes.rb'
17
+ require 'google/apis/cloudtrace_v1/representations.rb'
18
+ require 'google/apis/cloudtrace_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Cloud Trace API
23
+ #
24
+ # Sends application trace data to Cloud Trace for viewing. Trace data is
25
+ # collected for all App Engine applications by default. Trace data from other
26
+ # applications can be provided using this API. This library is used to interact
27
+ # with the Cloud Trace API directly. If you are looking to instrument your
28
+ # application for Cloud Trace, we recommend using OpenCensus.
29
+ #
30
+ # @see https://cloud.google.com/trace
31
+ module CloudtraceV1
32
+ # Version of the Cloud Trace API this client connects to.
33
+ # This is NOT the gem version.
34
+ VERSION = 'V1'
35
+
36
+ # View and manage your data across Google Cloud Platform services
37
+ AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
38
+
39
+ # Write Trace data for a project or application
40
+ AUTH_TRACE_APPEND = 'https://www.googleapis.com/auth/trace.append'
41
+
42
+ # Read Trace data for a project or application
43
+ AUTH_TRACE_READONLY = 'https://www.googleapis.com/auth/trace.readonly'
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,201 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module CloudtraceV1
24
+
25
+ # A generic empty message that you can re-use to avoid defining duplicated empty
26
+ # messages in your APIs. A typical example is to use it as the request or the
27
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
28
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
29
+ # `Empty` is empty JSON object ````.
30
+ class Empty
31
+ include Google::Apis::Core::Hashable
32
+
33
+ def initialize(**args)
34
+ update!(**args)
35
+ end
36
+
37
+ # Update properties of this object
38
+ def update!(**args)
39
+ end
40
+ end
41
+
42
+ # The response message for the `ListTraces` method.
43
+ class ListTracesResponse
44
+ include Google::Apis::Core::Hashable
45
+
46
+ # If defined, indicates that there are more traces that match the request and
47
+ # that this value should be passed to the next request to continue retrieving
48
+ # additional traces.
49
+ # Corresponds to the JSON property `nextPageToken`
50
+ # @return [String]
51
+ attr_accessor :next_page_token
52
+
53
+ # List of trace records as specified by the view parameter.
54
+ # Corresponds to the JSON property `traces`
55
+ # @return [Array<Google::Apis::CloudtraceV1::Trace>]
56
+ attr_accessor :traces
57
+
58
+ def initialize(**args)
59
+ update!(**args)
60
+ end
61
+
62
+ # Update properties of this object
63
+ def update!(**args)
64
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
65
+ @traces = args[:traces] if args.key?(:traces)
66
+ end
67
+ end
68
+
69
+ # A trace describes how long it takes for an application to perform an operation.
70
+ # It consists of a set of spans, each of which represent a single timed event
71
+ # within the operation.
72
+ class Trace
73
+ include Google::Apis::Core::Hashable
74
+
75
+ # Project ID of the Cloud project where the trace data is stored.
76
+ # Corresponds to the JSON property `projectId`
77
+ # @return [String]
78
+ attr_accessor :project_id
79
+
80
+ # Collection of spans in the trace.
81
+ # Corresponds to the JSON property `spans`
82
+ # @return [Array<Google::Apis::CloudtraceV1::TraceSpan>]
83
+ attr_accessor :spans
84
+
85
+ # Globally unique identifier for the trace. This identifier is a 128-bit numeric
86
+ # value formatted as a 32-byte hex string. For example, `
87
+ # 382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero.
88
+ # Corresponds to the JSON property `traceId`
89
+ # @return [String]
90
+ attr_accessor :trace_id
91
+
92
+ def initialize(**args)
93
+ update!(**args)
94
+ end
95
+
96
+ # Update properties of this object
97
+ def update!(**args)
98
+ @project_id = args[:project_id] if args.key?(:project_id)
99
+ @spans = args[:spans] if args.key?(:spans)
100
+ @trace_id = args[:trace_id] if args.key?(:trace_id)
101
+ end
102
+ end
103
+
104
+ # A span represents a single timed event within a trace. Spans can be nested and
105
+ # form a trace tree. Often, a trace contains a root span that describes the end-
106
+ # to-end latency of an operation and, optionally, one or more subspans for its
107
+ # suboperations. Spans do not need to be contiguous. There may be gaps between
108
+ # spans in a trace.
109
+ class TraceSpan
110
+ include Google::Apis::Core::Hashable
111
+
112
+ # End time of the span in nanoseconds from the UNIX epoch.
113
+ # Corresponds to the JSON property `endTime`
114
+ # @return [String]
115
+ attr_accessor :end_time
116
+
117
+ # Distinguishes between spans generated in a particular context. For example,
118
+ # two spans with the same name may be distinguished using `RPC_CLIENT` and `
119
+ # RPC_SERVER` to identify queueing latency associated with the span.
120
+ # Corresponds to the JSON property `kind`
121
+ # @return [String]
122
+ attr_accessor :kind
123
+
124
+ # Collection of labels associated with the span. Label keys must be less than
125
+ # 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace`
126
+ # values). Some predefined label keys exist, or you may create your own. When
127
+ # creating your own, we recommend the following formats: * `/category/product/
128
+ # key` for agents of well-known products (e.g. `/db/mongodb/read_size`). * `
129
+ # short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`)
130
+ # Predefined labels include: * `/agent` * `/component` * `/error/message` * `/
131
+ # error/name` * `/http/client_city` * `/http/client_country` * `/http/
132
+ # client_protocol` * `/http/client_region` * `/http/host` * `/http/method` * `/
133
+ # http/path` * `/http/redirected_url` * `/http/request/size` * `/http/response/
134
+ # size` * `/http/route` * `/http/status_code` * `/http/url` * `/http/user_agent`
135
+ # * `/pid` * `/stacktrace` * `/tid`
136
+ # Corresponds to the JSON property `labels`
137
+ # @return [Hash<String,String>]
138
+ attr_accessor :labels
139
+
140
+ # Name of the span. Must be less than 128 bytes. The span name is sanitized and
141
+ # displayed in the Trace tool in the Google Cloud Platform Console. The name may
142
+ # be a method name or some other per-call site name. For the same executable and
143
+ # the same call point, a best practice is to use a consistent name, which makes
144
+ # it easier to correlate cross-trace spans.
145
+ # Corresponds to the JSON property `name`
146
+ # @return [String]
147
+ attr_accessor :name
148
+
149
+ # Optional. ID of the parent span, if any.
150
+ # Corresponds to the JSON property `parentSpanId`
151
+ # @return [Fixnum]
152
+ attr_accessor :parent_span_id
153
+
154
+ # Identifier for the span. Must be a 64-bit integer other than 0 and unique
155
+ # within a trace. For example, `2205310701640571284`.
156
+ # Corresponds to the JSON property `spanId`
157
+ # @return [Fixnum]
158
+ attr_accessor :span_id
159
+
160
+ # Start time of the span in nanoseconds from the UNIX epoch.
161
+ # Corresponds to the JSON property `startTime`
162
+ # @return [String]
163
+ attr_accessor :start_time
164
+
165
+ def initialize(**args)
166
+ update!(**args)
167
+ end
168
+
169
+ # Update properties of this object
170
+ def update!(**args)
171
+ @end_time = args[:end_time] if args.key?(:end_time)
172
+ @kind = args[:kind] if args.key?(:kind)
173
+ @labels = args[:labels] if args.key?(:labels)
174
+ @name = args[:name] if args.key?(:name)
175
+ @parent_span_id = args[:parent_span_id] if args.key?(:parent_span_id)
176
+ @span_id = args[:span_id] if args.key?(:span_id)
177
+ @start_time = args[:start_time] if args.key?(:start_time)
178
+ end
179
+ end
180
+
181
+ # List of new or updated traces.
182
+ class Traces
183
+ include Google::Apis::Core::Hashable
184
+
185
+ # List of traces.
186
+ # Corresponds to the JSON property `traces`
187
+ # @return [Array<Google::Apis::CloudtraceV1::Trace>]
188
+ attr_accessor :traces
189
+
190
+ def initialize(**args)
191
+ update!(**args)
192
+ end
193
+
194
+ # Update properties of this object
195
+ def update!(**args)
196
+ @traces = args[:traces] if args.key?(:traces)
197
+ end
198
+ end
199
+ end
200
+ end
201
+ end
@@ -0,0 +1,28 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ module Google
16
+ module Apis
17
+ module CloudtraceV1
18
+ # Version of the google-apis-cloudtrace_v1 gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.1.1"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20200805"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,102 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module CloudtraceV1
24
+
25
+ class Empty
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class ListTracesResponse
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class Trace
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class TraceSpan
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class Traces
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
55
+ class Empty
56
+ # @private
57
+ class Representation < Google::Apis::Core::JsonRepresentation
58
+ end
59
+ end
60
+
61
+ class ListTracesResponse
62
+ # @private
63
+ class Representation < Google::Apis::Core::JsonRepresentation
64
+ property :next_page_token, as: 'nextPageToken'
65
+ collection :traces, as: 'traces', class: Google::Apis::CloudtraceV1::Trace, decorator: Google::Apis::CloudtraceV1::Trace::Representation
66
+
67
+ end
68
+ end
69
+
70
+ class Trace
71
+ # @private
72
+ class Representation < Google::Apis::Core::JsonRepresentation
73
+ property :project_id, as: 'projectId'
74
+ collection :spans, as: 'spans', class: Google::Apis::CloudtraceV1::TraceSpan, decorator: Google::Apis::CloudtraceV1::TraceSpan::Representation
75
+
76
+ property :trace_id, as: 'traceId'
77
+ end
78
+ end
79
+
80
+ class TraceSpan
81
+ # @private
82
+ class Representation < Google::Apis::Core::JsonRepresentation
83
+ property :end_time, as: 'endTime'
84
+ property :kind, as: 'kind'
85
+ hash :labels, as: 'labels'
86
+ property :name, as: 'name'
87
+ property :parent_span_id, :numeric_string => true, as: 'parentSpanId'
88
+ property :span_id, :numeric_string => true, as: 'spanId'
89
+ property :start_time, as: 'startTime'
90
+ end
91
+ end
92
+
93
+ class Traces
94
+ # @private
95
+ class Representation < Google::Apis::Core::JsonRepresentation
96
+ collection :traces, as: 'traces', class: Google::Apis::CloudtraceV1::Trace, decorator: Google::Apis::CloudtraceV1::Trace::Representation
97
+
98
+ end
99
+ end
100
+ end
101
+ end
102
+ end
@@ -0,0 +1,214 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module CloudtraceV1
23
+ # Cloud Trace API
24
+ #
25
+ # Sends application trace data to Cloud Trace for viewing. Trace data is
26
+ # collected for all App Engine applications by default. Trace data from other
27
+ # applications can be provided using this API. This library is used to interact
28
+ # with the Cloud Trace API directly. If you are looking to instrument your
29
+ # application for Cloud Trace, we recommend using OpenCensus.
30
+ #
31
+ # @example
32
+ # require 'google/apis/cloudtrace_v1'
33
+ #
34
+ # Cloudtrace = Google::Apis::CloudtraceV1 # Alias the module
35
+ # service = Cloudtrace::CloudTraceService.new
36
+ #
37
+ # @see https://cloud.google.com/trace
38
+ class CloudTraceService < Google::Apis::Core::BaseService
39
+ # @return [String]
40
+ # API key. Your API key identifies your project and provides you with API access,
41
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
42
+ attr_accessor :key
43
+
44
+ # @return [String]
45
+ # Available to use for quota purposes for server-side applications. Can be any
46
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
47
+ attr_accessor :quota_user
48
+
49
+ def initialize
50
+ super('https://cloudtrace.googleapis.com/', '',
51
+ client_name: 'google-apis-cloudtrace_v1',
52
+ client_version: Google::Apis::CloudtraceV1::GEM_VERSION)
53
+ @batch_path = 'batch'
54
+ end
55
+
56
+ # Sends new traces to Cloud Trace or updates existing traces. If the ID of a
57
+ # trace that you send matches that of an existing trace, any fields in the
58
+ # existing trace and its spans are overwritten by the provided values, and any
59
+ # new fields provided are merged with the existing trace data. If the ID does
60
+ # not match, a new trace is created.
61
+ # @param [String] project_id
62
+ # Required. ID of the Cloud project where the trace data is stored.
63
+ # @param [Google::Apis::CloudtraceV1::Traces] traces_object
64
+ # @param [String] fields
65
+ # Selector specifying which fields to include in a partial response.
66
+ # @param [String] quota_user
67
+ # Available to use for quota purposes for server-side applications. Can be any
68
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
69
+ # @param [Google::Apis::RequestOptions] options
70
+ # Request-specific options
71
+ #
72
+ # @yield [result, err] Result & error if block supplied
73
+ # @yieldparam result [Google::Apis::CloudtraceV1::Empty] parsed result object
74
+ # @yieldparam err [StandardError] error object if request failed
75
+ #
76
+ # @return [Google::Apis::CloudtraceV1::Empty]
77
+ #
78
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
79
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
80
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
81
+ def patch_project_traces(project_id, traces_object = nil, fields: nil, quota_user: nil, options: nil, &block)
82
+ command = make_simple_command(:patch, 'v1/projects/{projectId}/traces', options)
83
+ command.request_representation = Google::Apis::CloudtraceV1::Traces::Representation
84
+ command.request_object = traces_object
85
+ command.response_representation = Google::Apis::CloudtraceV1::Empty::Representation
86
+ command.response_class = Google::Apis::CloudtraceV1::Empty
87
+ command.params['projectId'] = project_id unless project_id.nil?
88
+ command.query['fields'] = fields unless fields.nil?
89
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
90
+ execute_or_queue_command(command, &block)
91
+ end
92
+
93
+ # Gets a single trace by its ID.
94
+ # @param [String] project_id
95
+ # Required. ID of the Cloud project where the trace data is stored.
96
+ # @param [String] trace_id
97
+ # Required. ID of the trace to return.
98
+ # @param [String] fields
99
+ # Selector specifying which fields to include in a partial response.
100
+ # @param [String] quota_user
101
+ # Available to use for quota purposes for server-side applications. Can be any
102
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
103
+ # @param [Google::Apis::RequestOptions] options
104
+ # Request-specific options
105
+ #
106
+ # @yield [result, err] Result & error if block supplied
107
+ # @yieldparam result [Google::Apis::CloudtraceV1::Trace] parsed result object
108
+ # @yieldparam err [StandardError] error object if request failed
109
+ #
110
+ # @return [Google::Apis::CloudtraceV1::Trace]
111
+ #
112
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
113
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
114
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
115
+ def get_project_trace(project_id, trace_id, fields: nil, quota_user: nil, options: nil, &block)
116
+ command = make_simple_command(:get, 'v1/projects/{projectId}/traces/{traceId}', options)
117
+ command.response_representation = Google::Apis::CloudtraceV1::Trace::Representation
118
+ command.response_class = Google::Apis::CloudtraceV1::Trace
119
+ command.params['projectId'] = project_id unless project_id.nil?
120
+ command.params['traceId'] = trace_id unless trace_id.nil?
121
+ command.query['fields'] = fields unless fields.nil?
122
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
123
+ execute_or_queue_command(command, &block)
124
+ end
125
+
126
+ # Returns of a list of traces that match the specified filter conditions.
127
+ # @param [String] project_id
128
+ # Required. ID of the Cloud project where the trace data is stored.
129
+ # @param [String] end_time
130
+ # End of the time interval (inclusive) during which the trace data was collected
131
+ # from the application.
132
+ # @param [String] filter
133
+ # Optional. A filter against labels for the request. By default, searches use
134
+ # prefix matching. To specify exact match, prepend a plus symbol (`+`) to the
135
+ # search term. Multiple terms are ANDed. Syntax: * `root:NAME_PREFIX` or `
136
+ # NAME_PREFIX`: Return traces where any root span starts with `NAME_PREFIX`. * `+
137
+ # root:NAME` or `+NAME`: Return traces where any root span's name is exactly `
138
+ # NAME`. * `span:NAME_PREFIX`: Return traces where any span starts with `
139
+ # NAME_PREFIX`. * `+span:NAME`: Return traces where any span's name is exactly `
140
+ # NAME`. * `latency:DURATION`: Return traces whose overall latency is greater or
141
+ # equal to than `DURATION`. Accepted units are nanoseconds (`ns`), milliseconds (
142
+ # `ms`), and seconds (`s`). Default is `ms`. For example, `latency:24ms` returns
143
+ # traces whose overall latency is greater than or equal to 24 milliseconds. * `
144
+ # label:LABEL_KEY`: Return all traces containing the specified label key (exact
145
+ # match, case-sensitive) regardless of the key:value pair's value (including
146
+ # empty values). * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the
147
+ # specified label key (exact match, case-sensitive) whose value starts with `
148
+ # VALUE_PREFIX`. Both a key and a value must be specified. * `+LABEL_KEY:VALUE`:
149
+ # Return all traces containing a key:value pair exactly matching the specified
150
+ # text. Both a key and a value must be specified. * `method:VALUE`: Equivalent
151
+ # to `/http/method:VALUE`. * `url:VALUE`: Equivalent to `/http/url:VALUE`.
152
+ # @param [String] order_by
153
+ # Optional. Field used to sort the returned traces. Can be one of the following:
154
+ # * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (
155
+ # difference between `end_time` and `start_time` fields of the root span) * `
156
+ # start` (`start_time` field of the root span) Descending order can be specified
157
+ # by appending `desc` to the sort field (for example, `name desc`). Only one
158
+ # sort field is permitted.
159
+ # @param [Fixnum] page_size
160
+ # Optional. Maximum number of traces to return. If not specified or <= 0, the
161
+ # implementation selects a reasonable value. The implementation may return fewer
162
+ # traces than the requested page size.
163
+ # @param [String] page_token
164
+ # Token identifying the page of results to return. If provided, use the value of
165
+ # the `next_page_token` field from a previous request.
166
+ # @param [String] start_time
167
+ # Start of the time interval (inclusive) during which the trace data was
168
+ # collected from the application.
169
+ # @param [String] view
170
+ # Optional. Type of data returned for traces in the list. Default is `MINIMAL`.
171
+ # @param [String] fields
172
+ # Selector specifying which fields to include in a partial response.
173
+ # @param [String] quota_user
174
+ # Available to use for quota purposes for server-side applications. Can be any
175
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
176
+ # @param [Google::Apis::RequestOptions] options
177
+ # Request-specific options
178
+ #
179
+ # @yield [result, err] Result & error if block supplied
180
+ # @yieldparam result [Google::Apis::CloudtraceV1::ListTracesResponse] parsed result object
181
+ # @yieldparam err [StandardError] error object if request failed
182
+ #
183
+ # @return [Google::Apis::CloudtraceV1::ListTracesResponse]
184
+ #
185
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
186
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
187
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
188
+ def list_project_traces(project_id, end_time: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, start_time: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
189
+ command = make_simple_command(:get, 'v1/projects/{projectId}/traces', options)
190
+ command.response_representation = Google::Apis::CloudtraceV1::ListTracesResponse::Representation
191
+ command.response_class = Google::Apis::CloudtraceV1::ListTracesResponse
192
+ command.params['projectId'] = project_id unless project_id.nil?
193
+ command.query['endTime'] = end_time unless end_time.nil?
194
+ command.query['filter'] = filter unless filter.nil?
195
+ command.query['orderBy'] = order_by unless order_by.nil?
196
+ command.query['pageSize'] = page_size unless page_size.nil?
197
+ command.query['pageToken'] = page_token unless page_token.nil?
198
+ command.query['startTime'] = start_time unless start_time.nil?
199
+ command.query['view'] = view unless view.nil?
200
+ command.query['fields'] = fields unless fields.nil?
201
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
202
+ execute_or_queue_command(command, &block)
203
+ end
204
+
205
+ protected
206
+
207
+ def apply_command_defaults(command)
208
+ command.query['key'] = key unless key.nil?
209
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
210
+ end
211
+ end
212
+ end
213
+ end
214
+ end
metadata ADDED
@@ -0,0 +1,76 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-apis-cloudtrace_v1
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Google LLC
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-01-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: google-apis-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.1'
27
+ description: This is the simple REST client for Cloud Trace API V1. Simple REST clients
28
+ are Ruby client libraries that provide access to Google services via their HTTP
29
+ REST API endpoints. These libraries are generated and updated automatically based
30
+ on the discovery documents published by the service, and they handle most concerns
31
+ such as authentication, pagination, retry, timeouts, and logging. You can use this
32
+ client to access the Cloud Trace API, but note that some services may provide a
33
+ separate modern client that is easier to use.
34
+ email: googleapis-packages@google.com
35
+ executables: []
36
+ extensions: []
37
+ extra_rdoc_files: []
38
+ files:
39
+ - ".yardopts"
40
+ - CHANGELOG.md
41
+ - LICENSE.md
42
+ - OVERVIEW.md
43
+ - lib/google-apis-cloudtrace_v1.rb
44
+ - lib/google/apis/cloudtrace_v1.rb
45
+ - lib/google/apis/cloudtrace_v1/classes.rb
46
+ - lib/google/apis/cloudtrace_v1/gem_version.rb
47
+ - lib/google/apis/cloudtrace_v1/representations.rb
48
+ - lib/google/apis/cloudtrace_v1/service.rb
49
+ homepage: https://github.com/google/google-api-ruby-client
50
+ licenses:
51
+ - Apache-2.0
52
+ metadata:
53
+ bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-cloudtrace_v1/CHANGELOG.md
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-cloudtrace_v1/v0.1.0
56
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-cloudtrace_v1
57
+ post_install_message:
58
+ rdoc_options: []
59
+ require_paths:
60
+ - lib
61
+ required_ruby_version: !ruby/object:Gem::Requirement
62
+ requirements:
63
+ - - ">="
64
+ - !ruby/object:Gem::Version
65
+ version: '2.4'
66
+ required_rubygems_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: '0'
71
+ requirements: []
72
+ rubygems_version: 3.1.4
73
+ signing_key:
74
+ specification_version: 4
75
+ summary: Simple REST client for Cloud Trace API V1
76
+ test_files: []