@maxim_mazurok/gapi.client.logging-v2 0.0.20230706 → 0.0.20230720

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 (4) hide show
  1. package/index.d.ts +22 -22
  2. package/package.json +1 -1
  3. package/readme.md +2 -2
  4. package/tests.ts +12 -12
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://logging.googleapis.com/$discovery/rest?version=v2
12
- // Revision: 20230706
12
+ // Revision: 20230720
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -39,9 +39,9 @@ declare namespace gapi.client {
39
39
  usePartitionedTables?:
40
40
  boolean;
41
41
  /**
42
- * Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use.All new sinks will have this field set true and will
43
- * use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field
44
- * set to false.
42
+ * Output only. True if new timestamp column based partitioning is in use, false if legacy ingress-time partitioning is in use.All new sinks will have this field set true and will use
43
+ * timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set
44
+ * to false.
45
45
  */
46
46
  usesTimestampColumnPartitioning?:
47
47
  boolean;
@@ -593,7 +593,7 @@ declare namespace gapi.client {
593
593
  * corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example:
594
594
  * "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity".[LOG_ID] must be less than 512 characters long and can only include the following characters: upper
595
595
  * and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/...,
596
- * then the log entry is ingested as usual, but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash
596
+ * then the log entry is processed as usual, but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash
597
597
  * will never return any results.
598
598
  */
599
599
  logName?:
@@ -647,7 +647,7 @@ declare namespace gapi.client {
647
647
  * Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted
648
648
  * in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp
649
649
  * is displayed.Incoming log entries must have timestamps that don't exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and
650
- * that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging.
650
+ * that don't exceed 24 hours in the future. Log entries outside those time boundaries are rejected by Logging.
651
651
  */
652
652
  timestamp?:
653
653
  string;
@@ -823,9 +823,9 @@ declare namespace gapi.client {
823
823
  string;
824
824
  /**
825
825
  * Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
826
- * "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" "logging.googleapis.com/projects/[PROJECT_ID]" The sink's writer_identity, set when the sink is created, must have
827
- * permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks
828
- * (https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
826
+ * "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" "logging.googleapis.com/projects/[PROJECT_ID]"
827
+ * "logging.googleapis.com/projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" The sink's writer_identity, set when the sink is created, must have permission to write to
828
+ * the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks (https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
829
829
  */
830
830
  destination?:
831
831
  string;
@@ -1197,8 +1197,8 @@ declare namespace gapi.client {
1197
1197
  }
1198
1198
  interface Settings {
1199
1199
  /**
1200
- * Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log ingestion if there
1201
- * is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.
1200
+ * Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is
1201
+ * already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.
1202
1202
  */
1203
1203
  disableDefaultSink?:
1204
1204
  boolean;
@@ -3355,8 +3355,8 @@ declare namespace gapi.client {
3355
3355
  }
3356
3356
  interface SinksResource {
3357
3357
  /**
3358
- * Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted
3359
- * to write to the destination. A sink can export log entries only from the resource owning the sink.
3358
+ * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A
3359
+ * sink can export log entries only from the resource owning the sink.
3360
3360
  */
3361
3361
  create(request: {
3362
3362
  /** V1 error format. */
@@ -4144,7 +4144,7 @@ declare namespace gapi.client {
4144
4144
  string;
4145
4145
  },
4146
4146
  body: ListLogEntriesRequest): Request<ListLogEntriesResponse>;
4147
- /** Streaming read of log entries as they are ingested. Until the stream is terminated, it will continue reading logs. */
4147
+ /** Streaming read of log entries as they are received. Until the stream is terminated, it will continue reading logs. */
4148
4148
  tail(request: {
4149
4149
  /** V1 error format. */
4150
4150
  "$.xgafv"?:
@@ -6603,8 +6603,8 @@ declare namespace gapi.client {
6603
6603
  }
6604
6604
  interface SinksResource {
6605
6605
  /**
6606
- * Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted
6607
- * to write to the destination. A sink can export log entries only from the resource owning the sink.
6606
+ * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A
6607
+ * sink can export log entries only from the resource owning the sink.
6608
6608
  */
6609
6609
  create(request: {
6610
6610
  /** V1 error format. */
@@ -10941,8 +10941,8 @@ declare namespace gapi.client {
10941
10941
  }
10942
10942
  interface SinksResource {
10943
10943
  /**
10944
- * Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted
10945
- * to write to the destination. A sink can export log entries only from the resource owning the sink.
10944
+ * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A
10945
+ * sink can export log entries only from the resource owning the sink.
10946
10946
  */
10947
10947
  create(request: {
10948
10948
  /** V1 error format. */
@@ -14058,8 +14058,8 @@ declare namespace gapi.client {
14058
14058
  }
14059
14059
  interface SinksResource {
14060
14060
  /**
14061
- * Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted
14062
- * to write to the destination. A sink can export log entries only from the resource owning the sink.
14061
+ * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A
14062
+ * sink can export log entries only from the resource owning the sink.
14063
14063
  */
14064
14064
  create(request: {
14065
14065
  /** V1 error format. */
@@ -14697,8 +14697,8 @@ declare namespace gapi.client {
14697
14697
  }
14698
14698
  interface SinksResource {
14699
14699
  /**
14700
- * Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted
14701
- * to write to the destination. A sink can export log entries only from the resource owning the sink.
14700
+ * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A
14701
+ * sink can export log entries only from the resource owning the sink.
14702
14702
  */
14703
14703
  create(request: {
14704
14704
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.logging-v2",
3
- "version": "0.0.20230706",
3
+ "version": "0.0.20230720",
4
4
  "description": "TypeScript typings for Cloud Logging API v2",
5
5
  "license": "MIT",
6
6
  "author": {
package/readme.md CHANGED
@@ -99,7 +99,7 @@ Lists log entries. Use this method to retrieve log entries that originated from
99
99
  await gapi.client.logging.entries.list({ });
100
100
 
101
101
  /*
102
- Streaming read of log entries as they are ingested. Until the stream is terminated, it will continue reading logs.
102
+ Streaming read of log entries as they are received. Until the stream is terminated, it will continue reading logs.
103
103
  */
104
104
  await gapi.client.logging.entries.tail({ });
105
105
 
@@ -204,7 +204,7 @@ Gets the Log Router settings for the given resource.Note: Settings for the Log R
204
204
  await gapi.client.logging.projects.getSettings({ name: "name", });
205
205
 
206
206
  /*
207
- Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.
207
+ Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.
208
208
  */
209
209
  await gapi.client.logging.sinks.create({ parent: "parent", });
210
210
 
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: 20230706
6
+ // Revision: 20230720
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -361,8 +361,8 @@ gapi.load('client', async () => {
361
361
  resourceNames: "Test string",
362
362
  });
363
363
  /**
364
- * Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to
365
- * write to the destination. A sink can export log entries only from the resource owning the sink.
364
+ * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A
365
+ * sink can export log entries only from the resource owning the sink.
366
366
  */
367
367
  await gapi.client.logging.billingAccounts.sinks.create({
368
368
  customWriterIdentity: "Test string",
@@ -502,7 +502,7 @@ gapi.load('client', async () => {
502
502
  "Test string"
503
503
  ],
504
504
  });
505
- /** Streaming read of log entries as they are ingested. Until the stream is terminated, it will continue reading logs. */
505
+ /** Streaming read of log entries as they are received. Until the stream is terminated, it will continue reading logs. */
506
506
  await gapi.client.logging.entries.tail({
507
507
  }, {
508
508
  bufferWindow: "Test string",
@@ -977,8 +977,8 @@ gapi.load('client', async () => {
977
977
  resourceNames: "Test string",
978
978
  });
979
979
  /**
980
- * Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to
981
- * write to the destination. A sink can export log entries only from the resource owning the sink.
980
+ * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A
981
+ * sink can export log entries only from the resource owning the sink.
982
982
  */
983
983
  await gapi.client.logging.folders.sinks.create({
984
984
  customWriterIdentity: "Test string",
@@ -1718,8 +1718,8 @@ gapi.load('client', async () => {
1718
1718
  resourceNames: "Test string",
1719
1719
  });
1720
1720
  /**
1721
- * Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to
1722
- * write to the destination. A sink can export log entries only from the resource owning the sink.
1721
+ * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A
1722
+ * sink can export log entries only from the resource owning the sink.
1723
1723
  */
1724
1724
  await gapi.client.logging.organizations.sinks.create({
1725
1725
  customWriterIdentity: "Test string",
@@ -2291,8 +2291,8 @@ gapi.load('client', async () => {
2291
2291
  version: "Test string",
2292
2292
  });
2293
2293
  /**
2294
- * Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to
2295
- * write to the destination. A sink can export log entries only from the resource owning the sink.
2294
+ * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A
2295
+ * sink can export log entries only from the resource owning the sink.
2296
2296
  */
2297
2297
  await gapi.client.logging.projects.sinks.create({
2298
2298
  customWriterIdentity: "Test string",
@@ -2409,8 +2409,8 @@ gapi.load('client', async () => {
2409
2409
  writerIdentity: "Test string",
2410
2410
  });
2411
2411
  /**
2412
- * Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to
2413
- * write to the destination. A sink can export log entries only from the resource owning the sink.
2412
+ * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A
2413
+ * sink can export log entries only from the resource owning the sink.
2414
2414
  */
2415
2415
  await gapi.client.logging.sinks.create({
2416
2416
  customWriterIdentity: "Test string",