Skip to content

Commit e22bef0

Browse files
yoshi-automationsofisl
authored andcommitted
fix(gkebackup): update the API
#### gkebackup:v1 The following keys were changed: - resources.projects.resources.locations.resources.operations.methods.cancel.description - schemas.Backup.properties.stateReason.description - schemas.BackupPlan.properties.stateReason.description - schemas.ClusterResourceRestoreScope.description - schemas.OperationMetadata.properties.requestedCancellation.description - schemas.Restore.properties.state.enum - schemas.Restore.properties.state.enumDescriptions - schemas.Restore.properties.stateReason.description - schemas.RestorePlan.properties.stateReason.description - schemas.TimeOfDay.properties.hours.description - schemas.TimeOfDay.properties.minutes.description - schemas.TimeOfDay.properties.nanos.description - schemas.TimeOfDay.properties.seconds.description - schemas.VolumeBackup.properties.stateMessage.description
1 parent 6bf407a commit e22bef0

File tree

2 files changed

+29
-27
lines changed

2 files changed

+29
-27
lines changed

‎discovery/gkebackup-v1.json

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -894,7 +894,7 @@
894894
"operations": {
895895
"methods": {
896896
"cancel": {
897-
"description": "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`.",
897+
"description": "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`.",
898898
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
899899
"httpMethod": "POST",
900900
"id": "gkebackup.projects.locations.operations.cancel",
@@ -1713,7 +1713,7 @@
17131713
}
17141714
}
17151715
},
1716-
"revision": "20240626",
1716+
"revision": "20250101",
17171717
"rootUrl": "https://gkebackup.googleapis.com/",
17181718
"schemas": {
17191719
"AuditConfig": {
@@ -1914,7 +1914,7 @@
19141914
"type": "string"
19151915
},
19161916
"stateReason": {
1917-
"description": "Output only. Human-readable description of why the backup is in the current `state`.",
1917+
"description": "Output only. Human-readable description of why the backup is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.",
19181918
"readOnly": true,
19191919
"type": "string"
19201920
},
@@ -2065,7 +2065,7 @@
20652065
"type": "string"
20662066
},
20672067
"stateReason": {
2068-
"description": "Output only. Human-readable description of why BackupPlan is in the current `state`",
2068+
"description": "Output only. Human-readable description of why BackupPlan is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.",
20692069
"readOnly": true,
20702070
"type": "string"
20712071
},
@@ -2141,7 +2141,7 @@
21412141
"type": "object"
21422142
},
21432143
"ClusterResourceRestoreScope": {
2144-
"description": "Defines the scope of cluster-scoped resources to restore. Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore \"all valid\" resources automatically excludes these group kinds. - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - Node - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here. - Namespace - PersistentVolume",
2144+
"description": "Defines the scope of cluster-scoped resources to restore. Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore \"all valid\" resources automatically excludes these group kinds. - Node - ComponentStatus - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode - storage.k8s.io/VolumeAttachment Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here. - Namespace - PersistentVolume",
21452145
"id": "ClusterResourceRestoreScope",
21462146
"properties": {
21472147
"allGroupKinds": {
@@ -2686,7 +2686,7 @@
26862686
"type": "string"
26872687
},
26882688
"requestedCancellation": {
2689-
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
2689+
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
26902690
"readOnly": true,
26912691
"type": "boolean"
26922692
},
@@ -2871,21 +2871,23 @@
28712871
"IN_PROGRESS",
28722872
"SUCCEEDED",
28732873
"FAILED",
2874-
"DELETING"
2874+
"DELETING",
2875+
"VALIDATING"
28752876
],
28762877
"enumDescriptions": [
28772878
"The Restore resource is in the process of being created.",
28782879
"The Restore resource has been created and the associated RestoreJob Kubernetes resource has been injected into target cluster.",
28792880
"The gkebackup agent in the cluster has begun executing the restore operation.",
28802881
"The restore operation has completed successfully. Restored workloads may not yet be operational.",
28812882
"The restore operation has failed.",
2882-
"This Restore resource is in the process of being deleted."
2883+
"This Restore resource is in the process of being deleted.",
2884+
"The Kubernetes resources created by this Restore are being validated."
28832885
],
28842886
"readOnly": true,
28852887
"type": "string"
28862888
},
28872889
"stateReason": {
2888-
"description": "Output only. Human-readable description of why the Restore is in its current state.",
2890+
"description": "Output only. Human-readable description of why the Restore is in its current state. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.",
28892891
"readOnly": true,
28902892
"type": "string"
28912893
},
@@ -3099,7 +3101,7 @@
30993101
"type": "string"
31003102
},
31013103
"stateReason": {
3102-
"description": "Output only. Human-readable description of why RestorePlan is in the current `state`",
3104+
"description": "Output only. Human-readable description of why RestorePlan is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.",
31033105
"readOnly": true,
31043106
"type": "string"
31053107
},
@@ -3264,22 +3266,22 @@
32643266
"id": "TimeOfDay",
32653267
"properties": {
32663268
"hours": {
3267-
"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
3269+
"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
32683270
"format": "int32",
32693271
"type": "integer"
32703272
},
32713273
"minutes": {
3272-
"description": "Minutes of hour of day. Must be from 0 to 59.",
3274+
"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.",
32733275
"format": "int32",
32743276
"type": "integer"
32753277
},
32763278
"nanos": {
3277-
"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
3279+
"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.",
32783280
"format": "int32",
32793281
"type": "integer"
32803282
},
32813283
"seconds": {
3282-
"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.",
3284+
"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.",
32833285
"format": "int32",
32843286
"type": "integer"
32853287
}
@@ -3423,7 +3425,7 @@
34233425
"type": "string"
34243426
},
34253427
"stateMessage": {
3426-
"description": "Output only. A human readable message explaining why the VolumeBackup is in its current state.",
3428+
"description": "Output only. A human readable message explaining why the VolumeBackup is in its current state. This field is only meant for human consumption and should not be used programmatically as this field is not guaranteed to be consistent.",
34273429
"readOnly": true,
34283430
"type": "string"
34293431
},

