google-cloud-gke_backup-v1 0.3.0 → 0.5.0

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 (30) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/gke_backup/v1/backup_for_gke/client.rb +70 -40
  4. data/lib/google/cloud/gke_backup/v1/backup_for_gke/operations.rb +5 -3
  5. data/lib/google/cloud/gke_backup/v1/backup_for_gke/rest/client.rb +79 -40
  6. data/lib/google/cloud/gke_backup/v1/backup_for_gke/rest/operations.rb +9 -7
  7. data/lib/google/cloud/gke_backup/v1/backup_for_gke/rest/service_stub.rb +24 -24
  8. data/lib/google/cloud/gke_backup/v1/backup_for_gke/rest.rb +1 -0
  9. data/lib/google/cloud/gke_backup/v1/bindings_override.rb +255 -0
  10. data/lib/google/cloud/gke_backup/v1/rest.rb +1 -0
  11. data/lib/google/cloud/gke_backup/v1/version.rb +1 -1
  12. data/lib/google/cloud/gkebackup/v1/backup_pb.rb +26 -49
  13. data/lib/google/cloud/gkebackup/v1/backup_plan_pb.rb +27 -35
  14. data/lib/google/cloud/gkebackup/v1/common_pb.rb +24 -14
  15. data/lib/google/cloud/gkebackup/v1/gkebackup_pb.rb +32 -152
  16. data/lib/google/cloud/gkebackup/v1/restore_pb.rb +30 -70
  17. data/lib/google/cloud/gkebackup/v1/restore_plan_pb.rb +27 -13
  18. data/lib/google/cloud/gkebackup/v1/volume_pb.rb +26 -55
  19. data/proto_docs/google/api/client.rb +67 -4
  20. data/proto_docs/google/cloud/gkebackup/v1/backup.rb +43 -31
  21. data/proto_docs/google/cloud/gkebackup/v1/backup_plan.rb +54 -13
  22. data/proto_docs/google/cloud/gkebackup/v1/common.rb +1 -1
  23. data/proto_docs/google/cloud/gkebackup/v1/gkebackup.rb +63 -61
  24. data/proto_docs/google/cloud/gkebackup/v1/restore.rb +194 -29
  25. data/proto_docs/google/cloud/gkebackup/v1/restore_plan.rb +40 -13
  26. data/proto_docs/google/cloud/gkebackup/v1/volume.rb +23 -20
  27. data/proto_docs/google/protobuf/any.rb +7 -4
  28. data/proto_docs/google/protobuf/timestamp.rb +1 -3
  29. data/proto_docs/google/type/expr.rb +75 -0
  30. metadata +46 -4
@@ -35,7 +35,9 @@ module Google
35
35
  # Details about how and where to publish client libraries.
36
36
  # @!attribute [rw] version
37
37
  # @return [::String]
38
- # Version of the API to apply these settings to.
38
+ # Version of the API to apply these settings to. This is the full protobuf
39
+ # package for the API, ending in the version element.
40
+ # Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
39
41
  # @!attribute [rw] launch_stage
40
42
  # @return [::Google::Api::LaunchStage]
41
43
  # Launch stage of this version of the API.
@@ -81,7 +83,7 @@ module Google
81
83
  # long-running operation pattern.
82
84
  # @!attribute [rw] new_issue_uri
83
85
  # @return [::String]
84
- # Link to a place that API users can report issues. Example:
86
+ # Link to a *public* URI where users can report issues. Example:
85
87
  # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
88
  # @!attribute [rw] documentation_uri
87
89
  # @return [::String]
@@ -111,6 +113,10 @@ module Google
111
113
  # Client library settings. If the same version string appears multiple
112
114
  # times in this list, then the last one wins. Settings from earlier
113
115
  # settings with the same version string are discarded.
116
+ # @!attribute [rw] proto_reference_documentation_uri
117
+ # @return [::String]
118
+ # Optional link to proto reference documentation. Example:
119
+ # https://cloud.google.com/pubsub/lite/docs/reference/rpc
114
120
  class Publishing
115
121
  include ::Google::Protobuf::MessageExts
116
122
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -203,9 +209,57 @@ module Google
203
209
  # @!attribute [rw] common
204
210
  # @return [::Google::Api::CommonLanguageSettings]
205
211
  # Some settings.
