Skip to content

Commit d3548c5

Browse files
feat(logging): update the api
#### logging:v2 The following keys were added: - resources.billingAccounts.resources.locations.resources.operations.methods.cancel (Total Keys: 12) - resources.billingAccounts.resources.locations.resources.operations.methods.list (Total Keys: 18) - resources.billingAccounts.resources.operations.methods.get (Total Keys: 11) - resources.entries.methods.copy (Total Keys: 8) - resources.folders.resources.locations.resources.operations.methods.cancel (Total Keys: 12) - resources.folders.resources.locations.resources.operations.methods.get (Total Keys: 11) - resources.folders.resources.locations.resources.operations.methods.list (Total Keys: 18) - resources.locations.resources.operations.methods.cancel (Total Keys: 12) - resources.locations.resources.operations.methods.get (Total Keys: 11) - resources.locations.resources.operations.methods.list (Total Keys: 18) - resources.organizations.resources.locations.resources.operations.methods.cancel (Total Keys: 12) - resources.organizations.resources.locations.resources.operations.methods.get (Total Keys: 11) - resources.organizations.resources.locations.resources.operations.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.operations.methods.cancel (Total Keys: 12) - resources.projects.resources.locations.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.list (Total Keys: 18) - schemas.CancelOperationRequest (Total Keys: 2) - schemas.CopyLogEntriesMetadata (Total Keys: 12) - schemas.CopyLogEntriesRequest (Total Keys: 5) - schemas.CopyLogEntriesResponse (Total Keys: 4) - schemas.ListOperationsResponse (Total Keys: 5) - schemas.Operation (Total Keys: 9) - schemas.Status (Total Keys: 8)
1 parent 6e29398 commit d3548c5

14 files changed

+1989
-36
lines changed

docs/dyn/logging_v2.billingAccounts.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,11 @@ <h2>Instance Methods</h2>
9494
</p>
9595
<p class="firstline">Returns the logs Resource.</p>
9696

97+
<p class="toc_element">
98+
<code><a href="logging_v2.billingAccounts.operations.html">operations()</a></code>
99+
</p>
100+
<p class="firstline">Returns the operations Resource.</p>
101+
97102
<p class="toc_element">
98103
<code><a href="logging_v2.billingAccounts.sinks.html">sinks()</a></code>
99104
</p>

docs/dyn/logging_v2.billingAccounts.locations.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
7979
</p>
8080
<p class="firstline">Returns the buckets Resource.</p>
8181

82+
<p class="toc_element">
83+
<code><a href="logging_v2.billingAccounts.locations.operations.html">operations()</a></code>
84+
</p>
85+
<p class="firstline">Returns the operations Resource.</p>
86+
8287
<p class="toc_element">
8388
<code><a href="#close">close()</a></code></p>
8489
<p class="firstline">Close httplib2 connections.</p>
Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
</style>
74+
75+
<h1><a href="logging_v2.html">Cloud Logging API</a> . <a href="logging_v2.billingAccounts.html">billingAccounts</a> . <a href="logging_v2.billingAccounts.locations.html">locations</a> . <a href="logging_v2.billingAccounts.locations.operations.html">operations</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.</p>
80+
<p class="toc_element">
81+
<code><a href="#close">close()</a></code></p>
82+
<p class="firstline">Close httplib2 connections.</p>
83+
<p class="toc_element">
84+
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85+
<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.</p>
86+
<p class="toc_element">
87+
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88+
<p class="firstline">Retrieves the next page of results.</p>
89+
<h3>Method Details</h3>
90+
<div class="method">
91+
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
92+
<pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn&#x27;t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
93+
94+
Args:
95+
name: string, The name of the operation resource to be cancelled. (required)
96+
body: object, The request body.
97+
The object takes the form of:
98+
99+
{ # The request message for Operations.CancelOperation.
100+
}
101+
102+
x__xgafv: string, V1 error format.
103+
Allowed values
104+
1 - v1 error format
105+
2 - v2 error format
106+
107+
Returns:
108+
An object of the form:
109+
110+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
111+
}</pre>
112+
</div>
113+
114+
<div class="method">
115+
<code class="details" id="close">close()</code>
116+
<pre>Close httplib2 connections.</pre>
117+
</div>
118+
119+
<div class="method">
120+
<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
121+
<pre>Lists operations that match the specified filter in the request. If the server doesn&#x27;t support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as &quot;/v1/{name=users/*}/operations&quot; to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
122+
123+
Args:
124+
name: string, The name of the operation&#x27;s parent resource. (required)
125+
filter: string, The standard list filter.
126+
pageSize: integer, The standard list page size.
127+
pageToken: string, The standard list page token.
128+
x__xgafv: string, V1 error format.
129+
Allowed values
130+
1 - v1 error format
131+
2 - v2 error format
132+
133+
Returns:
134+
An object of the form:
135+
136+
{ # The response message for Operations.ListOperations.
137+
&quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
138+
&quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
139+
{ # This resource represents a long-running operation that is the result of a network API call.
140+
&quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
141+
&quot;error&quot;: { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
142+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
143+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
144+
{
145+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
146+
},
147+
],
148+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
149+
},
150+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
151+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
152+
},
153+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
154+
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
155+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
156+
},
157+
},
158+
],
159+
}</pre>
160+
</div>
161+
162+
<div class="method">
163+
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
164+
<pre>Retrieves the next page of results.
165+
166+
Args:
167+
previous_request: The request for the previous page. (required)
168+
previous_response: The response from the request for the previous page. (required)
169+
170+
Returns:
171+
A request object that you can call &#x27;execute()&#x27; on to request the next
172+
page. Returns None if there are no more items in the collection.
173+
</pre>
174+
</div>
175+
176+
</body></html>
Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
</style>
74+
75+
<h1><a href="logging_v2.html">Cloud Logging API</a> . <a href="logging_v2.billingAccounts.html">billingAccounts</a> . <a href="logging_v2.billingAccounts.operations.html">operations</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#close">close()</a></code></p>
79+
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p>
83+
<h3>Method Details</h3>
84+
<div class="method">
85+
<code class="details" id="close">close()</code>
86+
<pre>Close httplib2 connections.</pre>
87+
</div>
88+
89+
<div class="method">
90+
<code class="details" id="get">get(name, x__xgafv=None)</code>
91+
<pre>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
92+
93+
Args:
94+
name: string, The name of the operation resource. (required)
95+
x__xgafv: string, V1 error format.
96+
Allowed values
97+
1 - v1 error format
98+
2 - v2 error format
99+
100+
Returns:
101+
An object of the form:
102+
103+
{ # This resource represents a long-running operation that is the result of a network API call.
104+
&quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
105+
&quot;error&quot;: { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
106+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
107+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
108+
{
109+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
110+
},
111+
],
112+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
113+
},
114+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
115+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
116+
},
117+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
118+
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
119+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
120+
},
121+
}</pre>
122+
</div>
123+
124+
</body></html>