‎src/apis/gkebackup/v1.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ export namespace gkebackup_v1 {
251251
*/
252252
state?: string | null;
253253
/**
254-
* Output only. Human-readable description of why the backup is in the current `state`.
254+
* Output only. Human-readable description of why the backup is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.
255255
*/
256256
stateReason?: string | null;
257257
/**
@@ -361,7 +361,7 @@ export namespace gkebackup_v1 {
361361
*/
362362
state?: string | null;
363363
/**
364-
* Output only. Human-readable description of why BackupPlan is in the current `state`
364+
* Output only. Human-readable description of why BackupPlan is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.
365365
*/
366366
stateReason?: string | null;
367367
/**
@@ -416,7 +416,7 @@ export namespace gkebackup_v1 {
416416
k8sVersion?: string | null;
417417
}
418418
/**
419-
* Defines the scope of cluster-scoped resources to restore. Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore "all valid" resources automatically excludes these group kinds. - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - Node - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here. - Namespace - PersistentVolume
419+
* Defines the scope of cluster-scoped resources to restore. Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore "all valid" resources automatically excludes these group kinds. - Node - ComponentStatus - gkebackup.gke.io/BackupJob - gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode - storage.k8s.io/VolumeAttachment Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here. - Namespace - PersistentVolume
420420
*/
421421
export interface Schema$ClusterResourceRestoreScope {
422422
/**
@@ -801,7 +801,7 @@ export namespace gkebackup_v1 {
801801
*/
802802
endTime?: string | null;
803803
/**
804-
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
804+
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
805805
*/
806806
requestedCancellation?: boolean | null;
807807
/**
@@ -937,7 +937,7 @@ export namespace gkebackup_v1 {
937937
*/
938938
state?: string | null;
939939
/**
940-
* Output only. Human-readable description of why the Restore is in its current state.
940+
* Output only. Human-readable description of why the Restore is in its current state. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.
941941
*/
942942
stateReason?: string | null;
943943
/**
@@ -1064,7 +1064,7 @@ export namespace gkebackup_v1 {
10641064
*/
10651065
state?: string | null;
10661066
/**
1067-
* Output only. Human-readable description of why RestorePlan is in the current `state`
1067+
* Output only. Human-readable description of why RestorePlan is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.
10681068
*/
10691069
stateReason?: string | null;
10701070
/**
@@ -1188,19 +1188,19 @@ export namespace gkebackup_v1 {
11881188
*/
11891189
export interface Schema$TimeOfDay {
11901190
/**
1191-
* Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
1191+
* Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
11921192
*/
11931193
hours?: number | null;
11941194
/**
1195-
* Minutes of hour of day. Must be from 0 to 59.
1195+
* Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
11961196
*/
11971197
minutes?: number | null;
11981198
/**
1199-
* Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
1199+
* Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
12001200
*/
12011201
nanos?: number | null;
12021202
/**
1203-
* Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
1203+
* Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
12041204
*/
12051205
seconds?: number | null;
12061206
}
@@ -1279,7 +1279,7 @@ export namespace gkebackup_v1 {
12791279
*/
12801280
state?: string | null;
12811281
/**
1282-
* Output only. A human readable message explaining why the VolumeBackup is in its current state.
1282+
* Output only. A human readable message explaining why the VolumeBackup is in its current state. This field is only meant for human consumption and should not be used programmatically as this field is not guaranteed to be consistent.
12831283
*/
12841284
stateMessage?: string | null;
12851285
/**
@@ -3963,7 +3963,7 @@ export namespace gkebackup_v1 {
39633963
}
39643964

39653965
/**
3966-
* 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`.
3966+
* 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`.
39673967
*
39683968
* @param params - Parameters for request
39693969
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.

0 commit comments

Comments
 (0)