212
+ # @!attribute [rw] renamed_services
213
+ # @return [::Google::Protobuf::Map{::String => ::String}]
214
+ # Map from original service names to renamed versions.
215
+ # This is used when the default generated types
216
+ # would cause a naming conflict. (Neither name is
217
+ # fully-qualified.)
218
+ # Example: Subscriber to SubscriberServiceApi.
219
+ # @!attribute [rw] renamed_resources
220
+ # @return [::Google::Protobuf::Map{::String => ::String}]
221
+ # Map from full resource types to the effective short name
222
+ # for the resource. This is used when otherwise resource
223
+ # named from different services would cause naming collisions.
224
+ # Example entry:
225
+ # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
226
+ # @!attribute [rw] ignored_resources
227
+ # @return [::Array<::String>]
228
+ # List of full resource types to ignore during generation.
229
+ # This is typically used for API-specific Location resources,
230
+ # which should be handled by the generator as if they were actually
231
+ # the common Location resources.
232
+ # Example entry: "documentai.googleapis.com/Location"
233
+ # @!attribute [rw] forced_namespace_aliases
234
+ # @return [::Array<::String>]
235
+ # Namespaces which must be aliased in snippets due to
236
+ # a known (but non-generator-predictable) naming collision
237
+ # @!attribute [rw] handwritten_signatures
238
+ # @return [::Array<::String>]
239
+ # Method signatures (in the form "service.method(signature)")
240
+ # which are provided separately, so shouldn't be generated.
241
+ # Snippets *calling* these methods are still generated, however.
206
242
  class DotnetSettings
207
243
  include ::Google::Protobuf::MessageExts
208
244
  extend ::Google::Protobuf::MessageExts::ClassMethods
245
+
246
+ # @!attribute [rw] key
247
+ # @return [::String]
248
+ # @!attribute [rw] value
249
+ # @return [::String]
250
+ class RenamedServicesEntry
251
+ include ::Google::Protobuf::MessageExts
252
+ extend ::Google::Protobuf::MessageExts::ClassMethods
253
+ end
254
+
255
+ # @!attribute [rw] key
256
+ # @return [::String]
257
+ # @!attribute [rw] value
258
+ # @return [::String]
259
+ class RenamedResourcesEntry
260
+ include ::Google::Protobuf::MessageExts
261
+ extend ::Google::Protobuf::MessageExts::ClassMethods
262
+ end
209
263
  end
210
264
 
211
265
  # Settings for Ruby client libraries.
@@ -240,8 +294,8 @@ module Google
240
294
  # Example of a YAML configuration::
241
295
  #
242
296
  # publishing:
243
- # method_behavior:
244
- # - selector: CreateAdDomain
297
+ # method_settings:
298
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
245
299
  # long_running:
246
300
  # initial_poll_delay:
247
301
  # seconds: 60 # 1 minute
@@ -299,6 +353,15 @@ module Google
299
353
 
300
354
  # Street View Org.
301
355
  STREET_VIEW = 4
356
+
357
+ # Shopping Org.
358
+ SHOPPING = 5
359
+
360
+ # Geo Org.
361
+ GEO = 6
362
+
363
+ # Generative AI - https://developers.generativeai.google
364
+ GENERATIVE_AI = 7
302
365
  end
303
366
 
304
367
  # To where should client libraries be published?
@@ -29,7 +29,7 @@ module Google
29
29
  # @!attribute [r] name
30
30
  # @return [::String]
31
31
  # Output only. The fully qualified name of the Backup.
32
- # projects/*/locations/*/backupPlans/*/backups/*
32
+ # `projects/*/locations/*/backupPlans/*/backups/*`
33
33
  # @!attribute [r] uid
34
34
  # @return [::String]
35
35
  # Output only. Server generated global unique identifier of
@@ -42,9 +42,9 @@ module Google
42
42
  # Output only. The timestamp when this Backup resource was last updated.
43
43
  # @!attribute [r] manual
44
44
  # @return [::Boolean]
45
- # Output only. This flag indicates whether this Backup resource was created manually
46
- # by a user or via a schedule in the BackupPlan. A value of True means that
47
- # the Backup was created manually.
45
+ # Output only. This flag indicates whether this Backup resource was created
46
+ # manually by a user or via a schedule in the BackupPlan. A value of True
47
+ # means that the Backup was created manually.
48
48
  # @!attribute [rw] labels
49
49
  # @return [::Google::Protobuf::Map{::String => ::String}]
50
50
  # A set of custom labels supplied by user.
