@maxim_mazurok/gapi.client.observability-v1 0.2.20261029 → 0.2.20261112

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 (2) hide show
  1. package/index.d.ts +316 -1
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://observability.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20261029
12
+ // Revision: 20261112
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -112,6 +112,12 @@ declare namespace gapi.client {
112
112
  /** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */
113
113
  unreachable?: string[];
114
114
  }
115
+ interface ListReportsResponse {
116
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
117
+ nextPageToken?: string;
118
+ /** The list of reports. */
119
+ reports?: Report[];
120
+ }
115
121
  interface ListTraceScopesResponse {
116
122
  /** Optional. If there might be more results than appear in this response, then `next_page_token` is included. To get the next set of results, call the same method again using the value of `next_page_token` as `page_token`. */
117
123
  nextPageToken?: string;
@@ -164,6 +170,44 @@ declare namespace gapi.client {
164
170
  /** Output only. Name of the verb executed by the operation. */
165
171
  verb?: string;
166
172
  }
173
+ interface RenderingOptions {
174
+ /** Optional. Whether widgets within a collapsible group are expanded by default. */
175
+ collapsibleGroupsExpanded?: boolean;
176
+ /** Optional. Whether legends are included on widgets. */
177
+ legendsIncluded?: boolean;
178
+ }
179
+ interface Report {
180
+ /** Output only. When the report was created. */
181
+ createTime?: string;
182
+ /** Output only. The username of the user who created the report. This may be an email or a formatted subject and identity pool identifier. The following are examples: alice.smith@example.com alice.smith@example.com (global/workforcePools/example-com-us-employees) my-workload (projects/1234/locations/global/workloadIdentityPools/example-workload-pool) This value may be empty if the creating user was deleted, or if the username is otherwise unavailable. */
183
+ creatorUsername?: string;
184
+ /** Required. The dashboard to render in the report. Note that dashboards are snapshotted on report creation, so changes to the dashboard after report creation will not be reflected in the report. For example: //monitoring.googleapis.com/projects/my-project/dashboards/my-dashboard */
185
+ dashboard?: string;
186
+ /** Optional. A description of the report. Useful for documenting how the report is intended to be used. */
187
+ description?: string;
188
+ /** Optional. The human readable name of the report. The maximum length is 63 characters. */
189
+ displayName?: string;
190
+ /** Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */
191
+ etag?: string;
192
+ /** Output only. When the report was last successfully run. */
193
+ latestRunTime?: string;
194
+ /** Identifier. The resource name of the report. Format: projects/{project}/locations/{location}/reports/{report} */
195
+ name?: string;
196
+ /** Optional. The list of email addresses to receive the report. */
197
+ recipientEmails?: string[];
198
+ /** Optional. Rendering options for the report. */
199
+ renderingOptions?: RenderingOptions;
200
+ /** Optional. The type of the report. */
201
+ reportType?: 'REPORT_TYPE_UNSPECIFIED' | 'PNG' | 'PDF' | 'HTML';
202
+ /** Optional. The associated cloud scheduling job, if this is a scheduled report. For example: cloudscheduler.googleapis.com/projects/my-project/locations/global/jobs/my-job */
203
+ schedulingJob?: string;
204
+ /** Optional. The time window of the report data, ending at the time the report is generated. If not specified, defaults to the last 7 days. */
205
+ timeWindow?: string;
206
+ /** Output only. The username of the user who updated the report. This may be an email or a formatted subject and identity pool identifier. The following are examples: alice.smith@example.com alice.smith@example.com (global/workforcePools/example-com-us-employees) my-workload (projects/1234/locations/global/workloadIdentityPools/example-workload-pool) This value may be empty if the updating user was deleted, or if the username is otherwise unavailable. */
207
+ updaterUsername?: string;
208
+ /** Output only. When the report was last updated. */
209
+ updateTime?: string;
210
+ }
167
211
  interface ReprovisionBucketRequest {}
168
212
  interface Scope {
169
213
  /** Required. The full resource name of the `logging.googleapis.com/LogScope`. For example: //logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope */
@@ -175,6 +219,7 @@ declare namespace gapi.client {
175
219
  /** Output only. Update timestamp. Note: The Update timestamp for the default scope is initially unset. */
176
220
  updateTime?: string;
177
221
  }
222
+ interface SendReportRequest {}
178
223
  interface Settings {
179
224
  /** Optional. The location which should be used when any regional resources are provisioned by Google Cloud. */
180
225
  defaultStorageLocation?: string;
@@ -1558,6 +1603,275 @@ declare namespace gapi.client {
1558
1603
  uploadType?: string;
1559
1604
  }): Request<ListOperationsResponse>;
1560
1605
  }
1606
+ interface ReportsResource {
1607
+ /** Create a Report. */
1608
+ create(request: {
1609
+ /** V1 error format. */
1610
+ '$.xgafv'?: '1' | '2';
1611
+ /** OAuth access token. */
1612
+ access_token?: string;
1613
+ /** Data format for response. */
1614
+ alt?: 'json' | 'media' | 'proto';
1615
+ /** JSONP */
1616
+ callback?: string;
1617
+ /** Selector specifying which fields to include in a partial response. */
1618
+ fields?: string;
1619
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1620
+ key?: string;
1621
+ /** OAuth 2.0 token for the current user. */
1622
+ oauth_token?: string;
1623
+ /** Required. The full resource name of the location where the report should be created projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global */
1624
+ parent: string;
1625
+ /** Returns response with indentations and line breaks. */
1626
+ prettyPrint?: boolean;
1627
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1628
+ quotaUser?: string;
1629
+ /** Required. A client-assigned identifier for the report. The maximum length is 63 characters. Valid characters are `a-zA-Z0-9-._~%!$&'()*+,;=@` */
1630
+ reportId?: string;
1631
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1632
+ upload_protocol?: string;
1633
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1634
+ uploadType?: string;
1635
+ /** Request body */
1636
+ resource: Report;
1637
+ }): Request<Operation>;
1638
+ create(
1639
+ request: {
1640
+ /** V1 error format. */
1641
+ '$.xgafv'?: '1' | '2';
1642
+ /** OAuth access token. */
1643
+ access_token?: string;
1644
+ /** Data format for response. */
1645
+ alt?: 'json' | 'media' | 'proto';
1646
+ /** JSONP */
1647
+ callback?: string;
1648
+ /** Selector specifying which fields to include in a partial response. */
1649
+ fields?: string;
1650
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1651
+ key?: string;
1652
+ /** OAuth 2.0 token for the current user. */
1653
+ oauth_token?: string;
1654
+ /** Required. The full resource name of the location where the report should be created projects/[PROJECT_ID]/locations/[LOCATION_ID] For example: projects/my-project/locations/global */
1655
+ parent: string;
1656
+ /** Returns response with indentations and line breaks. */
1657
+ prettyPrint?: boolean;
1658
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1659
+ quotaUser?: string;
1660
+ /** Required. A client-assigned identifier for the report. The maximum length is 63 characters. Valid characters are `a-zA-Z0-9-._~%!$&'()*+,;=@` */
1661
+ reportId?: string;
1662
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1663
+ upload_protocol?: string;
1664
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1665
+ uploadType?: string;
1666
+ },
1667
+ body: Report,
1668
+ ): Request<Operation>;
1669
+ /** Deletes a Report resource. */
1670
+ delete(request?: {
1671
+ /** V1 error format. */
1672
+ '$.xgafv'?: '1' | '2';
1673
+ /** OAuth access token. */
1674
+ access_token?: string;
1675
+ /** Data format for response. */
1676
+ alt?: 'json' | 'media' | 'proto';
1677
+ /** JSONP */
1678
+ callback?: string;
1679
+ /** Selector specifying which fields to include in a partial response. */
1680
+ fields?: string;
1681
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1682
+ key?: string;
1683
+ /** Required. The resource name of the report to delete. Format: projects/{project}/locations/{location}/reports/{REPORT_ID} */
1684
+ name: string;
1685
+ /** OAuth 2.0 token for the current user. */
1686
+ oauth_token?: string;
1687
+ /** Returns response with indentations and line breaks. */
1688
+ prettyPrint?: boolean;
1689
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1690
+ quotaUser?: string;
1691
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1692
+ upload_protocol?: string;
1693
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1694
+ uploadType?: string;
1695
+ }): Request<Operation>;
1696
+ /** Report Endpoints Gets a Report resource. */
1697
+ get(request?: {
1698
+ /** V1 error format. */
1699
+ '$.xgafv'?: '1' | '2';
1700
+ /** OAuth access token. */
1701
+ access_token?: string;
1702
+ /** Data format for response. */
1703
+ alt?: 'json' | 'media' | 'proto';
1704
+ /** JSONP */
1705
+ callback?: string;
1706
+ /** Selector specifying which fields to include in a partial response. */
1707
+ fields?: string;
1708
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1709
+ key?: string;
1710
+ /** Required. The resource name of the report to retrieve. Format: projects/{project}/locations/{location}/reports/{REPORT_ID} */
1711
+ name: string;
1712
+ /** OAuth 2.0 token for the current user. */
1713
+ oauth_token?: string;
1714
+ /** Returns response with indentations and line breaks. */
1715
+ prettyPrint?: boolean;
1716
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1717
+ quotaUser?: string;
1718
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1719
+ upload_protocol?: string;
1720
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1721
+ uploadType?: string;
1722
+ }): Request<Report>;
1723
+ /** Lists Report resources */
1724
+ list(request?: {
1725
+ /** V1 error format. */
1726
+ '$.xgafv'?: '1' | '2';
1727
+ /** OAuth access token. */
1728
+ access_token?: string;
1729
+ /** Data format for response. */
1730
+ alt?: 'json' | 'media' | 'proto';
1731
+ /** JSONP */
1732
+ callback?: string;
1733
+ /** Selector specifying which fields to include in a partial response. */
1734
+ fields?: string;
1735
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1736
+ key?: string;
1737
+ /** OAuth 2.0 token for the current user. */
1738
+ oauth_token?: string;
1739
+ /** Optional. The maximum number of results to return from this request. Note that the server may return fewer reports than requested. If unspecified, the server will pick an appropriate default. The maximum value is 100; values above 100 will be coerced to 100. If not provided, the default page size is 10. */
1740
+ pageSize?: number;
1741
+ /** Optional. A page token, received from a previous `ListReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReports` must match the call that provided the page token (except `page_size`, which may differ). */
1742
+ pageToken?: string;
1743
+ /** Required. The scope of reports to list Format: projects/{project}/locations/{location} */
1744
+ parent: string;
1745
+ /** Returns response with indentations and line breaks. */
1746
+ prettyPrint?: boolean;
1747
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1748
+ quotaUser?: string;
1749
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1750
+ upload_protocol?: string;
1751
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1752
+ uploadType?: string;
1753
+ }): Request<ListReportsResponse>;
1754
+ /** Updates a Report resource. */
1755
+ patch(request: {
1756
+ /** V1 error format. */
1757
+ '$.xgafv'?: '1' | '2';
1758
+ /** OAuth access token. */
1759
+ access_token?: string;
1760
+ /** Data format for response. */
1761
+ alt?: 'json' | 'media' | 'proto';
1762
+ /** JSONP */
1763
+ callback?: string;
1764
+ /** Selector specifying which fields to include in a partial response. */
1765
+ fields?: string;
1766
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1767
+ key?: string;
1768
+ /** Identifier. The resource name of the report. Format: projects/{project}/locations/{location}/reports/{report} */
1769
+ name: string;
1770
+ /** OAuth 2.0 token for the current user. */
1771
+ oauth_token?: string;
1772
+ /** Returns response with indentations and line breaks. */
1773
+ prettyPrint?: boolean;
1774
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1775
+ quotaUser?: string;
1776
+ /** Optional. The field mask specifying which fields of the report are to be updated. */
1777
+ updateMask?: string;
1778
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1779
+ upload_protocol?: string;
1780
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1781
+ uploadType?: string;
1782
+ /** Request body */
1783
+ resource: Report;
1784
+ }): Request<Operation>;
1785
+ patch(
1786
+ request: {
1787
+ /** V1 error format. */
1788
+ '$.xgafv'?: '1' | '2';
1789
+ /** OAuth access token. */
1790
+ access_token?: string;
1791
+ /** Data format for response. */
1792
+ alt?: 'json' | 'media' | 'proto';
1793
+ /** JSONP */
1794
+ callback?: string;
1795
+ /** Selector specifying which fields to include in a partial response. */
1796
+ fields?: string;
1797
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1798
+ key?: string;
1799
+ /** Identifier. The resource name of the report. Format: projects/{project}/locations/{location}/reports/{report} */
1800
+ name: string;
1801
+ /** OAuth 2.0 token for the current user. */
1802
+ oauth_token?: string;
1803
+ /** Returns response with indentations and line breaks. */
1804
+ prettyPrint?: boolean;
1805
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1806
+ quotaUser?: string;
1807
+ /** Optional. The field mask specifying which fields of the report are to be updated. */
1808
+ updateMask?: string;
1809
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1810
+ upload_protocol?: string;
1811
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1812
+ uploadType?: string;
1813
+ },
1814
+ body: Report,
1815
+ ): Request<Operation>;
1816
+ /** Sends a Report resource via email. */
1817
+ send(request: {
1818
+ /** V1 error format. */
1819
+ '$.xgafv'?: '1' | '2';
1820
+ /** OAuth access token. */
1821
+ access_token?: string;
1822
+ /** Data format for response. */
1823
+ alt?: 'json' | 'media' | 'proto';
1824
+ /** JSONP */
1825
+ callback?: string;
1826
+ /** Selector specifying which fields to include in a partial response. */
1827
+ fields?: string;
1828
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1829
+ key?: string;
1830
+ /** Required. The resource name of the report to send. Format: projects/{project}/locations/{location}/reports/{REPORT_ID} */
1831
+ name: string;
1832
+ /** OAuth 2.0 token for the current user. */
1833
+ oauth_token?: string;
1834
+ /** Returns response with indentations and line breaks. */
1835
+ prettyPrint?: boolean;
1836
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1837
+ quotaUser?: string;
1838
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1839
+ upload_protocol?: string;
1840
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1841
+ uploadType?: string;
1842
+ /** Request body */
1843
+ resource: SendReportRequest;
1844
+ }): Request<Operation>;
1845
+ send(
1846
+ request: {
1847
+ /** V1 error format. */
1848
+ '$.xgafv'?: '1' | '2';
1849
+ /** OAuth access token. */
1850
+ access_token?: string;
1851
+ /** Data format for response. */
1852
+ alt?: 'json' | 'media' | 'proto';
1853
+ /** JSONP */
1854
+ callback?: string;
1855
+ /** Selector specifying which fields to include in a partial response. */
1856
+ fields?: string;
1857
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1858
+ key?: string;
1859
+ /** Required. The resource name of the report to send. Format: projects/{project}/locations/{location}/reports/{REPORT_ID} */
1860
+ name: string;
1861
+ /** OAuth 2.0 token for the current user. */
1862
+ oauth_token?: string;
1863
+ /** Returns response with indentations and line breaks. */
1864
+ prettyPrint?: boolean;
1865
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1866
+ quotaUser?: string;
1867
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1868
+ upload_protocol?: string;
1869
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1870
+ uploadType?: string;
1871
+ },
1872
+ body: SendReportRequest,
1873
+ ): Request<Operation>;
1874
+ }
1561
1875
  interface ScopesResource {
1562
1876
  /** Gets details of a single Scope. */
1563
1877
  get(request?: {
@@ -2014,6 +2328,7 @@ declare namespace gapi.client {
2014
2328
  ): Request<Operation>;
2015
2329
  buckets: BucketsResource;
2016
2330
  operations: OperationsResource;
2331
+ reports: ReportsResource;
2017
2332
  scopes: ScopesResource;
2018
2333
  traceScopes: TraceScopesResource;
2019
2334
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.observability-v1",
3
- "version": "0.2.20261029",
3
+ "version": "0.2.20261112",
4
4
  "description": "TypeScript typings for Observability API v1",
5
5
  "repository": {
6
6
  "type": "git",