docs/dyn/logging_v2.entries.html

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,9 @@ <h2>Instance Methods</h2>
7777
<p class="toc_element">
7878
<code><a href="#close">close()</a></code></p>
7979
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#copy">copy(body=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Copies a set of log entries from a logging bucket to a Cloud Storage bucket.</p>
8083
<p class="toc_element">
8184
<code><a href="#list">list(body=None, x__xgafv=None)</a></code></p>
8285
<p class="firstline">Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs (https://cloud.google.com/logging/docs/export).</p>
@@ -95,6 +98,49 @@ <h3>Method Details</h3>
9598
<pre>Close httplib2 connections.</pre>
9699
</div>
97100

101+
<div class="method">
102+
<code class="details" id="copy">copy(body=None, x__xgafv=None)</code>
103+
<pre>Copies a set of log entries from a logging bucket to a Cloud Storage bucket.
104+
105+
Args:
106+
body: object, The request body.
107+
The object takes the form of:
108+
109+
{ # The parameters to CopyLogEntries.
110+
&quot;destination&quot;: &quot;A String&quot;, # Required. Destination to which to copy logs.
111+
&quot;filter&quot;: &quot;A String&quot;, # Optional. A filter specifying which log entries to copy. The filter must be no more than 20k characters. An empty filter matches all log entries.
112+
&quot;name&quot;: &quot;A String&quot;, # Required. Bucket from which to copy logs. e.g. &quot;projects/my-project/locations/my-location/buckets/my-source-bucket
113+
}
114+
115+
x__xgafv: string, V1 error format.
116+
Allowed values
117+
1 - v1 error format
118+
2 - v2 error format
119+
120+
Returns:
121+
An object of the form:
122+
123+
{ # This resource represents a long-running operation that is the result of a network API call.
124+
&quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
125+
&quot;error&quot;: { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
126+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
127+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
128+
{
129+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
130+
},
131+
],
132+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
133+
},
134+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
135+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
136+
},
137+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
138+
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
139+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
140+
},
141+
}</pre>
142+
</div>
143+
98144
<div class="method">
99145
<code class="details" id="list">list(body=None, x__xgafv=None)</code>
100146
<pre>Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs (https://cloud.google.com/logging/docs/export).

docs/dyn/logging_v2.folders.locations.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
7979
</p>
8080
<p class="firstline">Returns the buckets Resource.</p>
8181

82+
<p class="toc_element">
83+
<code><a href="logging_v2.folders.locations.operations.html">operations()</a></code>
84+
</p>
85+
<p class="firstline">Returns the operations Resource.</p>
86+
8287
<p class="toc_element">
8388
<code><a href="#close">close()</a></code></p>
8489
<p class="firstline">Close httplib2 connections.</p>

0 commit comments

Comments
 (0)