@@ -62,75 +62,87 @@ module Google
62
62
  # (either at creation time or in a subsequent update).
63
63
  # @!attribute [r] delete_lock_expire_time
64
64
  # @return [::Google::Protobuf::Timestamp]
65
- # Output only. The time at which an existing delete lock will expire for this backup
66
- # (calculated from create_time + {::Google::Cloud::GkeBackup::V1::Backup#delete_lock_days delete_lock_days}).
65
+ # Output only. The time at which an existing delete lock will expire for this
66
+ # backup (calculated from create_time +
67
+ # {::Google::Cloud::GkeBackup::V1::Backup#delete_lock_days delete_lock_days}).
67
68
  # @!attribute [rw] retain_days
68
69
  # @return [::Integer]
69
70
  # The age (in days) after which this Backup will be automatically deleted.
70
71
  # Must be an integer value >= 0:
71
72
  #
72
73
  # - If 0, no automatic deletion will occur for this Backup.
73
- # - If not 0, this must be >= {::Google::Cloud::GkeBackup::V1::Backup#delete_lock_days delete_lock_days}.
74
+ # - If not 0, this must be >=
75
+ # {::Google::Cloud::GkeBackup::V1::Backup#delete_lock_days delete_lock_days} and
76
+ # <= 365.
74
77
  #
75
78
  # Once a Backup is created, this value may only be increased.
76
79
  #
77
80
  # Defaults to the parent BackupPlan's
78
- # {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days} value.
81
+ # {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
82
+ # value.
79
83
  # @!attribute [r] retain_expire_time
80
84
  # @return [::Google::Protobuf::Timestamp]
81
- # Output only. The time at which this Backup will be automatically deleted (calculated
82
- # from create_time + {::Google::Cloud::GkeBackup::V1::Backup#retain_days retain_days}).
85
+ # Output only. The time at which this Backup will be automatically deleted
86
+ # (calculated from create_time +
87
+ # {::Google::Cloud::GkeBackup::V1::Backup#retain_days retain_days}).
83
88
  # @!attribute [r] encryption_key
84
89
  # @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
85
- # Output only. The customer managed encryption key that was used to encrypt the Backup's
86
- # artifacts. Inherited from the parent BackupPlan's
87
- # {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#encryption_key encryption_key} value.
90
+ # Output only. The customer managed encryption key that was used to encrypt
91
+ # the Backup's artifacts. Inherited from the parent BackupPlan's
92
+ # {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#encryption_key encryption_key}
93
+ # value.
88
94
  # @!attribute [r] all_namespaces
89
95
  # @return [::Boolean]
90
96
  # Output only. If True, all namespaces were included in the Backup.
91
97
  # @!attribute [r] selected_namespaces
92
98
  # @return [::Google::Cloud::GkeBackup::V1::Namespaces]
93
- # Output only. If set, the list of namespaces that were included in the Backup.
99
+ # Output only. If set, the list of namespaces that were included in the
100
+ # Backup.
94
101
  # @!attribute [r] selected_applications
95
102
  # @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
96
- # Output only. If set, the list of ProtectedApplications whose resources were included
97
- # in the Backup.
103
+ # Output only. If set, the list of ProtectedApplications whose resources
104
+ # were included in the Backup.
98
105
  # @!attribute [r] contains_volume_data
99
106
  # @return [::Boolean]
100
- # Output only. Whether or not the Backup contains volume data. Controlled by the parent
101
- # BackupPlan's
102
- # {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#include_volume_data include_volume_data} value.
107
+ # Output only. Whether or not the Backup contains volume data. Controlled by
108
+ # the parent BackupPlan's
109
+ # {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#include_volume_data include_volume_data}
110
+ # value.
103
111
  # @!attribute [r] contains_secrets
104
112
  # @return [::Boolean]
105
- # Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the
106
- # parent BackupPlan's
107
- # {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#include_secrets include_secrets} value.
113
+ # Output only. Whether or not the Backup contains Kubernetes Secrets.
114
+ # Controlled by the parent BackupPlan's
115
+ # {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#include_secrets include_secrets}
116
+ # value.
108
117
  # @!attribute [r] cluster_metadata
109
118
  # @return [::Google::Cloud::GkeBackup::V1::Backup::ClusterMetadata]
110
- # Output only. Information about the GKE cluster from which this Backup was created.
119
+ # Output only. Information about the GKE cluster from which this Backup was
120
+ # created.
111
121
  # @!attribute [r] state
