@maxim_mazurok/gapi.client.cloudtasks-v2 0.0.20230927 → 0.0.20231018
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.
- package/index.d.ts +146 -3
- package/package.json +1 -1
- package/tests.ts +21 -3
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://cloudtasks.googleapis.com/$discovery/rest?version=v2
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20231018
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -139,6 +139,17 @@ declare namespace gapi.client {
|
|
|
139
139
|
role?:
|
|
140
140
|
string;
|
|
141
141
|
}
|
|
142
|
+
interface CmekConfig {
|
|
143
|
+
/**
|
|
144
|
+
* Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues & Tasks
|
|
145
|
+
* in the region. Setting this as blank will turn off CMEK encryption.
|
|
146
|
+
*/
|
|
147
|
+
kmsKey?:
|
|
148
|
+
string;
|
|
149
|
+
/** Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` */
|
|
150
|
+
name?:
|
|
151
|
+
string;
|
|
152
|
+
}
|
|
142
153
|
interface CreateTaskRequest {
|
|
143
154
|
/**
|
|
144
155
|
* The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as
|
|
@@ -974,8 +985,11 @@ declare namespace gapi.client {
|
|
|
974
985
|
},
|
|
975
986
|
body: Queue): Request<Queue>;
|
|
976
987
|
/**
|
|
977
|
-
* Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name
|
|
978
|
-
*
|
|
988
|
+
* Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, you may be prevented from creating a new queue with the same name as the
|
|
989
|
+
* deleted queue for a tombstone window of up to 3 days. During this window, the CreateQueue operation may appear to recreate the queue, but this can be misleading. If you attempt to
|
|
990
|
+
* create a queue with the same name as one that is in the tombstone window, run GetQueue to confirm that the queue creation was successful. If GetQueue returns 200 response code, your
|
|
991
|
+
* queue was successfully created with the name of the previously deleted queue. Otherwise, your queue did not successfully recreate. WARNING: Using this method may have unintended
|
|
992
|
+
* side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and
|
|
979
993
|
* queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method.
|
|
980
994
|
*/
|
|
981
995
|
delete(request?: {
|
|
@@ -1652,6 +1666,45 @@ declare namespace gapi.client {
|
|
|
1652
1666
|
uploadType?:
|
|
1653
1667
|
string;
|
|
1654
1668
|
}): Request<Location>;
|
|
1669
|
+
/** Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured. */
|
|
1670
|
+
getCmekConfig(request?: {
|
|
1671
|
+
/** V1 error format. */
|
|
1672
|
+
"$.xgafv"?:
|
|
1673
|
+
string;
|
|
1674
|
+
/** OAuth access token. */
|
|
1675
|
+
access_token?:
|
|
1676
|
+
string;
|
|
1677
|
+
/** Data format for response. */
|
|
1678
|
+
alt?:
|
|
1679
|
+
string;
|
|
1680
|
+
/** JSONP */
|
|
1681
|
+
callback?:
|
|
1682
|
+
string;
|
|
1683
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1684
|
+
fields?:
|
|
1685
|
+
string;
|
|
1686
|
+
/** 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. */
|
|
1687
|
+
key?:
|
|
1688
|
+
string;
|
|
1689
|
+
/** Required. The config. For example: projects/PROJECT_ID/locations/LOCATION_ID/CmekConfig` */
|
|
1690
|
+
name:
|
|
1691
|
+
string;
|
|
1692
|
+
/** OAuth 2.0 token for the current user. */
|
|
1693
|
+
oauth_token?:
|
|
1694
|
+
string;
|
|
1695
|
+
/** Returns response with indentations and line breaks. */
|
|
1696
|
+
prettyPrint?:
|
|
1697
|
+
boolean;
|
|
1698
|
+
/** 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. */
|
|
1699
|
+
quotaUser?:
|
|
1700
|
+
string;
|
|
1701
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1702
|
+
upload_protocol?:
|
|
1703
|
+
string;
|
|
1704
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1705
|
+
uploadType?:
|
|
1706
|
+
string;
|
|
1707
|
+
}): Request<CmekConfig>;
|
|
1655
1708
|
/** Lists information about the supported locations for this service. */
|
|
1656
1709
|
list(request?: {
|
|
1657
1710
|
/** V1 error format. */
|
|
@@ -1703,6 +1756,96 @@ declare namespace gapi.client {
|
|
|
1703
1756
|
uploadType?:
|
|
1704
1757
|
string;
|
|
1705
1758
|
}): Request<ListLocationsResponse>;
|
|
1759
|
+
/**
|
|
1760
|
+
* Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks
|
|
1761
|
+
* created in the location will be encrypted at-rest with the KMS-key provided in the config.
|
|
1762
|
+
*/
|
|
1763
|
+
updateCmekConfig(request: {
|
|
1764
|
+
/** V1 error format. */
|
|
1765
|
+
"$.xgafv"?:
|
|
1766
|
+
string;
|
|
1767
|
+
/** OAuth access token. */
|
|
1768
|
+
access_token?:
|
|
1769
|
+
string;
|
|
1770
|
+
/** Data format for response. */
|
|
1771
|
+
alt?:
|
|
1772
|
+
string;
|
|
1773
|
+
/** JSONP */
|
|
1774
|
+
callback?:
|
|
1775
|
+
string;
|
|
1776
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1777
|
+
fields?:
|
|
1778
|
+
string;
|
|
1779
|
+
/** 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. */
|
|
1780
|
+
key?:
|
|
1781
|
+
string;
|
|
1782
|
+
/** Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` */
|
|
1783
|
+
name:
|
|
1784
|
+
string;
|
|
1785
|
+
/** OAuth 2.0 token for the current user. */
|
|
1786
|
+
oauth_token?:
|
|
1787
|
+
string;
|
|
1788
|
+
/** Returns response with indentations and line breaks. */
|
|
1789
|
+
prettyPrint?:
|
|
1790
|
+
boolean;
|
|
1791
|
+
/** 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. */
|
|
1792
|
+
quotaUser?:
|
|
1793
|
+
string;
|
|
1794
|
+
/** List of fields to be updated in this request. */
|
|
1795
|
+
updateMask?:
|
|
1796
|
+
string;
|
|
1797
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1798
|
+
upload_protocol?:
|
|
1799
|
+
string;
|
|
1800
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1801
|
+
uploadType?:
|
|
1802
|
+
string;
|
|
1803
|
+
/** Request body */
|
|
1804
|
+
resource:
|
|
1805
|
+
CmekConfig;
|
|
1806
|
+
}): Request<CmekConfig>;
|
|
1807
|
+
updateCmekConfig(request: {
|
|
1808
|
+
/** V1 error format. */
|
|
1809
|
+
"$.xgafv"?:
|
|
1810
|
+
string;
|
|
1811
|
+
/** OAuth access token. */
|
|
1812
|
+
access_token?:
|
|
1813
|
+
string;
|
|
1814
|
+
/** Data format for response. */
|
|
1815
|
+
alt?:
|
|
1816
|
+
string;
|
|
1817
|
+
/** JSONP */
|
|
1818
|
+
callback?:
|
|
1819
|
+
string;
|
|
1820
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1821
|
+
fields?:
|
|
1822
|
+
string;
|
|
1823
|
+
/** 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. */
|
|
1824
|
+
key?:
|
|
1825
|
+
string;
|
|
1826
|
+
/** Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` */
|
|
1827
|
+
name:
|
|
1828
|
+
string;
|
|
1829
|
+
/** OAuth 2.0 token for the current user. */
|
|
1830
|
+
oauth_token?:
|
|
1831
|
+
string;
|
|
1832
|
+
/** Returns response with indentations and line breaks. */
|
|
1833
|
+
prettyPrint?:
|
|
1834
|
+
boolean;
|
|
1835
|
+
/** 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. */
|
|
1836
|
+
quotaUser?:
|
|
1837
|
+
string;
|
|
1838
|
+
/** List of fields to be updated in this request. */
|
|
1839
|
+
updateMask?:
|
|
1840
|
+
string;
|
|
1841
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1842
|
+
upload_protocol?:
|
|
1843
|
+
string;
|
|
1844
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1845
|
+
uploadType?:
|
|
1846
|
+
string;
|
|
1847
|
+
},
|
|
1848
|
+
body: CmekConfig): Request<CmekConfig>;
|
|
1706
1849
|
queues:
|
|
1707
1850
|
QueuesResource;
|
|
1708
1851
|
}
|
package/package.json
CHANGED
package/tests.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
4
4
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
5
5
|
|
|
6
|
-
// Revision:
|
|
6
|
+
// Revision: 20231018
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -33,6 +33,10 @@ gapi.load('client', async () => {
|
|
|
33
33
|
await gapi.client.cloudtasks.projects.locations.get({
|
|
34
34
|
name: "Test string",
|
|
35
35
|
});
|
|
36
|
+
/** Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured. */
|
|
37
|
+
await gapi.client.cloudtasks.projects.locations.getCmekConfig({
|
|
38
|
+
name: "Test string",
|
|
39
|
+
});
|
|
36
40
|
/** Lists information about the supported locations for this service. */
|
|
37
41
|
await gapi.client.cloudtasks.projects.locations.list({
|
|
38
42
|
filter: "Test string",
|
|
@@ -40,6 +44,17 @@ gapi.load('client', async () => {
|
|
|
40
44
|
pageSize: 42,
|
|
41
45
|
pageToken: "Test string",
|
|
42
46
|
});
|
|
47
|
+
/**
|
|
48
|
+
* Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created
|
|
49
|
+
* in the location will be encrypted at-rest with the KMS-key provided in the config.
|
|
50
|
+
*/
|
|
51
|
+
await gapi.client.cloudtasks.projects.locations.updateCmekConfig({
|
|
52
|
+
name: "Test string",
|
|
53
|
+
updateMask: "Test string",
|
|
54
|
+
}, {
|
|
55
|
+
kmsKey: "Test string",
|
|
56
|
+
name: "Test string",
|
|
57
|
+
});
|
|
43
58
|
/**
|
|
44
59
|
* Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was
|
|
45
60
|
* dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of
|
|
@@ -74,8 +89,11 @@ gapi.load('client', async () => {
|
|
|
74
89
|
state: "Test string",
|
|
75
90
|
});
|
|
76
91
|
/**
|
|
77
|
-
* Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue,
|
|
78
|
-
*
|
|
92
|
+
* Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, you may be prevented from creating a new queue with the same name as the
|
|
93
|
+
* deleted queue for a tombstone window of up to 3 days. During this window, the CreateQueue operation may appear to recreate the queue, but this can be misleading. If you attempt to
|
|
94
|
+
* create a queue with the same name as one that is in the tombstone window, run GetQueue to confirm that the queue creation was successful. If GetQueue returns 200 response code, your
|
|
95
|
+
* queue was successfully created with the name of the previously deleted queue. Otherwise, your queue did not successfully recreate. WARNING: Using this method may have unintended side
|
|
96
|
+
* effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and
|
|
79
97
|
* queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method.
|
|
80
98
|
*/
|
|
81
99
|
await gapi.client.cloudtasks.projects.locations.queues.delete({
|