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,1391 @@
|
|
|
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
|
+
# Message describing a BackupVault object.
|
|
25
|
+
# @!attribute [r] name
|
|
26
|
+
# @return [::String]
|
|
27
|
+
# Output only. Identifier. Name of the backup vault to create. It must have
|
|
28
|
+
# the
|
|
29
|
+
# format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`.
|
|
30
|
+
# `{backupvault}` cannot be changed after creation. It must be between 3-63
|
|
31
|
+
# characters long and must be unique within the project and location.
|
|
32
|
+
# @!attribute [rw] description
|
|
33
|
+
# @return [::String]
|
|
34
|
+
# Optional. The description of the BackupVault instance (2048 characters or
|
|
35
|
+
# less).
|
|
36
|
+
# @!attribute [rw] labels
|
|
37
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
38
|
+
# Optional. Resource labels to represent user provided metadata.
|
|
39
|
+
# No labels currently defined:
|
|
40
|
+
# @!attribute [r] create_time
|
|
41
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
42
|
+
# Output only. The time when the instance was created.
|
|
43
|
+
# @!attribute [r] update_time
|
|
44
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
45
|
+
# Output only. The time when the instance was updated.
|
|
46
|
+
# @!attribute [rw] backup_minimum_enforced_retention_duration
|
|
47
|
+
# @return [::Google::Protobuf::Duration]
|
|
48
|
+
# Required. The default and minimum enforced retention for each backup within
|
|
49
|
+
# the backup vault. The enforced retention for each backup can be extended.
|
|
50
|
+
# Note: Longer minimum enforced retention period impacts potential storage
|
|
51
|
+
# costs post introductory trial. We recommend starting with a short duration
|
|
52
|
+
# of 3 days or less.
|
|
53
|
+
# @!attribute [rw] backup_retention_inheritance
|
|
54
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupVault::BackupRetentionInheritance]
|
|
55
|
+
# Optional. Setting for how a backup's enforced retention end time is
|
|
56
|
+
# inherited.
|
|
57
|
+
# @!attribute [r] deletable
|
|
58
|
+
# @return [::Boolean]
|
|
59
|
+
# Output only. Set to true when there are no backups nested under this
|
|
60
|
+
# resource.
|
|
61
|
+
# @!attribute [rw] etag
|
|
62
|
+
# @return [::String]
|
|
63
|
+
# Optional. Server specified ETag for the backup vault resource to
|
|
64
|
+
# prevent simultaneous updates from overwiting each other.
|
|
65
|
+
# @!attribute [r] state
|
|
66
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupVault::State]
|
|
67
|
+
# Output only. The BackupVault resource instance state.
|
|
68
|
+
# @!attribute [rw] effective_time
|
|
69
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
70
|
+
# Optional. Time after which the BackupVault resource is locked.
|
|
71
|
+
# @!attribute [r] backup_count
|
|
72
|
+
# @return [::Integer]
|
|
73
|
+
# Output only. The number of backups in this backup vault.
|
|
74
|
+
# @!attribute [r] service_account
|
|
75
|
+
# @return [::String]
|
|
76
|
+
# Output only. Service account used by the BackupVault Service for this
|
|
77
|
+
# BackupVault. The user should grant this account permissions in their
|
|
78
|
+
# workload project to enable the service to run backups and restores there.
|
|
79
|
+
# @!attribute [r] total_stored_bytes
|
|
80
|
+
# @return [::Integer]
|
|
81
|
+
# Output only. Total size of the storage used by all backup resources.
|
|
82
|
+
# @!attribute [r] uid
|
|
83
|
+
# @return [::String]
|
|
84
|
+
# Output only. Immutable after resource creation until resource deletion.
|
|
85
|
+
# @!attribute [rw] annotations
|
|
86
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
87
|
+
# Optional. User annotations. See https://google.aip.dev/128#annotations
|
|
88
|
+
# Stores small amounts of arbitrary data.
|
|
89
|
+
# @!attribute [rw] access_restriction
|
|
90
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupVault::AccessRestriction]
|
|
91
|
+
# Optional. Restricts access to certain sources and destinations for data
|
|
92
|
+
# being sent into, or restored from, the backup vault. Defaults to
|
|
93
|
+
# WITHIN_ORGANIZATION if not provided during creation.
|
|
94
|
+
# @!attribute [rw] encryption_config
|
|
95
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupVault::EncryptionConfig]
|
|
96
|
+
# Optional. The encryption config of the backup vault.
|
|
97
|
+
class BackupVault
|
|
98
|
+
include ::Google::Protobuf::MessageExts
|
|
99
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
100
|
+
|
|
101
|
+
# Message describing the EncryptionConfig of backup vault.
|
|
102
|
+
# This determines how data within the vault is encrypted at rest.
|
|
103
|
+
# @!attribute [rw] kms_key_name
|
|
104
|
+
# @return [::String]
|
|
105
|
+
# Optional. The Cloud KMS key name to encrypt backups in this backup vault.
|
|
106
|
+
# Must be in the same region as the vault. Some workload backups like
|
|
107
|
+
# compute disk backups may use their inherited source key instead. Format:
|
|
108
|
+
# projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
|
|
109
|
+
class EncryptionConfig
|
|
110
|
+
include ::Google::Protobuf::MessageExts
|
|
111
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# @!attribute [rw] key
|
|
115
|
+
# @return [::String]
|
|
116
|
+
# @!attribute [rw] value
|
|
117
|
+
# @return [::String]
|
|
118
|
+
class LabelsEntry
|
|
119
|
+
include ::Google::Protobuf::MessageExts
|
|
120
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
# @!attribute [rw] key
|
|
124
|
+
# @return [::String]
|
|
125
|
+
# @!attribute [rw] value
|
|
126
|
+
# @return [::String]
|
|
127
|
+
class AnnotationsEntry
|
|
128
|
+
include ::Google::Protobuf::MessageExts
|
|
129
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
# How a backup's enforced retention end time is inherited.
|
|
133
|
+
module BackupRetentionInheritance
|
|
134
|
+
# Inheritance behavior not set. This will default to
|
|
135
|
+
# `INHERIT_VAULT_RETENTION`.
|
|
136
|
+
BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0
|
|
137
|
+
|
|
138
|
+
# The enforced retention end time of a backup will be inherited from the
|
|
139
|
+
# backup vault's `backup_minimum_enforced_retention_duration` field.
|
|
140
|
+
#
|
|
141
|
+
# This is the default behavior.
|
|
142
|
+
INHERIT_VAULT_RETENTION = 1
|
|
143
|
+
|
|
144
|
+
# The enforced retention end time of a backup will always match the expire
|
|
145
|
+
# time of the backup.
|
|
146
|
+
#
|
|
147
|
+
# If this is set, the backup's enforced retention end time will be set to
|
|
148
|
+
# match the expire time during creation of the backup. When updating, the
|
|
149
|
+
# ERET and expire time must be updated together and have the same value.
|
|
150
|
+
# Invalid update requests will be rejected by the server.
|
|
151
|
+
MATCH_BACKUP_EXPIRE_TIME = 2
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# Holds the state of the backup vault resource.
|
|
155
|
+
module State
|
|
156
|
+
# State not set.
|
|
157
|
+
STATE_UNSPECIFIED = 0
|
|
158
|
+
|
|
159
|
+
# The backup vault is being created.
|
|
160
|
+
CREATING = 1
|
|
161
|
+
|
|
162
|
+
# The backup vault has been created and is fully usable.
|
|
163
|
+
ACTIVE = 2
|
|
164
|
+
|
|
165
|
+
# The backup vault is being deleted.
|
|
166
|
+
DELETING = 3
|
|
167
|
+
|
|
168
|
+
# The backup vault is experiencing an issue and might be unusable.
|
|
169
|
+
ERROR = 4
|
|
170
|
+
|
|
171
|
+
# The backup vault is being updated.
|
|
172
|
+
UPDATING = 5
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
# Holds the access restriction for the backup vault.
|
|
176
|
+
module AccessRestriction
|
|
177
|
+
# Access restriction not set. If user does not provide any value or pass
|
|
178
|
+
# this value, it will be changed to WITHIN_ORGANIZATION.
|
|
179
|
+
ACCESS_RESTRICTION_UNSPECIFIED = 0
|
|
180
|
+
|
|
181
|
+
# Access to or from resources outside your current project will be denied.
|
|
182
|
+
WITHIN_PROJECT = 1
|
|
183
|
+
|
|
184
|
+
# Access to or from resources outside your current organization will be
|
|
185
|
+
# denied.
|
|
186
|
+
WITHIN_ORGANIZATION = 2
|
|
187
|
+
|
|
188
|
+
# No access restriction.
|
|
189
|
+
UNRESTRICTED = 3
|
|
190
|
+
|
|
191
|
+
# Access to or from resources outside your current organization will be
|
|
192
|
+
# denied except for backup appliance.
|
|
193
|
+
WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
|
|
194
|
+
end
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
# Message describing a DataSource object.
|
|
198
|
+
# Datasource object used to represent Datasource details for both admin and
|
|
199
|
+
# basic view.
|
|
200
|
+
# @!attribute [rw] data_source_gcp_resource
|
|
201
|
+
# @return [::Google::Cloud::BackupDR::V1beta::DataSourceGcpResource]
|
|
202
|
+
# The backed up resource is a Google Cloud resource.
|
|
203
|
+
# The word 'DataSource' was included in the names to indicate that this is
|
|
204
|
+
# the representation of the Google Cloud resource used within the
|
|
205
|
+
# DataSource object.
|
|
206
|
+
#
|
|
207
|
+
# Note: The following fields are mutually exclusive: `data_source_gcp_resource`, `data_source_backup_appliance_application`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
208
|
+
# @!attribute [rw] data_source_backup_appliance_application
|
|
209
|
+
# @return [::Google::Cloud::BackupDR::V1beta::DataSourceBackupApplianceApplication]
|
|
210
|
+
# The backed up resource is a backup appliance application.
|
|
211
|
+
#
|
|
212
|
+
# Note: The following fields are mutually exclusive: `data_source_backup_appliance_application`, `data_source_gcp_resource`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
213
|
+
# @!attribute [r] name
|
|
214
|
+
# @return [::String]
|
|
215
|
+
# Output only. Identifier. Name of the datasource to create.
|
|
216
|
+
# It must have the
|
|
217
|
+
# format`"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}"`.
|
|
218
|
+
# `{datasource}` cannot be changed after creation. It must be between 3-63
|
|
219
|
+
# characters long and must be unique within the backup vault.
|
|
220
|
+
# @!attribute [r] state
|
|
221
|
+
# @return [::Google::Cloud::BackupDR::V1beta::DataSource::State]
|
|
222
|
+
# Output only. The DataSource resource instance state.
|
|
223
|
+
# @!attribute [rw] labels
|
|
224
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
225
|
+
# Optional. Resource labels to represent user provided metadata.
|
|
226
|
+
# No labels currently defined:
|
|
227
|
+
# @!attribute [r] create_time
|
|
228
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
229
|
+
# Output only. The time when the instance was created.
|
|
230
|
+
# @!attribute [r] update_time
|
|
231
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
232
|
+
# Output only. The time when the instance was updated.
|
|
233
|
+
# @!attribute [rw] backup_count
|
|
234
|
+
# @return [::Integer]
|
|
235
|
+
# Number of backups in the data source.
|
|
236
|
+
# @!attribute [rw] etag
|
|
237
|
+
# @return [::String]
|
|
238
|
+
# Server specified ETag for the ManagementServer resource to prevent
|
|
239
|
+
# simultaneous updates from overwiting each other.
|
|
240
|
+
# @!attribute [rw] total_stored_bytes
|
|
241
|
+
# @return [::Integer]
|
|
242
|
+
# The number of bytes (metadata and data) stored in this datasource.
|
|
243
|
+
# @!attribute [r] config_state
|
|
244
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupConfigState]
|
|
245
|
+
# Output only. The backup configuration state.
|
|
246
|
+
# @!attribute [r] backup_config_info
|
|
247
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupConfigInfo]
|
|
248
|
+
# Output only. Details of how the resource is configured for backup.
|
|
249
|
+
# @!attribute [r] backup_blocked_by_vault_access_restriction
|
|
250
|
+
# @return [::Boolean]
|
|
251
|
+
# Output only. This field is set to true if the backup is blocked by vault
|
|
252
|
+
# access restriction.
|
|
253
|
+
class DataSource
|
|
254
|
+
include ::Google::Protobuf::MessageExts
|
|
255
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
256
|
+
|
|
257
|
+
# @!attribute [rw] key
|
|
258
|
+
# @return [::String]
|
|
259
|
+
# @!attribute [rw] value
|
|
260
|
+
# @return [::String]
|
|
261
|
+
class LabelsEntry
|
|
262
|
+
include ::Google::Protobuf::MessageExts
|
|
263
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
264
|
+
end
|
|
265
|
+
|
|
266
|
+
# Holds the state of the data source resource.
|
|
267
|
+
module State
|
|
268
|
+
# State not set.
|
|
269
|
+
STATE_UNSPECIFIED = 0
|
|
270
|
+
|
|
271
|
+
# The data source is being created.
|
|
272
|
+
CREATING = 1
|
|
273
|
+
|
|
274
|
+
# The data source has been created and is fully usable.
|
|
275
|
+
ACTIVE = 2
|
|
276
|
+
|
|
277
|
+
# The data source is being deleted.
|
|
278
|
+
DELETING = 3
|
|
279
|
+
|
|
280
|
+
# The data source is experiencing an issue and might be unusable.
|
|
281
|
+
ERROR = 4
|
|
282
|
+
end
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
# BackupConfigInfo has information about how the resource is configured
|
|
286
|
+
# for Backup and about the most recent backup to this vault.
|
|
287
|
+
# @!attribute [rw] gcp_backup_config
|
|
288
|
+
# @return [::Google::Cloud::BackupDR::V1beta::GcpBackupConfig]
|
|
289
|
+
# Configuration for a Google Cloud resource.
|
|
290
|
+
#
|
|
291
|
+
# Note: The following fields are mutually exclusive: `gcp_backup_config`, `backup_appliance_backup_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
292
|
+
# @!attribute [rw] backup_appliance_backup_config
|
|
293
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupApplianceBackupConfig]
|
|
294
|
+
# Configuration for an application backed up by a Backup Appliance.
|
|
295
|
+
#
|
|
296
|
+
# Note: The following fields are mutually exclusive: `backup_appliance_backup_config`, `gcp_backup_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
297
|
+
# @!attribute [r] last_backup_state
|
|
298
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupConfigInfo::LastBackupState]
|
|
299
|
+
# Output only. The status of the last backup to this BackupVault
|
|
300
|
+
# @!attribute [r] last_successful_backup_consistency_time
|
|
301
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
302
|
+
# Output only. If the last backup were successful, this field has the
|
|
303
|
+
# consistency date.
|
|
304
|
+
# @!attribute [r] last_backup_error
|
|
305
|
+
# @return [::Google::Rpc::Status]
|
|
306
|
+
# Output only. If the last backup failed, this field has the error message.
|
|
307
|
+
class BackupConfigInfo
|
|
308
|
+
include ::Google::Protobuf::MessageExts
|
|
309
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
310
|
+
|
|
311
|
+
# LastBackupstate tracks whether the last backup was not yet started,
|
|
312
|
+
# successful, failed, or could not be run because of the lack of permissions.
|
|
313
|
+
module LastBackupState
|
|
314
|
+
# Status not set.
|
|
315
|
+
LAST_BACKUP_STATE_UNSPECIFIED = 0
|
|
316
|
+
|
|
317
|
+
# The first backup has not yet completed
|
|
318
|
+
FIRST_BACKUP_PENDING = 1
|
|
319
|
+
|
|
320
|
+
# The most recent backup was successful
|
|
321
|
+
SUCCEEDED = 2
|
|
322
|
+
|
|
323
|
+
# The most recent backup failed
|
|
324
|
+
FAILED = 3
|
|
325
|
+
|
|
326
|
+
# The most recent backup could not be run/failed because of the lack of
|
|
327
|
+
# permissions
|
|
328
|
+
PERMISSION_DENIED = 4
|
|
329
|
+
end
|
|
330
|
+
end
|
|
331
|
+
|
|
332
|
+
# GcpBackupConfig captures the Backup configuration details for Google Cloud
|
|
333
|
+
# resources. All Google Cloud resources regardless of type are protected with
|
|
334
|
+
# backup plan associations.
|
|
335
|
+
# @!attribute [rw] backup_plan
|
|
336
|
+
# @return [::String]
|
|
337
|
+
# The name of the backup plan.
|
|
338
|
+
# @!attribute [rw] backup_plan_description
|
|
339
|
+
# @return [::String]
|
|
340
|
+
# The description of the backup plan.
|
|
341
|
+
# @!attribute [rw] backup_plan_association
|
|
342
|
+
# @return [::String]
|
|
343
|
+
# The name of the backup plan association.
|
|
344
|
+
# @!attribute [rw] backup_plan_rules
|
|
345
|
+
# @return [::Array<::String>]
|
|
346
|
+
# The names of the backup plan rules which point to this backupvault
|
|
347
|
+
# @!attribute [rw] backup_plan_revision_name
|
|
348
|
+
# @return [::String]
|
|
349
|
+
# The name of the backup plan revision.
|
|
350
|
+
# @!attribute [rw] backup_plan_revision_id
|
|
351
|
+
# @return [::String]
|
|
352
|
+
# The user friendly id of the backup plan revision.
|
|
353
|
+
# E.g. v0, v1 etc.
|
|
354
|
+
# @!attribute [r] auto_protection_policy_binding
|
|
355
|
+
# @return [::String]
|
|
356
|
+
# Output only. The resource name of the `AutoProtectionPolicyBinding` that
|
|
357
|
+
# manages this datasource, if any.
|
|
358
|
+
# Format:
|
|
359
|
+
# `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.
|
|
360
|
+
class GcpBackupConfig
|
|
361
|
+
include ::Google::Protobuf::MessageExts
|
|
362
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
363
|
+
end
|
|
364
|
+
|
|
365
|
+
# BackupApplianceBackupConfig captures the backup configuration for
|
|
366
|
+
# applications that are protected by Backup Appliances.
|
|
367
|
+
# @!attribute [rw] backup_appliance_name
|
|
368
|
+
# @return [::String]
|
|
369
|
+
# The name of the backup appliance.
|
|
370
|
+
# @!attribute [rw] backup_appliance_id
|
|
371
|
+
# @return [::Integer]
|
|
372
|
+
# The ID of the backup appliance.
|
|
373
|
+
# @!attribute [rw] sla_id
|
|
374
|
+
# @return [::Integer]
|
|
375
|
+
# The ID of the SLA of this application.
|
|
376
|
+
# @!attribute [rw] application_name
|
|
377
|
+
# @return [::String]
|
|
378
|
+
# The name of the application.
|
|
379
|
+
# @!attribute [rw] host_name
|
|
380
|
+
# @return [::String]
|
|
381
|
+
# The name of the host where the application is running.
|
|
382
|
+
# @!attribute [rw] slt_name
|
|
383
|
+
# @return [::String]
|
|
384
|
+
# The name of the SLT associated with the application.
|
|
385
|
+
# @!attribute [rw] slp_name
|
|
386
|
+
# @return [::String]
|
|
387
|
+
# The name of the SLP associated with the application.
|
|
388
|
+
class BackupApplianceBackupConfig
|
|
389
|
+
include ::Google::Protobuf::MessageExts
|
|
390
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
391
|
+
end
|
|
392
|
+
|
|
393
|
+
# DataSourceGcpResource is used for protected resources that are Google Cloud
|
|
394
|
+
# Resources. This name is easeier to understand than GcpResourceDataSource or
|
|
395
|
+
# GcpDataSourceResource
|
|
396
|
+
# @!attribute [rw] compute_instance_datasource_properties
|
|
397
|
+
# @return [::Google::Cloud::BackupDR::V1beta::ComputeInstanceDataSourceProperties]
|
|
398
|
+
# ComputeInstanceDataSourceProperties has a subset of Compute Instance
|
|
399
|
+
# properties that are useful at the Datasource level.
|
|
400
|
+
#
|
|
401
|
+
# Note: The following fields are mutually exclusive: `compute_instance_datasource_properties`, `cloud_sql_instance_datasource_properties`, `alloy_db_cluster_datasource_properties`, `disk_datasource_properties`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
402
|
+
# @!attribute [r] cloud_sql_instance_datasource_properties
|
|
403
|
+
# @return [::Google::Cloud::BackupDR::V1beta::CloudSqlInstanceDataSourceProperties]
|
|
404
|
+
# Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud
|
|
405
|
+
# SQL Instance properties that are useful at the Datasource level.
|
|
406
|
+
#
|
|
407
|
+
# Note: The following fields are mutually exclusive: `cloud_sql_instance_datasource_properties`, `compute_instance_datasource_properties`, `alloy_db_cluster_datasource_properties`, `disk_datasource_properties`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
408
|
+
# @!attribute [r] alloy_db_cluster_datasource_properties
|
|
409
|
+
# @return [::Google::Cloud::BackupDR::V1beta::AlloyDBClusterDataSourceProperties]
|
|
410
|
+
# Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB
|
|
411
|
+
# cluster properties that are useful at the Datasource level. Currently
|
|
412
|
+
# none of its child properties are auditable. If new auditable properties
|
|
413
|
+
# are added, the AUDIT annotation should be added.
|
|
414
|
+
#
|
|
415
|
+
# Note: The following fields are mutually exclusive: `alloy_db_cluster_datasource_properties`, `compute_instance_datasource_properties`, `cloud_sql_instance_datasource_properties`, `disk_datasource_properties`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
416
|
+
# @!attribute [rw] disk_datasource_properties
|
|
417
|
+
# @return [::Google::Cloud::BackupDR::V1beta::DiskDataSourceProperties]
|
|
418
|
+
# DiskDataSourceProperties has a subset of Disk properties that are useful
|
|
419
|
+
# at the Datasource level.
|
|
420
|
+
#
|
|
421
|
+
# Note: The following fields are mutually exclusive: `disk_datasource_properties`, `compute_instance_datasource_properties`, `cloud_sql_instance_datasource_properties`, `alloy_db_cluster_datasource_properties`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
422
|
+
# @!attribute [r] gcp_resourcename
|
|
423
|
+
# @return [::String]
|
|
424
|
+
# Output only. Full resource pathname URL of the source Google Cloud
|
|
425
|
+
# resource.
|
|
426
|
+
# @!attribute [rw] location
|
|
427
|
+
# @return [::String]
|
|
428
|
+
# Location of the resource: <region>/<zone>/"global"/"unspecified".
|
|
429
|
+
# @!attribute [rw] type
|
|
430
|
+
# @return [::String]
|
|
431
|
+
# The type of the Google Cloud resource. Use the Unified Resource Type,
|
|
432
|
+
# eg. compute.googleapis.com/Instance.
|
|
433
|
+
class DataSourceGcpResource
|
|
434
|
+
include ::Google::Protobuf::MessageExts
|
|
435
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
436
|
+
end
|
|
437
|
+
|
|
438
|
+
# BackupApplianceApplication describes a Source Resource when it is an
|
|
439
|
+
# application backed up by a BackupAppliance.
|
|
440
|
+
# @!attribute [rw] application_name
|
|
441
|
+
# @return [::String]
|
|
442
|
+
# The name of the Application as known to the Backup Appliance.
|
|
443
|
+
# @!attribute [rw] backup_appliance
|
|
444
|
+
# @return [::String]
|
|
445
|
+
# Appliance name.
|
|
446
|
+
# @!attribute [rw] appliance_id
|
|
447
|
+
# @return [::Integer]
|
|
448
|
+
# Appliance Id of the Backup Appliance.
|
|
449
|
+
# @!attribute [rw] type
|
|
450
|
+
# @return [::String]
|
|
451
|
+
# The type of the application. e.g. VMBackup
|
|
452
|
+
# @!attribute [rw] application_id
|
|
453
|
+
# @return [::Integer]
|
|
454
|
+
# The appid field of the application within the Backup Appliance.
|
|
455
|
+
# @!attribute [rw] hostname
|
|
456
|
+
# @return [::String]
|
|
457
|
+
# Hostname of the host where the application is running.
|
|
458
|
+
# @!attribute [rw] host_id
|
|
459
|
+
# @return [::Integer]
|
|
460
|
+
# Hostid of the application host.
|
|
461
|
+
class DataSourceBackupApplianceApplication
|
|
462
|
+
include ::Google::Protobuf::MessageExts
|
|
463
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
464
|
+
end
|
|
465
|
+
|
|
466
|
+
# ServiceLockInfo represents the details of a lock taken by the service on a
|
|
467
|
+
# Backup resource.
|
|
468
|
+
# @!attribute [r] operation
|
|
469
|
+
# @return [::String]
|
|
470
|
+
# Output only. The name of the operation that created this lock.
|
|
471
|
+
# The lock will automatically be released when the operation completes.
|
|
472
|
+
class ServiceLockInfo
|
|
473
|
+
include ::Google::Protobuf::MessageExts
|
|
474
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
475
|
+
end
|
|
476
|
+
|
|
477
|
+
# BackupApplianceLockInfo contains metadata about the backupappliance that
|
|
478
|
+
# created the lock.
|
|
479
|
+
# @!attribute [rw] job_name
|
|
480
|
+
# @return [::String]
|
|
481
|
+
# The job name on the backup/recovery appliance that created this lock.
|
|
482
|
+
#
|
|
483
|
+
# Note: The following fields are mutually exclusive: `job_name`, `backup_image`, `sla_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
484
|
+
# @!attribute [rw] backup_image
|
|
485
|
+
# @return [::String]
|
|
486
|
+
# The image name that depends on this Backup.
|
|
487
|
+
#
|
|
488
|
+
# Note: The following fields are mutually exclusive: `backup_image`, `job_name`, `sla_id`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
489
|
+
# @!attribute [rw] sla_id
|
|
490
|
+
# @return [::Integer]
|
|
491
|
+
# The SLA on the backup/recovery appliance that owns the lock.
|
|
492
|
+
#
|
|
493
|
+
# Note: The following fields are mutually exclusive: `sla_id`, `job_name`, `backup_image`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
494
|
+
# @!attribute [rw] backup_appliance_id
|
|
495
|
+
# @return [::Integer]
|
|
496
|
+
# Required. The ID of the backup/recovery appliance that created this lock.
|
|
497
|
+
# @!attribute [rw] backup_appliance_name
|
|
498
|
+
# @return [::String]
|
|
499
|
+
# Required. The name of the backup/recovery appliance that created this lock.
|
|
500
|
+
# @!attribute [rw] lock_reason
|
|
501
|
+
# @return [::String]
|
|
502
|
+
# Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The
|
|
503
|
+
# value of this string is only meaningful to the client and it is not
|
|
504
|
+
# interpreted by the BackupVault service.
|
|
505
|
+
class BackupApplianceLockInfo
|
|
506
|
+
include ::Google::Protobuf::MessageExts
|
|
507
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
508
|
+
end
|
|
509
|
+
|
|
510
|
+
# BackupLock represents a single lock on a Backup resource. An unexpired
|
|
511
|
+
# lock on a Backup prevents the Backup from being deleted.
|
|
512
|
+
# @!attribute [rw] backup_appliance_lock_info
|
|
513
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupApplianceLockInfo]
|
|
514
|
+
# If the client is a backup and recovery appliance, this
|
|
515
|
+
# contains metadata about why the lock exists.
|
|
516
|
+
#
|
|
517
|
+
# Note: The following fields are mutually exclusive: `backup_appliance_lock_info`, `service_lock_info`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
518
|
+
# @!attribute [r] service_lock_info
|
|
519
|
+
# @return [::Google::Cloud::BackupDR::V1beta::ServiceLockInfo]
|
|
520
|
+
# Output only. Contains metadata about the lock exist for Google Cloud
|
|
521
|
+
# native backups.
|
|
522
|
+
#
|
|
523
|
+
# Note: The following fields are mutually exclusive: `service_lock_info`, `backup_appliance_lock_info`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
524
|
+
# @!attribute [rw] lock_until_time
|
|
525
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
526
|
+
# Required. The time after which this lock is not considered valid and will
|
|
527
|
+
# no longer protect the Backup from deletion.
|
|
528
|
+
class BackupLock
|
|
529
|
+
include ::Google::Protobuf::MessageExts
|
|
530
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
531
|
+
end
|
|
532
|
+
|
|
533
|
+
# Message describing a Backup object.
|
|
534
|
+
# @!attribute [r] compute_instance_backup_properties
|
|
535
|
+
# @return [::Google::Cloud::BackupDR::V1beta::ComputeInstanceBackupProperties]
|
|
536
|
+
# Output only. Compute Engine specific backup properties.
|
|
537
|
+
#
|
|
538
|
+
# Note: The following fields are mutually exclusive: `compute_instance_backup_properties`, `cloud_sql_instance_backup_properties`, `backup_appliance_backup_properties`, `alloy_db_backup_properties`, `disk_backup_properties`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
539
|
+
# @!attribute [r] cloud_sql_instance_backup_properties
|
|
540
|
+
# @return [::Google::Cloud::BackupDR::V1beta::CloudSqlInstanceBackupProperties]
|
|
541
|
+
# Output only. Cloud SQL specific backup properties.
|
|
542
|
+
#
|
|
543
|
+
# Note: The following fields are mutually exclusive: `cloud_sql_instance_backup_properties`, `compute_instance_backup_properties`, `backup_appliance_backup_properties`, `alloy_db_backup_properties`, `disk_backup_properties`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
544
|
+
# @!attribute [r] backup_appliance_backup_properties
|
|
545
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupApplianceBackupProperties]
|
|
546
|
+
# Output only. Backup Appliance specific backup properties.
|
|
547
|
+
#
|
|
548
|
+
# Note: The following fields are mutually exclusive: `backup_appliance_backup_properties`, `compute_instance_backup_properties`, `cloud_sql_instance_backup_properties`, `alloy_db_backup_properties`, `disk_backup_properties`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
549
|
+
# @!attribute [r] alloy_db_backup_properties
|
|
550
|
+
# @return [::Google::Cloud::BackupDR::V1beta::AlloyDbClusterBackupProperties]
|
|
551
|
+
# Output only. AlloyDB specific backup properties.
|
|
552
|
+
#
|
|
553
|
+
# Note: The following fields are mutually exclusive: `alloy_db_backup_properties`, `compute_instance_backup_properties`, `cloud_sql_instance_backup_properties`, `backup_appliance_backup_properties`, `disk_backup_properties`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
554
|
+
# @!attribute [r] disk_backup_properties
|
|
555
|
+
# @return [::Google::Cloud::BackupDR::V1beta::DiskBackupProperties]
|
|
556
|
+
# Output only. Disk specific backup properties.
|
|
557
|
+
#
|
|
558
|
+
# Note: The following fields are mutually exclusive: `disk_backup_properties`, `compute_instance_backup_properties`, `cloud_sql_instance_backup_properties`, `backup_appliance_backup_properties`, `alloy_db_backup_properties`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
559
|
+
# @!attribute [r] gcp_backup_plan_info
|
|
560
|
+
# @return [::Google::Cloud::BackupDR::V1beta::Backup::GCPBackupPlanInfo]
|
|
561
|
+
# Output only. Configuration for a Google Cloud resource.
|
|
562
|
+
# @!attribute [r] gcp_resource
|
|
563
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupGcpResource]
|
|
564
|
+
# Output only. Unique identifier of the GCP resource that is being backed
|
|
565
|
+
# up.
|
|
566
|
+
# @!attribute [r] name
|
|
567
|
+
# @return [::String]
|
|
568
|
+
# Output only. Identifier. Name of the backup to create. It must have the
|
|
569
|
+
# format`"projects/<project>/locations/<location>/backupVaults/<backupvault>/dataSources/{datasource}/backups/{backup}"`.
|
|
570
|
+
# `{backup}` cannot be changed after creation. It must be between 3-63
|
|
571
|
+
# characters long and must be unique within the datasource.
|
|
572
|
+
# @!attribute [r] description
|
|
573
|
+
# @return [::String]
|
|
574
|
+
# Output only. The description of the Backup instance (2048 characters or
|
|
575
|
+
# less).
|
|
576
|
+
# @!attribute [r] create_time
|
|
577
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
578
|
+
# Output only. The time when the instance was created.
|
|
579
|
+
# @!attribute [r] update_time
|
|
580
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
581
|
+
# Output only. The time when the instance was updated.
|
|
582
|
+
# @!attribute [rw] labels
|
|
583
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
584
|
+
# Optional. Resource labels to represent user provided metadata.
|
|
585
|
+
# No labels currently defined.
|
|
586
|
+
# @!attribute [rw] enforced_retention_end_time
|
|
587
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
588
|
+
# Optional. The backup can not be deleted before this time.
|
|
589
|
+
# @!attribute [r] backup_retention_inheritance
|
|
590
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupVault::BackupRetentionInheritance]
|
|
591
|
+
# Output only. Setting for how the enforced retention end time is inherited.
|
|
592
|
+
# This value is copied from this backup's BackupVault.
|
|
593
|
+
# @!attribute [rw] expire_time
|
|
594
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
595
|
+
# Optional. When this backup is automatically expired.
|
|
596
|
+
# @!attribute [r] consistency_time
|
|
597
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
598
|
+
# Output only. The point in time when this backup was captured from the
|
|
599
|
+
# source.
|
|
600
|
+
# @!attribute [rw] etag
|
|
601
|
+
# @return [::String]
|
|
602
|
+
# Optional. Server specified ETag to prevent updates from overwriting each
|
|
603
|
+
# other.
|
|
604
|
+
# @!attribute [r] state
|
|
605
|
+
# @return [::Google::Cloud::BackupDR::V1beta::Backup::State]
|
|
606
|
+
# Output only. The Backup resource instance state.
|
|
607
|
+
# @!attribute [r] service_locks
|
|
608
|
+
# @return [::Array<::Google::Cloud::BackupDR::V1beta::BackupLock>]
|
|
609
|
+
# Output only. The list of BackupLocks taken by the service to prevent the
|
|
610
|
+
# deletion of the backup.
|
|
611
|
+
# @!attribute [rw] backup_appliance_locks
|
|
612
|
+
# @return [::Array<::Google::Cloud::BackupDR::V1beta::BackupLock>]
|
|
613
|
+
# Optional. The list of BackupLocks taken by the accessor Backup Appliance.
|
|
614
|
+
# @!attribute [r] backup_type
|
|
615
|
+
# @return [::Google::Cloud::BackupDR::V1beta::Backup::BackupType]
|
|
616
|
+
# Output only. Type of the backup, unspecified, scheduled or ondemand.
|
|
617
|
+
# @!attribute [r] resource_size_bytes
|
|
618
|
+
# @return [::Integer]
|
|
619
|
+
# Output only. source resource size in bytes at the time of the backup.
|
|
620
|
+
# @!attribute [r] satisfies_pzs
|
|
621
|
+
# @return [::Boolean]
|
|
622
|
+
# Optional. Output only. Reserved for future use.
|
|
623
|
+
# @!attribute [r] satisfies_pzi
|
|
624
|
+
# @return [::Boolean]
|
|
625
|
+
# Optional. Output only. Reserved for future use.
|
|
626
|
+
# @!attribute [r] kms_key_versions
|
|
627
|
+
# @return [::Array<::String>]
|
|
628
|
+
# Optional. Output only. The list of KMS key versions used to encrypt the
|
|
629
|
+
# backup.
|
|
630
|
+
class Backup
|
|
631
|
+
include ::Google::Protobuf::MessageExts
|
|
632
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
633
|
+
|
|
634
|
+
# GCPBackupPlanInfo captures the plan configuration details of Google Cloud
|
|
635
|
+
# resources at the time of backup.
|
|
636
|
+
# @!attribute [rw] backup_plan
|
|
637
|
+
# @return [::String]
|
|
638
|
+
# Resource name of backup plan by which workload is protected at the time
|
|
639
|
+
# of the backup.
|
|
640
|
+
# Format:
|
|
641
|
+
# projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}
|
|
642
|
+
# @!attribute [rw] backup_plan_rule_id
|
|
643
|
+
# @return [::String]
|
|
644
|
+
# The rule id of the backup plan which triggered this backup in case of
|
|
645
|
+
# scheduled backup or used for
|
|
646
|
+
# @!attribute [rw] backup_plan_revision_name
|
|
647
|
+
# @return [::String]
|
|
648
|
+
# Resource name of the backup plan revision which triggered this backup in
|
|
649
|
+
# case of scheduled backup or used for on demand backup.
|
|
650
|
+
# Format:
|
|
651
|
+
# projects/\\{project}/locations/\\{location}/backupPlans/\\{backupPlanId}/revisions/\\{revisionId}
|
|
652
|
+
# @!attribute [rw] backup_plan_revision_id
|
|
653
|
+
# @return [::String]
|
|
654
|
+
# The user friendly id of the backup plan revision which triggered this
|
|
655
|
+
# backup in case of scheduled backup or used for on demand backup.
|
|
656
|
+
class GCPBackupPlanInfo
|
|
657
|
+
include ::Google::Protobuf::MessageExts
|
|
658
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
659
|
+
end
|
|
660
|
+
|
|
661
|
+
# @!attribute [rw] key
|
|
662
|
+
# @return [::String]
|
|
663
|
+
# @!attribute [rw] value
|
|
664
|
+
# @return [::String]
|
|
665
|
+
class LabelsEntry
|
|
666
|
+
include ::Google::Protobuf::MessageExts
|
|
667
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
668
|
+
end
|
|
669
|
+
|
|
670
|
+
# Holds the state of the backup resource.
|
|
671
|
+
module State
|
|
672
|
+
# State not set.
|
|
673
|
+
STATE_UNSPECIFIED = 0
|
|
674
|
+
|
|
675
|
+
# The backup is being created.
|
|
676
|
+
CREATING = 1
|
|
677
|
+
|
|
678
|
+
# The backup has been created and is fully usable.
|
|
679
|
+
ACTIVE = 2
|
|
680
|
+
|
|
681
|
+
# The backup is being deleted.
|
|
682
|
+
DELETING = 3
|
|
683
|
+
|
|
684
|
+
# The backup is experiencing an issue and might be unusable.
|
|
685
|
+
ERROR = 4
|
|
686
|
+
|
|
687
|
+
# The backup is being uploaded.
|
|
688
|
+
UPLOADING = 5
|
|
689
|
+
end
|
|
690
|
+
|
|
691
|
+
# Type of the backup, scheduled or ondemand.
|
|
692
|
+
module BackupType
|
|
693
|
+
# Backup type is unspecified.
|
|
694
|
+
BACKUP_TYPE_UNSPECIFIED = 0
|
|
695
|
+
|
|
696
|
+
# Scheduled backup.
|
|
697
|
+
SCHEDULED = 1
|
|
698
|
+
|
|
699
|
+
# On demand backup.
|
|
700
|
+
ON_DEMAND = 2
|
|
701
|
+
|
|
702
|
+
# Operational backup.
|
|
703
|
+
ON_DEMAND_OPERATIONAL = 3
|
|
704
|
+
end
|
|
705
|
+
end
|
|
706
|
+
|
|
707
|
+
# Message for creating a BackupVault.
|
|
708
|
+
# @!attribute [rw] parent
|
|
709
|
+
# @return [::String]
|
|
710
|
+
# Required. Value for parent.
|
|
711
|
+
# @!attribute [rw] backup_vault_id
|
|
712
|
+
# @return [::String]
|
|
713
|
+
# Required. ID of the requesting object
|
|
714
|
+
# If auto-generating ID server-side, remove this field and
|
|
715
|
+
# backup_vault_id from the method_signature of Create RPC
|
|
716
|
+
# @!attribute [rw] backup_vault
|
|
717
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupVault]
|
|
718
|
+
# Required. The resource being created
|
|
719
|
+
# @!attribute [rw] request_id
|
|
720
|
+
# @return [::String]
|
|
721
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
722
|
+
# request ID so that if you must retry your request, the server will know to
|
|
723
|
+
# ignore the request if it has already been completed. The server will
|
|
724
|
+
# guarantee that for at least 60 minutes since the first request.
|
|
725
|
+
#
|
|
726
|
+
# For example, consider a situation where you make an initial request and
|
|
727
|
+
# the request times out. If you make the request again with the same request
|
|
728
|
+
# ID, the server can check if original operation with the same request ID
|
|
729
|
+
# was received, and if so, will ignore the second request. This prevents
|
|
730
|
+
# clients from accidentally creating duplicate commitments.
|
|
731
|
+
#
|
|
732
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
|
733
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
|
734
|
+
# @!attribute [rw] validate_only
|
|
735
|
+
# @return [::Boolean]
|
|
736
|
+
# Optional. Only validate the request, but do not perform mutations.
|
|
737
|
+
# The default is 'false'.
|
|
738
|
+
class CreateBackupVaultRequest
|
|
739
|
+
include ::Google::Protobuf::MessageExts
|
|
740
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
741
|
+
end
|
|
742
|
+
|
|
743
|
+
# Request message for listing backupvault stores.
|
|
744
|
+
# @!attribute [rw] parent
|
|
745
|
+
# @return [::String]
|
|
746
|
+
# Required. The project and location for which to retrieve backupvault stores
|
|
747
|
+
# information, in the format 'projects/\\{project_id}/locations/\\{location}'. In
|
|
748
|
+
# Google Cloud Backup and DR, locations map to Google Cloud regions, for
|
|
749
|
+
# example
|
|
750
|
+
# **us-central1**.
|
|
751
|
+
# To retrieve backupvault stores for all locations, use "-" for the
|
|
752
|
+
# '\\{location}' value.
|
|
753
|
+
# @!attribute [rw] page_size
|
|
754
|
+
# @return [::Integer]
|
|
755
|
+
# Optional. Requested page size. Server may return fewer items than
|
|
756
|
+
# requested. If unspecified, server will pick an appropriate default.
|
|
757
|
+
# @!attribute [rw] page_token
|
|
758
|
+
# @return [::String]
|
|
759
|
+
# Optional. A token identifying a page of results the server should return.
|
|
760
|
+
# @!attribute [rw] filter
|
|
761
|
+
# @return [::String]
|
|
762
|
+
# Optional. Filtering results.
|
|
763
|
+
# @!attribute [rw] order_by
|
|
764
|
+
# @return [::String]
|
|
765
|
+
# Optional. Hint for how to order the results.
|
|
766
|
+
# @!attribute [rw] view
|
|
767
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupVaultView]
|
|
768
|
+
# Optional. Reserved for future use to provide a BASIC & FULL view of Backup
|
|
769
|
+
# Vault.
|
|
770
|
+
class ListBackupVaultsRequest
|
|
771
|
+
include ::Google::Protobuf::MessageExts
|
|
772
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
773
|
+
end
|
|
774
|
+
|
|
775
|
+
# Response message for listing BackupVaults.
|
|
776
|
+
# @!attribute [rw] backup_vaults
|
|
777
|
+
# @return [::Array<::Google::Cloud::BackupDR::V1beta::BackupVault>]
|
|
778
|
+
# The list of BackupVault instances in the project for the specified
|
|
779
|
+
# location.
|
|
780
|
+
#
|
|
781
|
+
# If the '\\{location}' value in the request is "-", the response contains a
|
|
782
|
+
# list of instances from all locations. In case any location is unreachable,
|
|
783
|
+
# the response will only return backup vaults in reachable locations and
|
|
784
|
+
# the 'unreachable' field will be populated with a list of unreachable
|
|
785
|
+
# locations.
|
|
786
|
+
# @!attribute [rw] next_page_token
|
|
787
|
+
# @return [::String]
|
|
788
|
+
# A token identifying a page of results the server should return.
|
|
789
|
+
# @!attribute [rw] unreachable
|
|
790
|
+
# @return [::Array<::String>]
|
|
791
|
+
# Locations that could not be reached.
|
|
792
|
+
class ListBackupVaultsResponse
|
|
793
|
+
include ::Google::Protobuf::MessageExts
|
|
794
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
795
|
+
end
|
|
796
|
+
|
|
797
|
+
# Request message for fetching usable BackupVaults.
|
|
798
|
+
# @!attribute [rw] parent
|
|
799
|
+
# @return [::String]
|
|
800
|
+
# Required. The project and location for which to retrieve backupvault stores
|
|
801
|
+
# information, in the format 'projects/\\{project_id}/locations/\\{location}'. In
|
|
802
|
+
# Google Cloud Backup and DR, locations map to Google Cloud regions, for
|
|
803
|
+
# example
|
|
804
|
+
# **us-central1**.
|
|
805
|
+
# To retrieve backupvault stores for all locations, use "-" for the
|
|
806
|
+
# '\\{location}' value.
|
|
807
|
+
# @!attribute [rw] page_size
|
|
808
|
+
# @return [::Integer]
|
|
809
|
+
# Optional. Requested page size. Server may return fewer items than
|
|
810
|
+
# requested. If unspecified, server will pick an appropriate default.
|
|
811
|
+
# @!attribute [rw] page_token
|
|
812
|
+
# @return [::String]
|
|
813
|
+
# Optional. A token identifying a page of results the server should return.
|
|
814
|
+
# @!attribute [rw] filter
|
|
815
|
+
# @return [::String]
|
|
816
|
+
# Optional. Filtering results.
|
|
817
|
+
# @!attribute [rw] order_by
|
|
818
|
+
# @return [::String]
|
|
819
|
+
# Optional. Hint for how to order the results.
|
|
820
|
+
class FetchUsableBackupVaultsRequest
|
|
821
|
+
include ::Google::Protobuf::MessageExts
|
|
822
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
823
|
+
end
|
|
824
|
+
|
|
825
|
+
# Response message for fetching usable BackupVaults.
|
|
826
|
+
# @!attribute [rw] backup_vaults
|
|
827
|
+
# @return [::Array<::Google::Cloud::BackupDR::V1beta::BackupVault>]
|
|
828
|
+
# The list of BackupVault instances in the project for the specified
|
|
829
|
+
# location.
|
|
830
|
+
#
|
|
831
|
+
# If the '\\{location}' value in the request is "-", the response contains a
|
|
832
|
+
# list of instances from all locations. In case any location is unreachable,
|
|
833
|
+
# the response will only return backup vaults in reachable locations and
|
|
834
|
+
# the 'unreachable' field will be populated with a list of unreachable
|
|
835
|
+
# locations.
|
|
836
|
+
# @!attribute [rw] next_page_token
|
|
837
|
+
# @return [::String]
|
|
838
|
+
# A token identifying a page of results the server should return.
|
|
839
|
+
# @!attribute [rw] unreachable
|
|
840
|
+
# @return [::Array<::String>]
|
|
841
|
+
# Locations that could not be reached.
|
|
842
|
+
class FetchUsableBackupVaultsResponse
|
|
843
|
+
include ::Google::Protobuf::MessageExts
|
|
844
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
845
|
+
end
|
|
846
|
+
|
|
847
|
+
# Request for the FetchBackupsForResourceType method.
|
|
848
|
+
# @!attribute [rw] parent
|
|
849
|
+
# @return [::String]
|
|
850
|
+
# Required. Datasources are the parent resource for the backups.
|
|
851
|
+
# Format:
|
|
852
|
+
# projects/\\{project}/locations/\\{location}/backupVaults/\\{backupVaultId}/dataSources/\\{datasourceId}
|
|
853
|
+
# @!attribute [rw] resource_type
|
|
854
|
+
# @return [::String]
|
|
855
|
+
# Required. The type of the GCP resource.
|
|
856
|
+
# Ex: sqladmin.googleapis.com/Instance
|
|
857
|
+
# @!attribute [rw] page_size
|
|
858
|
+
# @return [::Integer]
|
|
859
|
+
# Optional. The maximum number of Backups to return. The service may
|
|
860
|
+
# return fewer than this value. If unspecified, at most 50
|
|
861
|
+
# Backups will be returned. The maximum value is 100; values
|
|
862
|
+
# above 100 will be coerced to 100.
|
|
863
|
+
# @!attribute [rw] page_token
|
|
864
|
+
# @return [::String]
|
|
865
|
+
# Optional. A page token, received from a previous call of
|
|
866
|
+
# `FetchBackupsForResourceType`.
|
|
867
|
+
# Provide this to retrieve the subsequent page.
|
|
868
|
+
#
|
|
869
|
+
# When paginating, all other parameters provided to
|
|
870
|
+
# `FetchBackupsForResourceType` must match
|
|
871
|
+
# the call that provided the page token.
|
|
872
|
+
# @!attribute [rw] filter
|
|
873
|
+
# @return [::String]
|
|
874
|
+
# Optional. A filter expression that filters the results fetched in the
|
|
875
|
+
# response. The expression must specify the field name, a comparison
|
|
876
|
+
# operator, and the value that you want to use for filtering. Supported
|
|
877
|
+
# fields:
|
|
878
|
+
# * name
|
|
879
|
+
# * state
|
|
880
|
+
# * backup_type
|
|
881
|
+
# * create_time
|
|
882
|
+
# * expire_time
|
|
883
|
+
# * enforced_retention_end_time
|
|
884
|
+
# * gcp_backup_plan_info.backup_plan
|
|
885
|
+
# * cloud_sql_instance_backup_properties.instance_tier
|
|
886
|
+
# * cloud_sql_instance_backup_properties.database_installed_version
|
|
887
|
+
# @!attribute [rw] order_by
|
|
888
|
+
# @return [::String]
|
|
889
|
+
# Optional. A comma-separated list of fields to order by, sorted in ascending
|
|
890
|
+
# order. Use "desc" after a field name for descending.
|
|
891
|
+
#
|
|
892
|
+
# Supported fields:
|
|
893
|
+
# * name
|
|
894
|
+
# @!attribute [rw] view
|
|
895
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupView]
|
|
896
|
+
# Optional. This parameter is used to specify the view of the backup.
|
|
897
|
+
# If not specified, the default view is BASIC.
|
|
898
|
+
class FetchBackupsForResourceTypeRequest
|
|
899
|
+
include ::Google::Protobuf::MessageExts
|
|
900
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
901
|
+
end
|
|
902
|
+
|
|
903
|
+
# Response for the FetchBackupsForResourceType method.
|
|
904
|
+
# @!attribute [rw] backups
|
|
905
|
+
# @return [::Array<::Google::Cloud::BackupDR::V1beta::Backup>]
|
|
906
|
+
# The Backups from the specified parent.
|
|
907
|
+
# @!attribute [rw] next_page_token
|
|
908
|
+
# @return [::String]
|
|
909
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
910
|
+
# If this field is omitted, there are no subsequent pages.
|
|
911
|
+
class FetchBackupsForResourceTypeResponse
|
|
912
|
+
include ::Google::Protobuf::MessageExts
|
|
913
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
914
|
+
end
|
|
915
|
+
|
|
916
|
+
# Request message for getting a BackupVault.
|
|
917
|
+
# @!attribute [rw] name
|
|
918
|
+
# @return [::String]
|
|
919
|
+
# Required. Name of the backupvault store resource name, in the format
|
|
920
|
+
# 'projects/\\{project_id}/locations/\\{location}/backupVaults/\\{resource_name}'
|
|
921
|
+
# @!attribute [rw] view
|
|
922
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupVaultView]
|
|
923
|
+
# Optional. Reserved for future use to provide a BASIC & FULL view of Backup
|
|
924
|
+
# Vault
|
|
925
|
+
class GetBackupVaultRequest
|
|
926
|
+
include ::Google::Protobuf::MessageExts
|
|
927
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
928
|
+
end
|
|
929
|
+
|
|
930
|
+
# Request message for updating a BackupVault.
|
|
931
|
+
# @!attribute [rw] update_mask
|
|
932
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
933
|
+
# Required. Field mask is used to specify the fields to be overwritten in the
|
|
934
|
+
# BackupVault resource by the update.
|
|
935
|
+
# The fields specified in the update_mask are relative to the resource, not
|
|
936
|
+
# the full request. A field will be overwritten if it is in the mask. If the
|
|
937
|
+
# user does not provide a mask then the request will fail.
|
|
938
|
+
# @!attribute [rw] backup_vault
|
|
939
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupVault]
|
|
940
|
+
# Required. The resource being updated
|
|
941
|
+
# @!attribute [rw] request_id
|
|
942
|
+
# @return [::String]
|
|
943
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
944
|
+
# request ID so that if you must retry your request, the server will know to
|
|
945
|
+
# ignore the request if it has already been completed. The server will
|
|
946
|
+
# guarantee that for at least 60 minutes since the first request.
|
|
947
|
+
#
|
|
948
|
+
# For example, consider a situation where you make an initial request and
|
|
949
|
+
# the request times out. If you make the request again with the same request
|
|
950
|
+
# ID, the server can check if original operation with the same request ID
|
|
951
|
+
# was received, and if so, will ignore the second request. This prevents
|
|
952
|
+
# clients from accidentally creating duplicate commitments.
|
|
953
|
+
#
|
|
954
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
|
955
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
|
956
|
+
# @!attribute [rw] validate_only
|
|
957
|
+
# @return [::Boolean]
|
|
958
|
+
# Optional. Only validate the request, but do not perform mutations.
|
|
959
|
+
# The default is 'false'.
|
|
960
|
+
# @!attribute [rw] force
|
|
961
|
+
# @return [::Boolean]
|
|
962
|
+
# Optional. If set to true, will not check plan duration against backup vault
|
|
963
|
+
# enforcement duration.
|
|
964
|
+
# @!attribute [rw] force_update_access_restriction
|
|
965
|
+
# @return [::Boolean]
|
|
966
|
+
# Optional. If set to true, we will force update access restriction even if
|
|
967
|
+
# some non compliant data sources are present. The default is 'false'.
|
|
968
|
+
class UpdateBackupVaultRequest
|
|
969
|
+
include ::Google::Protobuf::MessageExts
|
|
970
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
971
|
+
end
|
|
972
|
+
|
|
973
|
+
# Message for deleting a BackupVault.
|
|
974
|
+
# @!attribute [rw] name
|
|
975
|
+
# @return [::String]
|
|
976
|
+
# Required. Name of the resource.
|
|
977
|
+
# @!attribute [rw] request_id
|
|
978
|
+
# @return [::String]
|
|
979
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
980
|
+
# request ID so that if you must retry your request, the server will know to
|
|
981
|
+
# ignore the request if it has already been completed. The server will
|
|
982
|
+
# guarantee that for at least 60 minutes after the first request.
|
|
983
|
+
#
|
|
984
|
+
# For example, consider a situation where you make an initial request and
|
|
985
|
+
# the request times out. If you make the request again with the same request
|
|
986
|
+
# ID, the server can check if original operation with the same request ID
|
|
987
|
+
# was received, and if so, will ignore the second request. This prevents
|
|
988
|
+
# clients from accidentally creating duplicate commitments.
|
|
989
|
+
#
|
|
990
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
|
991
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
|
992
|
+
# @!attribute [rw] force
|
|
993
|
+
# @return [::Boolean]
|
|
994
|
+
# Optional. If set to true, any data source from this backup vault will also
|
|
995
|
+
# be deleted.
|
|
996
|
+
# @!attribute [rw] etag
|
|
997
|
+
# @return [::String]
|
|
998
|
+
# The current etag of the backup vault.
|
|
999
|
+
# If an etag is provided and does not match the current etag of the
|
|
1000
|
+
# connection, deletion will be blocked.
|
|
1001
|
+
# @!attribute [rw] validate_only
|
|
1002
|
+
# @return [::Boolean]
|
|
1003
|
+
# Optional. Only validate the request, but do not perform mutations.
|
|
1004
|
+
# The default is 'false'.
|
|
1005
|
+
# @!attribute [rw] allow_missing
|
|
1006
|
+
# @return [::Boolean]
|
|
1007
|
+
# Optional. If true and the BackupVault is not found, the request will
|
|
1008
|
+
# succeed but no action will be taken.
|
|
1009
|
+
# @!attribute [rw] ignore_backup_plan_references
|
|
1010
|
+
# @return [::Boolean]
|
|
1011
|
+
# Optional. If set to true, backupvault deletion will proceed even if there
|
|
1012
|
+
# are backup plans referencing the backupvault. The default is 'false'.
|
|
1013
|
+
class DeleteBackupVaultRequest
|
|
1014
|
+
include ::Google::Protobuf::MessageExts
|
|
1015
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1016
|
+
end
|
|
1017
|
+
|
|
1018
|
+
# Request message for listing DataSources.
|
|
1019
|
+
# @!attribute [rw] parent
|
|
1020
|
+
# @return [::String]
|
|
1021
|
+
# Required. The project and location for which to retrieve data
|
|
1022
|
+
# sources information, in the format
|
|
1023
|
+
# 'projects/\\{project_id}/locations/\\{location}'. In Google Cloud Backup and
|
|
1024
|
+
# DR, locations map to Google Cloud regions, for example
|
|
1025
|
+
# **us-central1**.
|
|
1026
|
+
# To retrieve data sources for all locations, use "-" for the
|
|
1027
|
+
# '\\{location}' value.
|
|
1028
|
+
# @!attribute [rw] page_size
|
|
1029
|
+
# @return [::Integer]
|
|
1030
|
+
# Optional. Requested page size. Server may return fewer items than
|
|
1031
|
+
# requested. If unspecified, server will pick an appropriate default.
|
|
1032
|
+
# @!attribute [rw] page_token
|
|
1033
|
+
# @return [::String]
|
|
1034
|
+
# Optional. A token identifying a page of results the server should return.
|
|
1035
|
+
# @!attribute [rw] filter
|
|
1036
|
+
# @return [::String]
|
|
1037
|
+
# Optional. Filtering results.
|
|
1038
|
+
# @!attribute [rw] order_by
|
|
1039
|
+
# @return [::String]
|
|
1040
|
+
# Optional. Hint for how to order the results.
|
|
1041
|
+
class ListDataSourcesRequest
|
|
1042
|
+
include ::Google::Protobuf::MessageExts
|
|
1043
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1044
|
+
end
|
|
1045
|
+
|
|
1046
|
+
# Response message for listing DataSources.
|
|
1047
|
+
# @!attribute [rw] data_sources
|
|
1048
|
+
# @return [::Array<::Google::Cloud::BackupDR::V1beta::DataSource>]
|
|
1049
|
+
# The list of DataSource instances in the project for the specified
|
|
1050
|
+
# location.
|
|
1051
|
+
#
|
|
1052
|
+
# If the '\\{location}' value in the request is "-", the response contains a
|
|
1053
|
+
# list of instances from all locations. In case any location is unreachable,
|
|
1054
|
+
# the response will only return data sources in reachable locations
|
|
1055
|
+
# and the 'unreachable' field will be populated with a list of unreachable
|
|
1056
|
+
# locations.
|
|
1057
|
+
# @!attribute [rw] next_page_token
|
|
1058
|
+
# @return [::String]
|
|
1059
|
+
# A token identifying a page of results the server should return.
|
|
1060
|
+
# @!attribute [rw] unreachable
|
|
1061
|
+
# @return [::Array<::String>]
|
|
1062
|
+
# Locations that could not be reached.
|
|
1063
|
+
class ListDataSourcesResponse
|
|
1064
|
+
include ::Google::Protobuf::MessageExts
|
|
1065
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1066
|
+
end
|
|
1067
|
+
|
|
1068
|
+
# Request message for getting a DataSource instance.
|
|
1069
|
+
# @!attribute [rw] name
|
|
1070
|
+
# @return [::String]
|
|
1071
|
+
# Required. Name of the data source resource name, in the format
|
|
1072
|
+
# 'projects/\\{project_id}/locations/\\{location}/backupVaults/\\{resource_name}/dataSource/\\{resource_name}'
|
|
1073
|
+
class GetDataSourceRequest
|
|
1074
|
+
include ::Google::Protobuf::MessageExts
|
|
1075
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1076
|
+
end
|
|
1077
|
+
|
|
1078
|
+
# Request message for updating a data source instance.
|
|
1079
|
+
# @!attribute [rw] update_mask
|
|
1080
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
1081
|
+
# Required. Field mask is used to specify the fields to be overwritten in the
|
|
1082
|
+
# DataSource resource by the update.
|
|
1083
|
+
# The fields specified in the update_mask are relative to the resource, not
|
|
1084
|
+
# the full request. A field will be overwritten if it is in the mask. If the
|
|
1085
|
+
# user does not provide a mask then the request will fail.
|
|
1086
|
+
# @!attribute [rw] data_source
|
|
1087
|
+
# @return [::Google::Cloud::BackupDR::V1beta::DataSource]
|
|
1088
|
+
# Required. The resource being updated
|
|
1089
|
+
# @!attribute [rw] request_id
|
|
1090
|
+
# @return [::String]
|
|
1091
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
1092
|
+
# request ID so that if you must retry your request, the server will know to
|
|
1093
|
+
# ignore the request if it has already been completed. The server will
|
|
1094
|
+
# guarantee that for at least 60 minutes since the first request.
|
|
1095
|
+
#
|
|
1096
|
+
# For example, consider a situation where you make an initial request and
|
|
1097
|
+
# the request times out. If you make the request again with the same request
|
|
1098
|
+
# ID, the server can check if original operation with the same request ID
|
|
1099
|
+
# was received, and if so, will ignore the second request. This prevents
|
|
1100
|
+
# clients from accidentally creating duplicate commitments.
|
|
1101
|
+
#
|
|
1102
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
|
1103
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
|
1104
|
+
# @!attribute [rw] allow_missing
|
|
1105
|
+
# @return [::Boolean]
|
|
1106
|
+
# Optional. Enable upsert.
|
|
1107
|
+
class UpdateDataSourceRequest
|
|
1108
|
+
include ::Google::Protobuf::MessageExts
|
|
1109
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1110
|
+
end
|
|
1111
|
+
|
|
1112
|
+
# Request message for listing Backups.
|
|
1113
|
+
# @!attribute [rw] parent
|
|
1114
|
+
# @return [::String]
|
|
1115
|
+
# Required. The project and location for which to retrieve backup
|
|
1116
|
+
# information, in the format
|
|
1117
|
+
# 'projects/\\{project_id}/locations/\\{location}'. In Google Cloud Backup and
|
|
1118
|
+
# DR, locations map to Google Cloud regions, for example
|
|
1119
|
+
# **us-central1**.
|
|
1120
|
+
# To retrieve data sources for all locations, use "-" for the
|
|
1121
|
+
# '\\{location}' value.
|
|
1122
|
+
# @!attribute [rw] page_size
|
|
1123
|
+
# @return [::Integer]
|
|
1124
|
+
# Optional. Requested page size. Server may return fewer items than
|
|
1125
|
+
# requested. If unspecified, server will pick an appropriate default.
|
|
1126
|
+
# @!attribute [rw] page_token
|
|
1127
|
+
# @return [::String]
|
|
1128
|
+
# Optional. A token identifying a page of results the server should return.
|
|
1129
|
+
# @!attribute [rw] filter
|
|
1130
|
+
# @return [::String]
|
|
1131
|
+
# Optional. Filtering results.
|
|
1132
|
+
# @!attribute [rw] order_by
|
|
1133
|
+
# @return [::String]
|
|
1134
|
+
# Optional. Hint for how to order the results.
|
|
1135
|
+
# @!attribute [rw] view
|
|
1136
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupView]
|
|
1137
|
+
# Optional. Reserved for future use to provide a BASIC & FULL view of Backup
|
|
1138
|
+
# resource.
|
|
1139
|
+
class ListBackupsRequest
|
|
1140
|
+
include ::Google::Protobuf::MessageExts
|
|
1141
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1142
|
+
end
|
|
1143
|
+
|
|
1144
|
+
# Response message for listing Backups.
|
|
1145
|
+
# @!attribute [rw] backups
|
|
1146
|
+
# @return [::Array<::Google::Cloud::BackupDR::V1beta::Backup>]
|
|
1147
|
+
# The list of Backup instances in the project for the specified
|
|
1148
|
+
# location.
|
|
1149
|
+
#
|
|
1150
|
+
# If the '\\{location}' value in the request is "-", the response contains a
|
|
1151
|
+
# list of instances from all locations. In case any location is unreachable,
|
|
1152
|
+
# the response will only return data sources in reachable locations
|
|
1153
|
+
# and the 'unreachable' field will be populated with a list of unreachable
|
|
1154
|
+
# locations.
|
|
1155
|
+
# @!attribute [rw] next_page_token
|
|
1156
|
+
# @return [::String]
|
|
1157
|
+
# A token identifying a page of results the server should return.
|
|
1158
|
+
# @!attribute [rw] unreachable
|
|
1159
|
+
# @return [::Array<::String>]
|
|
1160
|
+
# Locations that could not be reached.
|
|
1161
|
+
class ListBackupsResponse
|
|
1162
|
+
include ::Google::Protobuf::MessageExts
|
|
1163
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1164
|
+
end
|
|
1165
|
+
|
|
1166
|
+
# Request message for getting a Backup.
|
|
1167
|
+
# @!attribute [rw] name
|
|
1168
|
+
# @return [::String]
|
|
1169
|
+
# Required. Name of the data source resource name, in the format
|
|
1170
|
+
# 'projects/\\{project_id}/locations/\\{location}/backupVaults/\\{backupVault}/dataSources/\\{datasource}/backups/\\{backup}'
|
|
1171
|
+
# @!attribute [rw] view
|
|
1172
|
+
# @return [::Google::Cloud::BackupDR::V1beta::BackupView]
|
|
1173
|
+
# Optional. Reserved for future use to provide a BASIC & FULL view of Backup
|
|
1174
|
+
# resource.
|
|
1175
|
+
class GetBackupRequest
|
|
1176
|
+
include ::Google::Protobuf::MessageExts
|
|
1177
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1178
|
+
end
|
|
1179
|
+
|
|
1180
|
+
# Request message for updating a Backup.
|
|
1181
|
+
# @!attribute [rw] update_mask
|
|
1182
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
1183
|
+
# Required. Field mask is used to specify the fields to be overwritten in the
|
|
1184
|
+
# Backup resource by the update.
|
|
1185
|
+
# The fields specified in the update_mask are relative to the resource, not
|
|
1186
|
+
# the full request. A field will be overwritten if it is in the mask. If the
|
|
1187
|
+
# user does not provide a mask then the request will fail.
|
|
1188
|
+
# @!attribute [rw] backup
|
|
1189
|
+
# @return [::Google::Cloud::BackupDR::V1beta::Backup]
|
|
1190
|
+
# Required. The resource being updated
|
|
1191
|
+
# @!attribute [rw] request_id
|
|
1192
|
+
# @return [::String]
|
|
1193
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
1194
|
+
# request ID so that if you must retry your request, the server will know to
|
|
1195
|
+
# ignore the request if it has already been completed. The server will
|
|
1196
|
+
# guarantee that for at least 60 minutes since the first request.
|
|
1197
|
+
#
|
|
1198
|
+
# For example, consider a situation where you make an initial request and
|
|
1199
|
+
# the request times out. If you make the request again with the same request
|
|
1200
|
+
# ID, the server can check if original operation with the same request ID
|
|
1201
|
+
# was received, and if so, will ignore the second request. This prevents
|
|
1202
|
+
# clients from accidentally creating duplicate commitments.
|
|
1203
|
+
#
|
|
1204
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
|
1205
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
|
1206
|
+
class UpdateBackupRequest
|
|
1207
|
+
include ::Google::Protobuf::MessageExts
|
|
1208
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1209
|
+
end
|
|
1210
|
+
|
|
1211
|
+
# Message for deleting a Backup.
|
|
1212
|
+
# @!attribute [rw] name
|
|
1213
|
+
# @return [::String]
|
|
1214
|
+
# Required. Name of the resource.
|
|
1215
|
+
# @!attribute [rw] request_id
|
|
1216
|
+
# @return [::String]
|
|
1217
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
1218
|
+
# request ID so that if you must retry your request, the server will know to
|
|
1219
|
+
# ignore the request if it has already been completed. The server will
|
|
1220
|
+
# guarantee that for at least 60 minutes after the first request.
|
|
1221
|
+
#
|
|
1222
|
+
# For example, consider a situation where you make an initial request and
|
|
1223
|
+
# the request times out. If you make the request again with the same request
|
|
1224
|
+
# ID, the server can check if original operation with the same request ID
|
|
1225
|
+
# was received, and if so, will ignore the second request. This prevents
|
|
1226
|
+
# clients from accidentally creating duplicate commitments.
|
|
1227
|
+
#
|
|
1228
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
|
1229
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
|
1230
|
+
class DeleteBackupRequest
|
|
1231
|
+
include ::Google::Protobuf::MessageExts
|
|
1232
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1233
|
+
end
|
|
1234
|
+
|
|
1235
|
+
# Request message for restoring from a Backup.
|
|
1236
|
+
# @!attribute [rw] compute_instance_target_environment
|
|
1237
|
+
# @return [::Google::Cloud::BackupDR::V1beta::ComputeInstanceTargetEnvironment]
|
|
1238
|
+
# Compute Engine target environment to be used during restore.
|
|
1239
|
+
#
|
|
1240
|
+
# Note: The following fields are mutually exclusive: `compute_instance_target_environment`, `disk_target_environment`, `region_disk_target_environment`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
1241
|
+
# @!attribute [rw] disk_target_environment
|
|
1242
|
+
# @return [::Google::Cloud::BackupDR::V1beta::DiskTargetEnvironment]
|
|
1243
|
+
# Disk target environment to be used during restore.
|
|
1244
|
+
#
|
|
1245
|
+
# Note: The following fields are mutually exclusive: `disk_target_environment`, `compute_instance_target_environment`, `region_disk_target_environment`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
1246
|
+
# @!attribute [rw] region_disk_target_environment
|
|
1247
|
+
# @return [::Google::Cloud::BackupDR::V1beta::RegionDiskTargetEnvironment]
|
|
1248
|
+
# Region disk target environment to be used during restore.
|
|
1249
|
+
#
|
|
1250
|
+
# Note: The following fields are mutually exclusive: `region_disk_target_environment`, `compute_instance_target_environment`, `disk_target_environment`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
1251
|
+
# @!attribute [rw] compute_instance_restore_properties
|
|
1252
|
+
# @return [::Google::Cloud::BackupDR::V1beta::ComputeInstanceRestoreProperties]
|
|
1253
|
+
# Compute Engine instance properties to be overridden during restore.
|
|
1254
|
+
#
|
|
1255
|
+
# Note: The following fields are mutually exclusive: `compute_instance_restore_properties`, `disk_restore_properties`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
1256
|
+
# @!attribute [rw] disk_restore_properties
|
|
1257
|
+
# @return [::Google::Cloud::BackupDR::V1beta::DiskRestoreProperties]
|
|
1258
|
+
# Disk properties to be overridden during restore.
|
|
1259
|
+
#
|
|
1260
|
+
# Note: The following fields are mutually exclusive: `disk_restore_properties`, `compute_instance_restore_properties`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
1261
|
+
# @!attribute [rw] name
|
|
1262
|
+
# @return [::String]
|
|
1263
|
+
# Required. The resource name of the Backup instance, in the format
|
|
1264
|
+
# 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'.
|
|
1265
|
+
# @!attribute [rw] request_id
|
|
1266
|
+
# @return [::String]
|
|
1267
|
+
# Optional. An optional request ID to identify requests. Specify a unique
|
|
1268
|
+
# request ID so that if you must retry your request, the server will know to
|
|
1269
|
+
# ignore the request if it has already been completed. The server will
|
|
1270
|
+
# guarantee that for at least 60 minutes after the first request.
|
|
1271
|
+
#
|
|
1272
|
+
# For example, consider a situation where you make an initial request and
|
|
1273
|
+
# the request times out. If you make the request again with the same request
|
|
1274
|
+
# ID, the server can check if original operation with the same request ID
|
|
1275
|
+
# was received, and if so, will ignore the second request. This prevents
|
|
1276
|
+
# clients from accidentally creating duplicate commitments.
|
|
1277
|
+
#
|
|
1278
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
|
1279
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
|
1280
|
+
# @!attribute [rw] clear_overrides_field_mask
|
|
1281
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
1282
|
+
# Optional. A field mask used to clear server-side default values
|
|
1283
|
+
# for fields within the `instance_properties` oneof.
|
|
1284
|
+
#
|
|
1285
|
+
# When a field in this mask is cleared, the server will not apply its
|
|
1286
|
+
# default logic (like inheriting a value from the source) for that field.
|
|
1287
|
+
#
|
|
1288
|
+
# The most common current use case is clearing default encryption keys.
|
|
1289
|
+
#
|
|
1290
|
+
# Examples of field mask paths:
|
|
1291
|
+
# - Compute Instance Disks:
|
|
1292
|
+
# `compute_instance_restore_properties.disks.*.disk_encryption_key`
|
|
1293
|
+
# - Single Disk: `disk_restore_properties.disk_encryption_key`
|
|
1294
|
+
class RestoreBackupRequest
|
|
1295
|
+
include ::Google::Protobuf::MessageExts
|
|
1296
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1297
|
+
end
|
|
1298
|
+
|
|
1299
|
+
# Response message for restoring from a Backup.
|
|
1300
|
+
# @!attribute [rw] target_resource
|
|
1301
|
+
# @return [::Google::Cloud::BackupDR::V1beta::TargetResource]
|
|
1302
|
+
# Details of the target resource created/modified as part of restore.
|
|
1303
|
+
class RestoreBackupResponse
|
|
1304
|
+
include ::Google::Protobuf::MessageExts
|
|
1305
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1306
|
+
end
|
|
1307
|
+
|
|
1308
|
+
# Details of the target resource created/modified as part of restore.
|
|
1309
|
+
# @!attribute [rw] gcp_resource
|
|
1310
|
+
# @return [::Google::Cloud::BackupDR::V1beta::GcpResource]
|
|
1311
|
+
# Details of the native Google Cloud resource created as part of restore.
|
|
1312
|
+
class TargetResource
|
|
1313
|
+
include ::Google::Protobuf::MessageExts
|
|
1314
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1315
|
+
end
|
|
1316
|
+
|
|
1317
|
+
# Minimum details to identify a Google Cloud resource
|
|
1318
|
+
# @!attribute [rw] gcp_resourcename
|
|
1319
|
+
# @return [::String]
|
|
1320
|
+
# Name of the Google Cloud resource.
|
|
1321
|
+
# @!attribute [rw] location
|
|
1322
|
+
# @return [::String]
|
|
1323
|
+
# Location of the resource: <region>/<zone>/"global"/"unspecified".
|
|
1324
|
+
# @!attribute [rw] type
|
|
1325
|
+
# @return [::String]
|
|
1326
|
+
# Type of the resource. Use the Unified Resource Type,
|
|
1327
|
+
# eg. compute.googleapis.com/Instance.
|
|
1328
|
+
class GcpResource
|
|
1329
|
+
include ::Google::Protobuf::MessageExts
|
|
1330
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1331
|
+
end
|
|
1332
|
+
|
|
1333
|
+
# Minimum details to identify a Google Cloud resource for a backup.
|
|
1334
|
+
# @!attribute [rw] gcp_resourcename
|
|
1335
|
+
# @return [::String]
|
|
1336
|
+
# Name of the Google Cloud resource.
|
|
1337
|
+
# @!attribute [rw] location
|
|
1338
|
+
# @return [::String]
|
|
1339
|
+
# Location of the resource: <region>/<zone>/"global"/"unspecified".
|
|
1340
|
+
# @!attribute [rw] type
|
|
1341
|
+
# @return [::String]
|
|
1342
|
+
# Type of the resource. Use the Unified Resource Type,
|
|
1343
|
+
# eg. compute.googleapis.com/Instance.
|
|
1344
|
+
class BackupGcpResource
|
|
1345
|
+
include ::Google::Protobuf::MessageExts
|
|
1346
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
1347
|
+
end
|
|
1348
|
+
|
|
1349
|
+
# Backup configuration state. Is the resource configured for backup?
|
|
1350
|
+
module BackupConfigState
|
|
1351
|
+
# The possible states of backup configuration.
|
|
1352
|
+
# Status not set.
|
|
1353
|
+
BACKUP_CONFIG_STATE_UNSPECIFIED = 0
|
|
1354
|
+
|
|
1355
|
+
# The data source is actively protected (i.e. there is a
|
|
1356
|
+
# BackupPlanAssociation or Appliance SLA pointing to it)
|
|
1357
|
+
ACTIVE = 1
|
|
1358
|
+
|
|
1359
|
+
# The data source is no longer protected (but may have backups under it)
|
|
1360
|
+
PASSIVE = 2
|
|
1361
|
+
end
|
|
1362
|
+
|
|
1363
|
+
# BackupView contains enum options for Partial and Full view.
|
|
1364
|
+
module BackupView
|
|
1365
|
+
# If the value is not set, the default 'FULL' view is used.
|
|
1366
|
+
BACKUP_VIEW_UNSPECIFIED = 0
|
|
1367
|
+
|
|
1368
|
+
# Includes basic data about the Backup, but not the full contents.
|
|
1369
|
+
BACKUP_VIEW_BASIC = 1
|
|
1370
|
+
|
|
1371
|
+
# Includes all data about the Backup.
|
|
1372
|
+
# This is the default value (for both ListBackups and GetBackup).
|
|
1373
|
+
BACKUP_VIEW_FULL = 2
|
|
1374
|
+
end
|
|
1375
|
+
|
|
1376
|
+
# BackupVaultView contains enum options for Partial and Full view.
|
|
1377
|
+
module BackupVaultView
|
|
1378
|
+
# If the value is not set, the default 'FULL' view is used.
|
|
1379
|
+
BACKUP_VAULT_VIEW_UNSPECIFIED = 0
|
|
1380
|
+
|
|
1381
|
+
# Includes basic data about the Backup Vault, but not the full contents.
|
|
1382
|
+
BACKUP_VAULT_VIEW_BASIC = 1
|
|
1383
|
+
|
|
1384
|
+
# Includes all data about the Backup Vault.
|
|
1385
|
+
# This is the default value (for both ListBackupVaults and GetBackupVault).
|
|
1386
|
+
BACKUP_VAULT_VIEW_FULL = 2
|
|
1387
|
+
end
|
|
1388
|
+
end
|
|
1389
|
+
end
|
|
1390
|
+
end
|
|
1391
|
+
end
|