112
122
  # @return [::Google::Cloud::GkeBackup::V1::Backup::State]
113
123
  # Output only. Current state of the Backup
114
124
  # @!attribute [r] state_reason
115
125
  # @return [::String]
116
- # Output only. Human-readable description of why the backup is in the current `state`.
126
+ # Output only. Human-readable description of why the backup is in the current
127
+ # `state`.
117
128
  # @!attribute [r] complete_time
118
129
  # @return [::Google::Protobuf::Timestamp]
119
130
  # Output only. Completion time of the Backup
120
131
  # @!attribute [r] resource_count
121
132
  # @return [::Integer]
122
- # Output only. The total number of Kubernetes resources included in the Backup.
133
+ # Output only. The total number of Kubernetes resources included in the
134
+ # Backup.
123
135
  # @!attribute [r] volume_count
124
136
  # @return [::Integer]
125
137
  # Output only. The total number of volume backups contained in the Backup.
126
138
  # @!attribute [r] size_bytes
127
139
  # @return [::Integer]
128
- # Output only. The total size of the Backup in bytes = config backup size + sum(volume
129
- # backup sizes)
140
+ # Output only. The total size of the Backup in bytes = config backup size +
141
+ # sum(volume backup sizes)
130
142
  # @!attribute [r] etag
131
143
  # @return [::String]
132
- # Output only. `etag` is used for optimistic concurrency control as a way to help
133
- # prevent simultaneous updates of a backup from overwriting each other.
144
+ # Output only. `etag` is used for optimistic concurrency control as a way to
145
+ # help prevent simultaneous updates of a backup from overwriting each other.
134
146
  # It is strongly suggested that systems make use of the `etag` in the
135
147
  # read-modify-write cycle to perform backup updates in order to avoid
136
148
  # race conditions: An `etag` is returned in the response to `GetBackup`,
@@ -156,8 +168,8 @@ module Google
156
168
  # The source cluster from which this Backup was created.
157
169
  # Valid formats:
158
170
  #
159
- # - projects/*/locations/*/clusters/*
160
- # - projects/*/zones/*/clusters/*
171
+ # - `projects/*/locations/*/clusters/*`
172
+ # - `projects/*/zones/*/clusters/*`
161
173
  #
162
174
  # This is inherited from the parent BackupPlan's
163
175
  # {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field.
@@ -25,7 +25,7 @@ module Google
25
25
  # @!attribute [r] name
26
26
  # @return [::String]
27
27
  # Output only. The full name of the BackupPlan resource.
28
- # Format: projects/*/locations/*/backupPlans/*
28
+ # Format: `projects/*/locations/*/backupPlans/*`
29
29
  # @!attribute [r] uid
30
30
  # @return [::String]
31
31
  # Output only. Server generated global unique identifier of
@@ -42,12 +42,11 @@ module Google
42
42
  # User specified descriptive string for this BackupPlan.
43
43
  # @!attribute [rw] cluster
44
44
  # @return [::String]
45
- # Required. Immutable. The source cluster from which Backups will be created via
46
- # this BackupPlan.
47
- # Valid formats:
45
+ # Required. Immutable. The source cluster from which Backups will be created
46
+ # via this BackupPlan. Valid formats:
48
47
  #
49
- # - projects/*/locations/*/clusters/*
50
- # - projects/*/zones/*/clusters/*
48
+ # - `projects/*/locations/*/clusters/*`
49
+ # - `projects/*/zones/*/clusters/*`
51
50
  # @!attribute [rw] retention_policy
52
51
  # @return [::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy]
53
52
  # RetentionPolicy governs lifecycle of Backups created under this plan.
@@ -59,9 +58,9 @@ module Google
59
58
  # Defines a schedule for automatic Backup creation via this BackupPlan.
60
59
  # @!attribute [r] etag
61
60
  # @return [::String]
62
- # Output only. `etag` is used for optimistic concurrency control as a way to help
63
- # prevent simultaneous updates of a backup plan from overwriting each other.
64
- # It is strongly suggested that systems make use of the 'etag' in the
61
+ # Output only. `etag` is used for optimistic concurrency control as a way to
62
+ # help prevent simultaneous updates of a backup plan from overwriting each
63
+ # other. It is strongly suggested that systems make use of the 'etag' in the
65
64
  # read-modify-write cycle to perform BackupPlan updates in order to avoid
