Class: Google::Cloud::BackupDR::V1::BackupVault

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/backupdr/v1/backupvault.rb

Overview

Message describing a BackupVault object.

Defined Under Namespace

Modules: AccessRestriction, BackupRetentionInheritance, State Classes: AnnotationsEntry, EncryptionConfig, LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#access_restriction ⇒ ::Google::Cloud::BackupDR::V1::BackupVault::AccessRestriction

Returns Optional. Note: This field is added for future use case and will not be supported in the current release.

Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#backup_count ⇒ ::Integer (readonly)

Returns Output only. The number of backups in this backup vault.

Returns:

  • (::Integer) —

    Output only. The number of backups in this backup vault.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#backup_minimum_enforced_retention_duration ⇒ ::Google::Protobuf::Duration

Returns Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.

Returns:

  • (::Google::Protobuf::Duration) —

    Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#backup_retention_inheritance ⇒ ::Google::Cloud::BackupDR::V1::BackupVault::BackupRetentionInheritance

Returns Optional. Setting for how a backup's enforced retention end time is inherited.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the instance was created.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#deletable ⇒ ::Boolean (readonly)

Returns Output only. Set to true when there are no backups nested under this resource.

Returns:

  • (::Boolean) —

    Output only. Set to true when there are no backups nested under this resource.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#description ⇒ ::String

Returns Optional. The description of the BackupVault instance (2048 characters or less).

Returns:

  • (::String) —

    Optional. The description of the BackupVault instance (2048 characters or less).



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#effective_time ⇒ ::Google::Protobuf::Timestamp

Returns Optional. Time after which the BackupVault resource is locked.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#encryption_config ⇒ ::Google::Cloud::BackupDR::V1::BackupVault::EncryptionConfig

Returns Optional. The encryption config of the backup vault.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#etag ⇒ ::String

Returns Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.

Returns:

  • (::String) —

    Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. Resource labels to represent user provided metadata. No labels currently defined:.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. Resource labels to represent user provided metadata. No labels currently defined:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Identifier. Name of the backup vault to create. It must have the format"projects/{project}/locations/{location}/backupVaults/{backupvault}". {backupvault} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.

Returns:

  • (::String) —

    Output only. Identifier. Name of the backup vault to create. It must have the format"projects/{project}/locations/{location}/backupVaults/{backupvault}". {backupvault} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#service_account ⇒ ::String (readonly)

Returns Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.

Returns:

  • (::String) —

    Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#state ⇒ ::Google::Cloud::BackupDR::V1::BackupVault::State (readonly)

Returns Output only. The BackupVault resource instance state.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#total_stored_bytes ⇒ ::Integer (readonly)

Returns Output only. Total size of the storage used by all backup resources.

Returns:

  • (::Integer) —

    Output only. Total size of the storage used by all backup resources.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. Immutable after resource creation until resource deletion.

Returns:

  • (::String) —

    Output only. Immutable after resource creation until resource deletion.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the instance was updated.

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'proto_docs/google/cloud/backupdr/v1/backupvault.rb', line 96

class BackupVault
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing the EncryptionConfig of backup vault.
  # This determines how data within the vault is encrypted at rest.
  # @!attribute [rw] kms_key_name
  #   @return [::String]
  #     Optional. The Cloud KMS key name to encrypt backups in this backup vault.
  #     Must be in the same region as the vault. Some workload backups like
  #     compute disk backups may use their inherited source key instead. Format:
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{ring}/cryptoKeys/\\{key}
  class EncryptionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # How a backup's enforced retention end time is inherited.
  module BackupRetentionInheritance
    # Inheritance behavior not set. This will default to
    # `INHERIT_VAULT_RETENTION`.
    BACKUP_RETENTION_INHERITANCE_UNSPECIFIED = 0

    # The enforced retention end time of a backup will be inherited from the
    # backup vault's `backup_minimum_enforced_retention_duration` field.
    #
    # This is the default behavior.
    INHERIT_VAULT_RETENTION = 1

    # The enforced retention end time of a backup will always match the expire
    # time of the backup.
    #
    # If this is set, the backup's enforced retention end time will be set to
    # match the expire time during creation of the backup. When updating, the
    # ERET and expire time must be updated together and have the same value.
    # Invalid update requests will be rejected by the server.
    MATCH_BACKUP_EXPIRE_TIME = 2
  end

  # Holds the state of the backup vault resource.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # The backup vault is being created.
    CREATING = 1

    # The backup vault has been created and is fully usable.
    ACTIVE = 2

    # The backup vault is being deleted.
    DELETING = 3

    # The backup vault is experiencing an issue and might be unusable.
    ERROR = 4

    # The backup vault is being updated.
    UPDATING = 5
  end

  # Holds the access restriction for the backup vault.
  module AccessRestriction
    # Access restriction not set. If user does not provide any value or pass
    # this value, it will be changed to WITHIN_ORGANIZATION.
    ACCESS_RESTRICTION_UNSPECIFIED = 0

    # Access to or from resources outside your current project will be denied.
    WITHIN_PROJECT = 1

    # Access to or from resources outside your current organization will be
    # denied.
    WITHIN_ORGANIZATION = 2

    # No access restriction.
    UNRESTRICTED = 3

    # Access to or from resources outside your current organization will be
    # denied except for backup appliance.
    WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA = 4
  end
end