google-cloud-backupdr-v1beta 0.a → 0.1.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.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +154 -8
- data/lib/google/cloud/backupdr/v1beta/appliedautoprotectionpolicy_pb.rb +30 -0
- data/lib/google/cloud/backupdr/v1beta/autoprotectionpolicy_pb.rb +39 -0
- data/lib/google/cloud/backupdr/v1beta/autoprotectionpolicybinding_pb.rb +32 -0
- data/lib/google/cloud/backupdr/v1beta/backup_dr_protection_summary/client.rb +532 -0
- data/lib/google/cloud/backupdr/v1beta/backup_dr_protection_summary/credentials.rb +48 -0
- data/lib/google/cloud/backupdr/v1beta/backup_dr_protection_summary/paths.rb +50 -0
- data/lib/google/cloud/backupdr/v1beta/backup_dr_protection_summary/rest/client.rb +491 -0
- data/lib/google/cloud/backupdr/v1beta/backup_dr_protection_summary/rest/service_stub.rb +142 -0
- data/lib/google/cloud/backupdr/v1beta/backup_dr_protection_summary/rest.rb +53 -0
- data/lib/google/cloud/backupdr/v1beta/backup_dr_protection_summary.rb +55 -0
- data/lib/google/cloud/backupdr/v1beta/backupdr/client.rb +6101 -0
- data/lib/google/cloud/backupdr/v1beta/backupdr/credentials.rb +48 -0
- data/lib/google/cloud/backupdr/v1beta/backupdr/operations.rb +843 -0
- data/lib/google/cloud/backupdr/v1beta/backupdr/paths.rb +372 -0
- data/lib/google/cloud/backupdr/v1beta/backupdr/rest/client.rb +5724 -0
- data/lib/google/cloud/backupdr/v1beta/backupdr/rest/operations.rb +927 -0
- data/lib/google/cloud/backupdr/v1beta/backupdr/rest/service_stub.rb +3086 -0
- data/lib/google/cloud/backupdr/v1beta/backupdr/rest.rb +54 -0
- data/lib/google/cloud/backupdr/v1beta/backupdr.rb +56 -0
- data/lib/google/cloud/backupdr/v1beta/backupdr_pb.rb +55 -0
- data/lib/google/cloud/backupdr/v1beta/backupdr_services_pb.rb +145 -0
- data/lib/google/cloud/backupdr/v1beta/backupplan_pb.rb +49 -0
- data/lib/google/cloud/backupdr/v1beta/backupplanassociation_pb.rb +42 -0
- data/lib/google/cloud/backupdr/v1beta/backupvault_alloydb_pb.rb +30 -0
- data/lib/google/cloud/backupdr/v1beta/backupvault_ba_pb.rb +24 -0
- data/lib/google/cloud/backupdr/v1beta/backupvault_cloudsql_pb.rb +30 -0
- data/lib/google/cloud/backupdr/v1beta/backupvault_disk_pb.rb +33 -0
- data/lib/google/cloud/backupdr/v1beta/backupvault_gce_pb.rb +66 -0
- data/lib/google/cloud/backupdr/v1beta/backupvault_pb.rb +80 -0
- data/lib/google/cloud/backupdr/v1beta/bindingmatchingresource_pb.rb +31 -0
- data/lib/google/cloud/backupdr/v1beta/bindings_override.rb +108 -0
- data/lib/google/cloud/backupdr/v1beta/datasourcereference_pb.rb +35 -0
- data/lib/google/cloud/backupdr/v1beta/protection_summary_pb.rb +40 -0
- data/lib/google/cloud/backupdr/v1beta/protection_summary_services_pb.rb +45 -0
- data/lib/google/cloud/backupdr/v1beta/rest.rb +39 -0
- data/lib/google/cloud/backupdr/v1beta/version.rb +8 -3
- data/lib/google/cloud/backupdr/v1beta.rb +46 -0
- data/lib/google-cloud-backupdr-v1beta.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +593 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/field_info.rb +88 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/cloud/backupdr/v1beta/appliedautoprotectionpolicy.rb +121 -0
- data/proto_docs/google/cloud/backupdr/v1beta/autoprotectionpolicy.rb +277 -0
- data/proto_docs/google/cloud/backupdr/v1beta/autoprotectionpolicybinding.rb +180 -0
- data/proto_docs/google/cloud/backupdr/v1beta/backupdr.rb +428 -0
- data/proto_docs/google/cloud/backupdr/v1beta/backupplan.rb +637 -0
- data/proto_docs/google/cloud/backupdr/v1beta/backupplanassociation.rb +423 -0
- data/proto_docs/google/cloud/backupdr/v1beta/backupvault.rb +1391 -0
- data/proto_docs/google/cloud/backupdr/v1beta/backupvault_alloydb.rb +105 -0
- data/proto_docs/google/cloud/backupdr/v1beta/backupvault_ba.rb +47 -0
- data/proto_docs/google/cloud/backupdr/v1beta/backupvault_cloudsql.rb +131 -0
- data/proto_docs/google/cloud/backupdr/v1beta/backupvault_disk.rb +301 -0
- data/proto_docs/google/cloud/backupdr/v1beta/backupvault_gce.rb +1010 -0
- data/proto_docs/google/cloud/backupdr/v1beta/bindingmatchingresource.rb +160 -0
- data/proto_docs/google/cloud/backupdr/v1beta/datasourcereference.rb +236 -0
- data/proto_docs/google/cloud/backupdr/v1beta/protection_summary.rb +309 -0
- data/proto_docs/google/longrunning/operations.rb +191 -0
- data/proto_docs/google/protobuf/any.rb +145 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +128 -0
- data/proto_docs/google/protobuf/wrappers.rb +148 -0
- data/proto_docs/google/rpc/status.rb +48 -0
- data/proto_docs/google/type/dayofweek.rb +49 -0
- data/proto_docs/google/type/month.rb +64 -0
- metadata +134 -9
|
@@ -0,0 +1,309 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Cloud
|
|
22
|
+
module BackupDR
|
|
23
|
+
module V1beta
|
|
24
|
+
# Request for ListResourceBackupConfigs.
|
|
25
|
+
# @!attribute [rw] parent
|
|
26
|
+
# @return [::String]
|
|
27
|
+
# Required. The project and location for which to retrieve resource backup
|
|
28
|
+
# configs. Format: 'projects/\\{project_id}/locations/\\{location}'. In Google
|
|
29
|
+
# Cloud Backup and DR, locations map to Google Cloud regions, for example
|
|
30
|
+
# **us-central1**.
|
|
31
|
+
# @!attribute [rw] page_size
|
|
32
|
+
# @return [::Integer]
|
|
33
|
+
# Optional. Requested page size. Server may return fewer items than
|
|
34
|
+
# requested. If unspecified, server will use 100 as default. Maximum value is
|
|
35
|
+
# 500 and values above 500 will be coerced to 500.
|
|
36
|
+
# @!attribute [rw] page_token
|
|
37
|
+
# @return [::String]
|
|
38
|
+
# Optional. A token identifying a page of results the server should return.
|
|
39
|
+
# @!attribute [rw] filter
|
|
40
|
+
# @return [::String]
|
|
41
|
+
# Optional. Filtering results.
|
|
42
|
+
# @!attribute [rw] order_by
|
|
43
|
+
# @return [::String]
|
|
44
|
+
# Optional. Hint for how to order the results.
|
|
45
|
+
class ListResourceBackupConfigsRequest
|
|
46
|
+
include ::Google::Protobuf::MessageExts
|
|
47
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Response for ListResourceBackupConfigs.
|
|
51
|
+
# @!attribute [rw] resource_backup_configs
|
|
52
|
+
# @return [::Array<::Google::Cloud::BackupDR::V1beta::ResourceBackupConfig>]
|
|
53
|
+
# The list of ResourceBackupConfigs for the specified scope.
|
|
54
|
+
# @!attribute [rw] next_page_token
|
|
55
|
+
# @return [::String]
|
|
56
|
+
# A token identifying a page of results the server should return.
|
|
57
|
+
class ListResourceBackupConfigsResponse
|
|
58
|
+
include ::Google::Protobuf::MessageExts
|
|
59
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# ResourceBackupConfig represents a resource along with its backup
|
|
63
|
+
# configurations.
|
|
64
|
+
# @!attribute [rw] name
|
|
65
|
+
# @return [::String]
|
|
66
|
+
# Identifier. The resource name of the ResourceBackupConfig.
|
|
67
|
+
# Format:
|
|
68
|
+
# projects/\\{project}/locations/\\{location}/resourceBackupConfigs/\\{uid}
|
|
69
|
+
# @!attribute [r] uid
|
|
70
|
+
# @return [::String]
|
|
71
|
+
# Output only. The unique identifier of the resource backup config.
|
|
72
|
+
# @!attribute [r] target_resource
|
|
73
|
+
# @return [::String]
|
|
74
|
+
# Output only. The [full resource
|
|
75
|
+
# name](https://cloud.google.com/asset-inventory/docs/resource-name-format)
|
|
76
|
+
# of the cloud resource that this configuration applies to. Supported
|
|
77
|
+
# resource types are
|
|
78
|
+
# {::Google::Cloud::BackupDR::V1beta::ResourceBackupConfig::ResourceType ResourceBackupConfig.ResourceType}.
|
|
79
|
+
# @!attribute [r] target_resource_display_name
|
|
80
|
+
# @return [::String]
|
|
81
|
+
# Output only. The human friendly name of the target resource.
|
|
82
|
+
# @!attribute [r] target_resource_type
|
|
83
|
+
# @return [::Google::Cloud::BackupDR::V1beta::ResourceBackupConfig::ResourceType]
|
|
84
|
+
# Output only. The type of the target resource.
|
|
85
|
+
# @!attribute [rw] target_resource_labels
|
|
86
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
87
|
+
# Labels associated with the target resource.
|
|
88
|
+
# @!attribute [rw] backup_configs_details
|
|
89
|
+
# @return [::Array<::Google::Cloud::BackupDR::V1beta::BackupConfigDetails>]
|
|
90
|
+
# Backup configurations applying to the target resource, including those
|
|
91
|
+
# targeting its related/child resources. For example, backup configuration
|
|
92
|
+
# applicable to Compute Engine disks will be populated in this field for a
|
|
93
|
+
# Compute Engine VM which has the disk associated.
|
|
94
|
+
# @!attribute [r] backup_configured
|
|
95
|
+
# @return [::Boolean]
|
|
96
|
+
# Output only. Whether the target resource is configured for backup. This is
|
|
97
|
+
# true if the backup_configs_details is not empty.
|
|
98
|
+
# @!attribute [r] vaulted
|
|
99
|
+
# @return [::Boolean]
|
|
100
|
+
# Output only. Whether the target resource is protected by a backup vault.
|
|
101
|
+
# This is true if the backup_configs_details is not empty and any of the
|
|
102
|
+
# {::Google::Cloud::BackupDR::V1beta::ResourceBackupConfig#backup_configs_details ResourceBackupConfig.backup_configs_details}
|
|
103
|
+
# has a backup configuration with
|
|
104
|
+
# {::Google::Cloud::BackupDR::V1beta::BackupConfigDetails#backup_vault BackupConfigDetails.backup_vault}
|
|
105
|
+
# set.
|
|
106
|
+
class ResourceBackupConfig
|
|
107
|
+
include ::Google::Protobuf::MessageExts
|
|
108
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
109
|
+
|
|
110
|
+
# @!attribute [rw] key
|
|
111
|
+
# @return [::String]
|
|
112
|
+
# @!attribute [rw] value
|
|
113
|
+
# @return [::String]
|
|
114
|
+
class TargetResourceLabelsEntry
|
|
115
|
+
include ::Google::Protobuf::MessageExts
|
|
116
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# The type of the cloud resource.
|
|
120
|
+
module ResourceType
|
|
121
|
+
# Resource type not set.
|
|
122
|
+
RESOURCE_TYPE_UNSPECIFIED = 0
|
|
123
|
+
|
|
124
|
+
# Cloud SQL instance.
|
|
125
|
+
CLOUD_SQL_INSTANCE = 1
|
|
126
|
+
|
|
127
|
+
# Compute Engine VM.
|
|
128
|
+
COMPUTE_ENGINE_VM = 2
|
|
129
|
+
|
|
130
|
+
# Compute Engine Disk.
|
|
131
|
+
COMPUTE_ENGINE_DISK = 3
|
|
132
|
+
|
|
133
|
+
# Compute Engine Regional Disk.
|
|
134
|
+
COMPUTE_ENGINE_REGIONAL_DISK = 4
|
|
135
|
+
end
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# BackupConfigDetails has information about how the resource is configured
|
|
139
|
+
# for backups and about the most recent backup taken for this configuration.
|
|
140
|
+
# @!attribute [rw] backup_dr_plan_config
|
|
141
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupDrPlanConfig]
|
|
142
|
+
# Google Cloud Backup and DR's Backup Plan specific data.
|
|
143
|
+
#
|
|
144
|
+
# Note: The following fields are mutually exclusive: `backup_dr_plan_config`, `backup_dr_template_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
145
|
+
# @!attribute [rw] backup_dr_template_config
|
|
146
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupDrTemplateConfig]
|
|
147
|
+
# Google Cloud Backup and DR's Template specific data.
|
|
148
|
+
#
|
|
149
|
+
# Note: The following fields are mutually exclusive: `backup_dr_template_config`, `backup_dr_plan_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
150
|
+
# @!attribute [r] backup_config_source
|
|
151
|
+
# @return [::String]
|
|
152
|
+
# Output only. The full resource name of the backup config source resource.
|
|
153
|
+
# For example,
|
|
154
|
+
# "//backupdr.googleapis.com/v1/projects/\\{project}/locations/\\{region}/backupPlans/\\{backupplanId}"
|
|
155
|
+
# or
|
|
156
|
+
# "//compute.googleapis.com/projects/\\{project}/locations/\\{region}/resourcePolicies/\\{resourcePolicyId}".
|
|
157
|
+
# @!attribute [r] backup_config_source_display_name
|
|
158
|
+
# @return [::String]
|
|
159
|
+
# Output only. The display name of the backup config source resource.
|
|
160
|
+
# @!attribute [r] type
|
|
161
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupConfigDetails::Type]
|
|
162
|
+
# Output only. The type of the backup config resource.
|
|
163
|
+
# @!attribute [r] state
|
|
164
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupConfigDetails::State]
|
|
165
|
+
# Output only. The state of the backup config resource.
|
|
166
|
+
# @!attribute [r] pitr_settings
|
|
167
|
+
# @return [::Google::Cloud::BackupDR::V1beta::PitrSettings]
|
|
168
|
+
# Output only. Point in time recovery settings of the backup configuration
|
|
169
|
+
# resource.
|
|
170
|
+
# @!attribute [r] latest_successful_backup_time
|
|
171
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
172
|
+
# Output only. Timestamp of the latest successful backup created via this
|
|
173
|
+
# backup configuration.
|
|
174
|
+
# @!attribute [r] applicable_resource
|
|
175
|
+
# @return [::String]
|
|
176
|
+
# Output only. The [full resource
|
|
177
|
+
# name](https://cloud.google.com/asset-inventory/docs/resource-name-format)
|
|
178
|
+
# of the resource that is applicable for the backup configuration. Example:
|
|
179
|
+
# "//compute.googleapis.com/projects/\\{project}/zones/\\{zone}/instances/\\{instance}"
|
|
180
|
+
# @!attribute [r] backup_vault
|
|
181
|
+
# @return [::String]
|
|
182
|
+
# Output only. The [full resource
|
|
183
|
+
# name](https://cloud.google.com/asset-inventory/docs/resource-name-format)
|
|
184
|
+
# of the backup vault that will store the backups generated through this
|
|
185
|
+
# backup configuration. Example:
|
|
186
|
+
# "//backupdr.googleapis.com/v1/projects/\\{project}/locations/\\{region}/backupVaults/\\{backupvaultId}"
|
|
187
|
+
# @!attribute [rw] backup_locations
|
|
188
|
+
# @return [::Array<::Google::Cloud::BackupDR::V1beta::BackupLocation>]
|
|
189
|
+
# The locations where the backups are to be stored.
|
|
190
|
+
class BackupConfigDetails
|
|
191
|
+
include ::Google::Protobuf::MessageExts
|
|
192
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
193
|
+
|
|
194
|
+
# Type of the backup configuration.
|
|
195
|
+
# This enum may receive new values in the future.
|
|
196
|
+
module Type
|
|
197
|
+
# Backup config type is unspecified.
|
|
198
|
+
TYPE_UNSPECIFIED = 0
|
|
199
|
+
|
|
200
|
+
# Backup config is Cloud SQL instance's automated backup config.
|
|
201
|
+
CLOUD_SQL_INSTANCE_BACKUP_CONFIG = 1
|
|
202
|
+
|
|
203
|
+
# Backup config is Compute Engine Resource Policy.
|
|
204
|
+
COMPUTE_ENGINE_RESOURCE_POLICY = 2
|
|
205
|
+
|
|
206
|
+
# Backup config is Google Cloud Backup and DR's Backup Plan.
|
|
207
|
+
BACKUPDR_BACKUP_PLAN = 3
|
|
208
|
+
|
|
209
|
+
# Backup config is Google Cloud Backup and DR's Template.
|
|
210
|
+
BACKUPDR_TEMPLATE = 4
|
|
211
|
+
end
|
|
212
|
+
|
|
213
|
+
# The state tells whether the backup config is active or not.
|
|
214
|
+
module State
|
|
215
|
+
# Backup config state not set.
|
|
216
|
+
STATE_UNSPECIFIED = 0
|
|
217
|
+
|
|
218
|
+
# The config is in an active state protecting the resource
|
|
219
|
+
ACTIVE = 1
|
|
220
|
+
|
|
221
|
+
# The config is currently not protecting the resource. Either because it is
|
|
222
|
+
# disabled or the owning project has been deleted without cleanup of the
|
|
223
|
+
# actual resource.
|
|
224
|
+
INACTIVE = 2
|
|
225
|
+
|
|
226
|
+
# The config still exists but because of some error state it is not
|
|
227
|
+
# protecting the resource. Like the source project is deleted. For eg.
|
|
228
|
+
# PlanAssociation, BackupPlan is deleted.
|
|
229
|
+
ERROR = 3
|
|
230
|
+
end
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
# Point in time recovery settings of the backup configuration resource.
|
|
234
|
+
# @!attribute [r] retention_days
|
|
235
|
+
# @return [::Integer]
|
|
236
|
+
# Output only. Number of days to retain the backup.
|
|
237
|
+
class PitrSettings
|
|
238
|
+
include ::Google::Protobuf::MessageExts
|
|
239
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
# Provides additional information about Google Cloud Backup and DR's Template
|
|
243
|
+
# backup configuration.
|
|
244
|
+
# @!attribute [r] first_party_management_uri
|
|
245
|
+
# @return [::String]
|
|
246
|
+
# Output only. The URI of the BackupDr template resource for the first party
|
|
247
|
+
# identity users.
|
|
248
|
+
# @!attribute [r] third_party_management_uri
|
|
249
|
+
# @return [::String]
|
|
250
|
+
# Output only. The URI of the BackupDr template resource for the third party
|
|
251
|
+
# identity users.
|
|
252
|
+
class BackupDrTemplateConfig
|
|
253
|
+
include ::Google::Protobuf::MessageExts
|
|
254
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
255
|
+
end
|
|
256
|
+
|
|
257
|
+
# BackupDrPlanConfig has additional information about Google Cloud Backup and
|
|
258
|
+
# DR's Plan backup configuration.
|
|
259
|
+
# @!attribute [rw] backup_dr_plan_rules
|
|
260
|
+
# @return [::Array<::Google::Cloud::BackupDR::V1beta::BackupDrPlanRule>]
|
|
261
|
+
# Backup rules of the backup plan resource.
|
|
262
|
+
class BackupDrPlanConfig
|
|
263
|
+
include ::Google::Protobuf::MessageExts
|
|
264
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
# BackupDrPlanRule has rule specific information of the backup plan resource.
|
|
268
|
+
# @!attribute [r] rule_id
|
|
269
|
+
# @return [::String]
|
|
270
|
+
# Output only. Unique Id of the backup rule.
|
|
271
|
+
# @!attribute [r] last_successful_backup_time
|
|
272
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
273
|
+
# Output only. Timestamp of the latest successful backup created via this
|
|
274
|
+
# backup rule.
|
|
275
|
+
class BackupDrPlanRule
|
|
276
|
+
include ::Google::Protobuf::MessageExts
|
|
277
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
278
|
+
end
|
|
279
|
+
|
|
280
|
+
# BackupLocation represents a cloud location where a backup can be stored.
|
|
281
|
+
# @!attribute [r] type
|
|
282
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupLocation::Type]
|
|
283
|
+
# Output only. The type of the location.
|
|
284
|
+
# @!attribute [r] location_id
|
|
285
|
+
# @return [::String]
|
|
286
|
+
# Output only. The id of the cloud location. Example: "us-central1"
|
|
287
|
+
class BackupLocation
|
|
288
|
+
include ::Google::Protobuf::MessageExts
|
|
289
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
290
|
+
|
|
291
|
+
# The type of the location.
|
|
292
|
+
module Type
|
|
293
|
+
# Location type is unspecified.
|
|
294
|
+
TYPE_UNSPECIFIED = 0
|
|
295
|
+
|
|
296
|
+
# Location type is zonal.
|
|
297
|
+
ZONAL = 1
|
|
298
|
+
|
|
299
|
+
# Location type is regional.
|
|
300
|
+
REGIONAL = 2
|
|
301
|
+
|
|
302
|
+
# Location type is multi regional.
|
|
303
|
+
MULTI_REGIONAL = 3
|
|
304
|
+
end
|
|
305
|
+
end
|
|
306
|
+
end
|
|
307
|
+
end
|
|
308
|
+
end
|
|
309
|
+
end
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Longrunning
|
|
22
|
+
# This resource represents a long-running operation that is the result of a
|
|
23
|
+
# network API call.
|
|
24
|
+
# @!attribute [rw] name
|
|
25
|
+
# @return [::String]
|
|
26
|
+
# The server-assigned name, which is only unique within the same service that
|
|
27
|
+
# originally returns it. If you use the default HTTP mapping, the
|
|
28
|
+
# `name` should be a resource name ending with `operations/{unique_id}`.
|
|
29
|
+
# @!attribute [rw] metadata
|
|
30
|
+
# @return [::Google::Protobuf::Any]
|
|
31
|
+
# Service-specific metadata associated with the operation. It typically
|
|
32
|
+
# contains progress information and common metadata such as create time.
|
|
33
|
+
# Some services might not provide such metadata. Any method that returns a
|
|
34
|
+
# long-running operation should document the metadata type, if any.
|
|
35
|
+
# @!attribute [rw] done
|
|
36
|
+
# @return [::Boolean]
|
|
37
|
+
# If the value is `false`, it means the operation is still in progress.
|
|
38
|
+
# If `true`, the operation is completed, and either `error` or `response` is
|
|
39
|
+
# available.
|
|
40
|
+
# @!attribute [rw] error
|
|
41
|
+
# @return [::Google::Rpc::Status]
|
|
42
|
+
# The error result of the operation in case of failure or cancellation.
|
|
43
|
+
#
|
|
44
|
+
# Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
45
|
+
# @!attribute [rw] response
|
|
46
|
+
# @return [::Google::Protobuf::Any]
|
|
47
|
+
# The normal, successful response of the operation. If the original
|
|
48
|
+
# method returns no data on success, such as `Delete`, the response is
|
|
49
|
+
# `google.protobuf.Empty`. If the original method is standard
|
|
50
|
+
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
|
51
|
+
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
|
52
|
+
# is the original method name. For example, if the original method name
|
|
53
|
+
# is `TakeSnapshot()`, the inferred response type is
|
|
54
|
+
# `TakeSnapshotResponse`.
|
|
55
|
+
#
|
|
56
|
+
# Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
57
|
+
class Operation
|
|
58
|
+
include ::Google::Protobuf::MessageExts
|
|
59
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# The request message for
|
|
63
|
+
# Operations.GetOperation.
|
|
64
|
+
# @!attribute [rw] name
|
|
65
|
+
# @return [::String]
|
|
66
|
+
# The name of the operation resource.
|
|
67
|
+
class GetOperationRequest
|
|
68
|
+
include ::Google::Protobuf::MessageExts
|
|
69
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# The request message for
|
|
73
|
+
# Operations.ListOperations.
|
|
74
|
+
# @!attribute [rw] name
|
|
75
|
+
# @return [::String]
|
|
76
|
+
# The name of the operation's parent resource.
|
|
77
|
+
# @!attribute [rw] filter
|
|
78
|
+
# @return [::String]
|
|
79
|
+
# The standard list filter.
|
|
80
|
+
# @!attribute [rw] page_size
|
|
81
|
+
# @return [::Integer]
|
|
82
|
+
# The standard list page size.
|
|
83
|
+
# @!attribute [rw] page_token
|
|
84
|
+
# @return [::String]
|
|
85
|
+
# The standard list page token.
|
|
86
|
+
# @!attribute [rw] return_partial_success
|
|
87
|
+
# @return [::Boolean]
|
|
88
|
+
# When set to `true`, operations that are reachable are returned as normal,
|
|
89
|
+
# and those that are unreachable are returned in the
|
|
90
|
+
# [ListOperationsResponse.unreachable] field.
|
|
91
|
+
#
|
|
92
|
+
# This can only be `true` when reading across collections e.g. when `parent`
|
|
93
|
+
# is set to `"projects/example/locations/-"`.
|
|
94
|
+
#
|
|
95
|
+
# This field is not by default supported and will result in an
|
|
96
|
+
# `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
|
|
97
|
+
# service or product specific documentation.
|
|
98
|
+
class ListOperationsRequest
|
|
99
|
+
include ::Google::Protobuf::MessageExts
|
|
100
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# The response message for
|
|
104
|
+
# Operations.ListOperations.
|
|
105
|
+
# @!attribute [rw] operations
|
|
106
|
+
# @return [::Array<::Google::Longrunning::Operation>]
|
|
107
|
+
# A list of operations that matches the specified filter in the request.
|
|
108
|
+
# @!attribute [rw] next_page_token
|
|
109
|
+
# @return [::String]
|
|
110
|
+
# The standard List next-page token.
|
|
111
|
+
# @!attribute [rw] unreachable
|
|
112
|
+
# @return [::Array<::String>]
|
|
113
|
+
# Unordered list. Unreachable resources. Populated when the request sets
|
|
114
|
+
# `ListOperationsRequest.return_partial_success` and reads across
|
|
115
|
+
# collections e.g. when attempting to list all resources across all supported
|
|
116
|
+
# locations.
|
|
117
|
+
class ListOperationsResponse
|
|
118
|
+
include ::Google::Protobuf::MessageExts
|
|
119
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
# The request message for
|
|
123
|
+
# Operations.CancelOperation.
|
|
124
|
+
# @!attribute [rw] name
|
|
125
|
+
# @return [::String]
|
|
126
|
+
# The name of the operation resource to be cancelled.
|
|
127
|
+
class CancelOperationRequest
|
|
128
|
+
include ::Google::Protobuf::MessageExts
|
|
129
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
# The request message for
|
|
133
|
+
# Operations.DeleteOperation.
|
|
134
|
+
# @!attribute [rw] name
|
|
135
|
+
# @return [::String]
|
|
136
|
+
# The name of the operation resource to be deleted.
|
|
137
|
+
class DeleteOperationRequest
|
|
138
|
+
include ::Google::Protobuf::MessageExts
|
|
139
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
# The request message for
|
|
143
|
+
# Operations.WaitOperation.
|
|
144
|
+
# @!attribute [rw] name
|
|
145
|
+
# @return [::String]
|
|
146
|
+
# The name of the operation resource to wait on.
|
|
147
|
+
# @!attribute [rw] timeout
|
|
148
|
+
# @return [::Google::Protobuf::Duration]
|
|
149
|
+
# The maximum duration to wait before timing out. If left blank, the wait
|
|
150
|
+
# will be at most the time permitted by the underlying HTTP/RPC protocol.
|
|
151
|
+
# If RPC context deadline is also specified, the shorter one will be used.
|
|
152
|
+
class WaitOperationRequest
|
|
153
|
+
include ::Google::Protobuf::MessageExts
|
|
154
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
# A message representing the message types used by a long-running operation.
|
|
158
|
+
#
|
|
159
|
+
# Example:
|
|
160
|
+
#
|
|
161
|
+
# rpc Export(ExportRequest) returns (google.longrunning.Operation) {
|
|
162
|
+
# option (google.longrunning.operation_info) = {
|
|
163
|
+
# response_type: "ExportResponse"
|
|
164
|
+
# metadata_type: "ExportMetadata"
|
|
165
|
+
# };
|
|
166
|
+
# }
|
|
167
|
+
# @!attribute [rw] response_type
|
|
168
|
+
# @return [::String]
|
|
169
|
+
# Required. The message name of the primary return type for this
|
|
170
|
+
# long-running operation.
|
|
171
|
+
# This type will be used to deserialize the LRO's response.
|
|
172
|
+
#
|
|
173
|
+
# If the response is in a different package from the rpc, a fully-qualified
|
|
174
|
+
# message name must be used (e.g. `google.protobuf.Struct`).
|
|
175
|
+
#
|
|
176
|
+
# Note: Altering this value constitutes a breaking change.
|
|
177
|
+
# @!attribute [rw] metadata_type
|
|
178
|
+
# @return [::String]
|
|
179
|
+
# Required. The message name of the metadata type for this long-running
|
|
180
|
+
# operation.
|
|
181
|
+
#
|
|
182
|
+
# If the response is in a different package from the rpc, a fully-qualified
|
|
183
|
+
# message name must be used (e.g. `google.protobuf.Struct`).
|
|
184
|
+
#
|
|
185
|
+
# Note: Altering this value constitutes a breaking change.
|
|
186
|
+
class OperationInfo
|
|
187
|
+
include ::Google::Protobuf::MessageExts
|
|
188
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
189
|
+
end
|
|
190
|
+
end
|
|
191
|
+
end
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Protobuf
|
|
22
|
+
# `Any` contains an arbitrary serialized protocol buffer message along with a
|
|
23
|
+
# URL that describes the type of the serialized message.
|
|
24
|
+
#
|
|
25
|
+
# Protobuf library provides support to pack/unpack Any values in the form
|
|
26
|
+
# of utility functions or additional generated methods of the Any type.
|
|
27
|
+
#
|
|
28
|
+
# Example 1: Pack and unpack a message in C++.
|
|
29
|
+
#
|
|
30
|
+
# Foo foo = ...;
|
|
31
|
+
# Any any;
|
|
32
|
+
# any.PackFrom(foo);
|
|
33
|
+
# ...
|
|
34
|
+
# if (any.UnpackTo(&foo)) {
|
|
35
|
+
# ...
|
|
36
|
+
# }
|
|
37
|
+
#
|
|
38
|
+
# Example 2: Pack and unpack a message in Java.
|
|
39
|
+
#
|
|
40
|
+
# Foo foo = ...;
|
|
41
|
+
# Any any = Any.pack(foo);
|
|
42
|
+
# ...
|
|
43
|
+
# if (any.is(Foo.class)) {
|
|
44
|
+
# foo = any.unpack(Foo.class);
|
|
45
|
+
# }
|
|
46
|
+
# // or ...
|
|
47
|
+
# if (any.isSameTypeAs(Foo.getDefaultInstance())) {
|
|
48
|
+
# foo = any.unpack(Foo.getDefaultInstance());
|
|
49
|
+
# }
|
|
50
|
+
#
|
|
51
|
+
# Example 3: Pack and unpack a message in Python.
|
|
52
|
+
#
|
|
53
|
+
# foo = Foo(...)
|
|
54
|
+
# any = Any()
|
|
55
|
+
# any.Pack(foo)
|
|
56
|
+
# ...
|
|
57
|
+
# if any.Is(Foo.DESCRIPTOR):
|
|
58
|
+
# any.Unpack(foo)
|
|
59
|
+
# ...
|
|
60
|
+
#
|
|
61
|
+
# Example 4: Pack and unpack a message in Go
|
|
62
|
+
#
|
|
63
|
+
# foo := &pb.Foo{...}
|
|
64
|
+
# any, err := anypb.New(foo)
|
|
65
|
+
# if err != nil {
|
|
66
|
+
# ...
|
|
67
|
+
# }
|
|
68
|
+
# ...
|
|
69
|
+
# foo := &pb.Foo{}
|
|
70
|
+
# if err := any.UnmarshalTo(foo); err != nil {
|
|
71
|
+
# ...
|
|
72
|
+
# }
|
|
73
|
+
#
|
|
74
|
+
# The pack methods provided by protobuf library will by default use
|
|
75
|
+
# 'type.googleapis.com/full.type.name' as the type URL and the unpack
|
|
76
|
+
# methods only use the fully qualified type name after the last '/'
|
|
77
|
+
# in the type URL, for example "foo.bar.com/x/y.z" will yield type
|
|
78
|
+
# name "y.z".
|
|
79
|
+
#
|
|
80
|
+
# JSON
|
|
81
|
+
# ====
|
|
82
|
+
# The JSON representation of an `Any` value uses the regular
|
|
83
|
+
# representation of the deserialized, embedded message, with an
|
|
84
|
+
# additional field `@type` which contains the type URL. Example:
|
|
85
|
+
#
|
|
86
|
+
# package google.profile;
|
|
87
|
+
# message Person {
|
|
88
|
+
# string first_name = 1;
|
|
89
|
+
# string last_name = 2;
|
|
90
|
+
# }
|
|
91
|
+
#
|
|
92
|
+
# {
|
|
93
|
+
# "@type": "type.googleapis.com/google.profile.Person",
|
|
94
|
+
# "firstName": <string>,
|
|
95
|
+
# "lastName": <string>
|
|
96
|
+
# }
|
|
97
|
+
#
|
|
98
|
+
# If the embedded message type is well-known and has a custom JSON
|
|
99
|
+
# representation, that representation will be embedded adding a field
|
|
100
|
+
# `value` which holds the custom JSON in addition to the `@type`
|
|
101
|
+
# field. Example (for message [google.protobuf.Duration][]):
|
|
102
|
+
#
|
|
103
|
+
# {
|
|
104
|
+
# "@type": "type.googleapis.com/google.protobuf.Duration",
|
|
105
|
+
# "value": "1.212s"
|
|
106
|
+
# }
|
|
107
|
+
# @!attribute [rw] type_url
|
|
108
|
+
# @return [::String]
|
|
109
|
+
# A URL/resource name that uniquely identifies the type of the serialized
|
|
110
|
+
# protocol buffer message. This string must contain at least
|
|
111
|
+
# one "/" character. The last segment of the URL's path must represent
|
|
112
|
+
# the fully qualified name of the type (as in
|
|
113
|
+
# `path/google.protobuf.Duration`). The name should be in a canonical form
|
|
114
|
+
# (e.g., leading "." is not accepted).
|
|
115
|
+
#
|
|
116
|
+
# In practice, teams usually precompile into the binary all types that they
|
|
117
|
+
# expect it to use in the context of Any. However, for URLs which use the
|
|
118
|
+
# scheme `http`, `https`, or no scheme, one can optionally set up a type
|
|
119
|
+
# server that maps type URLs to message definitions as follows:
|
|
120
|
+
#
|
|
121
|
+
# * If no scheme is provided, `https` is assumed.
|
|
122
|
+
# * An HTTP GET on the URL must yield a [google.protobuf.Type][]
|
|
123
|
+
# value in binary format, or produce an error.
|
|
124
|
+
# * Applications are allowed to cache lookup results based on the
|
|
125
|
+
# URL, or have them precompiled into a binary to avoid any
|
|
126
|
+
# lookup. Therefore, binary compatibility needs to be preserved
|
|
127
|
+
# on changes to types. (Use versioned type names to manage
|
|
128
|
+
# breaking changes.)
|
|
129
|
+
#
|
|
130
|
+
# Note: this functionality is not currently available in the official
|
|
131
|
+
# protobuf release, and it is not used for type URLs beginning with
|
|
132
|
+
# type.googleapis.com. As of May 2023, there are no widely used type server
|
|
133
|
+
# implementations and no plans to implement one.
|
|
134
|
+
#
|
|
135
|
+
# Schemes other than `http`, `https` (or the empty scheme) might be
|
|
136
|
+
# used with implementation specific semantics.
|
|
137
|
+
# @!attribute [rw] value
|
|
138
|
+
# @return [::String]
|
|
139
|
+
# Must be a valid serialized protocol buffer of the above specified type.
|
|
140
|
+
class Any
|
|
141
|
+
include ::Google::Protobuf::MessageExts
|
|
142
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
143
|
+
end
|
|
144
|
+
end
|
|
145
|
+
end
|