66
65
  # race conditions: An `etag` is returned in the response to `GetBackupPlan`,
67
66
  # and systems are expected to put that etag in the request to
@@ -83,6 +82,16 @@ module Google
83
82
  # @return [::Integer]
84
83
  # Output only. The number of Kubernetes Pods backed up in the
85
84
  # last successful Backup created via this BackupPlan.
85
+ # @!attribute [r] state
86
+ # @return [::Google::Cloud::GkeBackup::V1::BackupPlan::State]
87
+ # Output only. State of the BackupPlan. This State field reflects the
88
+ # various stages a BackupPlan can be in
89
+ # during the Create operation. It will be set to "DEACTIVATED"
90
+ # if the BackupPlan is deactivated on an Update
91
+ # @!attribute [r] state_reason
92
+ # @return [::String]
93
+ # Output only. Human-readable description of why BackupPlan is in the current
94
+ # `state`
86
95
  class BackupPlan
87
96
  include ::Google::Protobuf::MessageExts
88
97
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -102,7 +111,7 @@ module Google
102
111
  # @!attribute [rw] backup_retain_days
103
112
  # @return [::Integer]
104
113
  # The default maximum age of a Backup created via this BackupPlan.
105
- # This field MUST be an integer value >= 0.
114
+ # This field MUST be an integer value >= 0 and <= 365.
106
115
  # If specified, a Backup created under this BackupPlan will be
107
116
  # automatically deleted after its age reaches (create_time +
108
117
  # backup_retain_days).
@@ -111,7 +120,12 @@ module Google
111
120
  # Updating this field does NOT affect existing Backups under it. Backups
112
121
  # created AFTER a successful update will automatically pick up the new
113
122
  # value.
114
- # NOTE: backup_retain_days must be >= {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
123
+ # NOTE: backup_retain_days must be >=
124
+ # {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
125
+ # If
126
+ # {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
127
+ # is defined, then this must be
128
+ # <= 360 * the creation interval.
115
129
  #
116
130
  # Default: 0 (no automatic deletion)
117
131
  # @!attribute [rw] locked
@@ -126,12 +140,15 @@ module Google
126
140
  extend ::Google::Protobuf::MessageExts::ClassMethods
127
141
  end
128
142
 
129
- # Schedule defines scheduling parameters for automatically creating Backups
143
+ # Defines scheduling parameters for automatically creating Backups
130
144
  # via this BackupPlan.
131
145
  # @!attribute [rw] cron_schedule
132
146
  # @return [::String]
133
147
  # A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
134
- # repeating schedule for creating Backups via this BackupPlan.
148
+ # repeating schedule for creating Backups via this BackupPlan. If this is
149
+ # defined, then
150
+ # {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
151
+ # must also be defined.
135
152
  #
136
153
  # Default (empty): no automatic backup creation will occur.
137
154
  # @!attribute [rw] paused
@@ -189,6 +206,30 @@ module Google
189
206
  include ::Google::Protobuf::MessageExts
190
207
  extend ::Google::Protobuf::MessageExts::ClassMethods
191
208
  end
209
+
210
+ # State
211
+ module State
212
+ # Default first value for Enums.
213
+ STATE_UNSPECIFIED = 0
214
+
215
+ # Waiting for cluster state to be RUNNING.
216
+ CLUSTER_PENDING = 1
217
+
218
+ # The BackupPlan is in the process of being created.
219
+ PROVISIONING = 2
220
+
221
+ # The BackupPlan has successfully been created and is ready for Backups.
222
+ READY = 3
223
+
224
+ # BackupPlan creation has failed.
225
+ FAILED = 4
226
+
227
+ # The BackupPlan has been deactivated.
228
+ DEACTIVATED = 5
229
+
230
+ # The BackupPlan is in the process of being deleted.
231
+ DELETING = 6
232
+ end
192
233
  end
193
234
  end
194
235
  end
@@ -56,7 +56,7 @@ module Google
56
56
  # @!attribute [rw] gcp_kms_encryption_key
57
57
  # @return [::String]
58
58
  # Google Cloud KMS encryption key. Format:
59
- # projects/*/locations/*/keyRings/*/cryptoKeys/*
59
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*`
60
60
  class EncryptionKey
61
61
  include ::Google::Protobuf::MessageExts
62
62
  extend ::Google::Protobuf::MessageExts::ClassMethods