Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathusage.py
More file actions
266 lines (214 loc) · 9.46 KB
/
Copy pathusage.py
File metadata and controls
266 lines (214 loc) · 9.46 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
import httpx
from ..types import usage_list_environment_runtime_records_params
from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
from .._utils import maybe_transform
from .._compat import cached_property
from .._resource import SyncAPIResource, AsyncAPIResource
from .._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from ..pagination import SyncRecordsPage, AsyncRecordsPage
from .._base_client import AsyncPaginator, make_request_options
from ..types.environment_usage_record import EnvironmentUsageRecord
__all__ = ["UsageResource", "AsyncUsageResource"]
class UsageResource(SyncAPIResource):
"""
UsageService provides usage information about environments, users, and projects.
"""
@cached_property
def with_raw_response(self) -> UsageResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return UsageResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> UsageResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return UsageResourceWithStreamingResponse(self)
def list_environment_runtime_records(
self,
*,
token: str | Omit = omit,
page_size: int | Omit = omit,
filter: usage_list_environment_runtime_records_params.Filter | Omit = omit,
pagination: usage_list_environment_runtime_records_params.Pagination | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> SyncRecordsPage[EnvironmentUsageRecord]:
"""
Lists completed environment runtime records within a specified date range.
Returns a list of environment runtime records that were completed within the
specified date range. Records of currently running environments are not
included.
Use this method to:
- View environment runtime records
- Filter by project
- Create custom usage reports
### Example
```yaml
filter:
projectId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
dateRange:
startTime: "2024-01-01T00:00:00Z"
endTime: "2024-01-02T00:00:00Z"
pagination:
pageSize: 100
```
Args:
filter: Filter options.
pagination: Pagination options.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get_api_list(
"/gitpod.v1.UsageService/ListEnvironmentUsageRecords",
page=SyncRecordsPage[EnvironmentUsageRecord],
body=maybe_transform(
{
"filter": filter,
"pagination": pagination,
},
usage_list_environment_runtime_records_params.UsageListEnvironmentRuntimeRecordsParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"token": token,
"page_size": page_size,
},
usage_list_environment_runtime_records_params.UsageListEnvironmentRuntimeRecordsParams,
),
),
model=EnvironmentUsageRecord,
method="post",
)
class AsyncUsageResource(AsyncAPIResource):
"""
UsageService provides usage information about environments, users, and projects.
"""
@cached_property
def with_raw_response(self) -> AsyncUsageResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AsyncUsageResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncUsageResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AsyncUsageResourceWithStreamingResponse(self)
def list_environment_runtime_records(
self,
*,
token: str | Omit = omit,
page_size: int | Omit = omit,
filter: usage_list_environment_runtime_records_params.Filter | Omit = omit,
pagination: usage_list_environment_runtime_records_params.Pagination | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AsyncPaginator[EnvironmentUsageRecord, AsyncRecordsPage[EnvironmentUsageRecord]]:
"""
Lists completed environment runtime records within a specified date range.
Returns a list of environment runtime records that were completed within the
specified date range. Records of currently running environments are not
included.
Use this method to:
- View environment runtime records
- Filter by project
- Create custom usage reports
### Example
```yaml
filter:
projectId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
dateRange:
startTime: "2024-01-01T00:00:00Z"
endTime: "2024-01-02T00:00:00Z"
pagination:
pageSize: 100
```
Args:
filter: Filter options.
pagination: Pagination options.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get_api_list(
"/gitpod.v1.UsageService/ListEnvironmentUsageRecords",
page=AsyncRecordsPage[EnvironmentUsageRecord],
body=maybe_transform(
{
"filter": filter,
"pagination": pagination,
},
usage_list_environment_runtime_records_params.UsageListEnvironmentRuntimeRecordsParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"token": token,
"page_size": page_size,
},
usage_list_environment_runtime_records_params.UsageListEnvironmentRuntimeRecordsParams,
),
),
model=EnvironmentUsageRecord,
method="post",
)
class UsageResourceWithRawResponse:
def __init__(self, usage: UsageResource) -> None:
self._usage = usage
self.list_environment_runtime_records = to_raw_response_wrapper(
usage.list_environment_runtime_records,
)
class AsyncUsageResourceWithRawResponse:
def __init__(self, usage: AsyncUsageResource) -> None:
self._usage = usage
self.list_environment_runtime_records = async_to_raw_response_wrapper(
usage.list_environment_runtime_records,
)
class UsageResourceWithStreamingResponse:
def __init__(self, usage: UsageResource) -> None:
self._usage = usage
self.list_environment_runtime_records = to_streamed_response_wrapper(
usage.list_environment_runtime_records,
)
class AsyncUsageResourceWithStreamingResponse:
def __init__(self, usage: AsyncUsageResource) -> None:
self._usage = usage
self.list_environment_runtime_records = async_to_streamed_response_wrapper(
usage.list_environment_runtime_records,
)
You can’t perform that action at this time.