Class: Google::Cloud::BareMetalSolution::V2::Volume

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/baremetalsolution/v2/volume.rb

Overview

A storage volume.

Defined Under Namespace

Modules: Protocol, SnapshotAutoDeleteBehavior, State, StorageType, WorkloadProfile Classes: LabelsEntry, SnapshotReservationDetail

Instance Attribute Summary collapse

Instance Attribute Details

#attached ⇒ ::Boolean (readonly)

Returns Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of instances field. It is filled in List responses as well.

Returns:

  • (::Boolean) —

    Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of instances field. It is filled in List responses as well.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#auto_grown_size_gib ⇒ ::Integer

Returns The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0.

Returns:

  • (::Integer) —

    The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#boot_volume ⇒ ::Boolean (readonly)

Returns Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.

Returns:

  • (::Boolean) —

    Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#current_size_gib ⇒ ::Integer

Returns The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink.

Returns:

  • (::Integer) —

    The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#emergency_size_gib ⇒ ::Integer

Returns Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.

Returns:

  • (::Integer) —

    Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

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

Returns Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#id ⇒ ::String

Returns An identifier for the Volume, generated by the backend.

Returns:

  • (::String) —

    An identifier for the Volume, generated by the backend.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#instances ⇒ ::Array<::String> (readonly)

Returns Output only. Instances this Volume is attached to. This field is set only in Get requests.

Returns:

  • (::Array<::String>) —

    Output only. Instances this Volume is attached to. This field is set only in Get requests.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

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

Returns Labels as key value pairs.

Returns:

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

    Labels as key value pairs.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#max_size_gib ⇒ ::Integer

Returns Maximum size volume can be expanded to in case of evergency, in GiB.

Returns:

  • (::Integer) —

    Maximum size volume can be expanded to in case of evergency, in GiB.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of this Volume. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/volumes/{volume}.

Returns:



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#notes ⇒ ::String

Returns Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.

Returns:

  • (::String) —

    Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#originally_requested_size_gib ⇒ ::Integer

Returns Originally requested size, in GiB.

Returns:

  • (::Integer) —

    Originally requested size, in GiB.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#performance_tier ⇒ ::Google::Cloud::BareMetalSolution::V2::VolumePerformanceTier

Returns Immutable. Performance tier of the Volume. Default is SHARED.

Returns:



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#pod ⇒ ::String

Returns Immutable. Pod name.

Returns:

  • (::String) —

    Immutable. Pod name.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#protocol ⇒ ::Google::Cloud::BareMetalSolution::V2::Volume::Protocol (readonly)

Returns Output only. Storage protocol for the Volume.

Returns:



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#remaining_space_gib ⇒ ::Integer

Returns The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.

Returns:

  • (::Integer) —

    The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#requested_size_gib ⇒ ::Integer

Returns The requested size of this storage volume, in GiB.

Returns:

  • (::Integer) —

    The requested size of this storage volume, in GiB.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#snapshot_auto_delete_behavior ⇒ ::Google::Cloud::BareMetalSolution::V2::Volume::SnapshotAutoDeleteBehavior

Returns The behavior to use when snapshot reserved space is full.

Returns:



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#snapshot_enabled ⇒ ::Boolean

Returns Whether snapshots are enabled.

Returns:

  • (::Boolean) —

    Whether snapshots are enabled.



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#snapshot_reservation_detail ⇒ ::Google::Cloud::BareMetalSolution::V2::Volume::SnapshotReservationDetail

Returns Details about snapshot space reservation and usage on the storage volume.

Returns:



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#state ⇒ ::Google::Cloud::BareMetalSolution::V2::Volume::State

Returns The state of this storage volume.

Returns:



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#storage_type ⇒ ::Google::Cloud::BareMetalSolution::V2::Volume::StorageType

Returns The storage type for this volume.

Returns:



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end

#workload_profile ⇒ ::Google::Cloud::BareMetalSolution::V2::Volume::WorkloadProfile

Returns The workload profile for the volume.

Returns:



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'proto_docs/google/cloud/baremetalsolution/v2/volume.rb', line 113

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

  # Details about snapshot space reservation and usage on the storage volume.
  # @!attribute [rw] reserved_space_gib
  #   @return [::Integer]
  #     The space on this storage volume reserved for snapshots, shown in GiB.
  # @!attribute [rw] reserved_space_used_percent
  #   @return [::Integer]
  #     The percent of snapshot space on this storage volume actually being used
  #     by the snapshot copies. This value might be higher than 100% if the
  #     snapshot copies have overflowed into the data portion of the storage
  #     volume.
  # @!attribute [rw] reserved_space_remaining_gib
  #   @return [::Integer]
  #     The amount, in GiB, of available space in this storage volume's reserved
  #     snapshot space.
  # @!attribute [rw] reserved_space_percent
  #   @return [::Integer]
  #     Percent of the total Volume size reserved for snapshot copies.
  #     Enabling snapshots requires reserving 20% or more of
  #     the storage volume space for snapshots. Maximum reserved space for
  #     snapshots is 40%.
  #     Setting this field will effectively set snapshot_enabled to true.
  class SnapshotReservationDetail
    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

  # The storage type for a volume.
  module StorageType
    # The storage type for this volume is unknown.
    STORAGE_TYPE_UNSPECIFIED = 0

    # The storage type for this volume is SSD.
    SSD = 1

    # This storage type for this volume is HDD.
    HDD = 2
  end

  # The possible states for a storage volume.
  module State
    # The storage volume is in an unknown state.
    STATE_UNSPECIFIED = 0

    # The storage volume is being created.
    CREATING = 1

    # The storage volume is ready for use.
    READY = 2

    # The storage volume has been requested to be deleted.
    DELETING = 3

    # The storage volume is being updated.
    UPDATING = 4

    # The storage volume is in cool off state. It will be deleted after
    # `expire_time`.
    COOL_OFF = 5
  end

  # The kinds of auto delete behavior to use when snapshot reserved space is
  # full.
  module SnapshotAutoDeleteBehavior
    # The unspecified behavior.
    SNAPSHOT_AUTO_DELETE_BEHAVIOR_UNSPECIFIED = 0

    # Don't delete any snapshots. This disables new snapshot creation, as
    # long as the snapshot reserved space is full.
    DISABLED = 1

    # Delete the oldest snapshots first.
    OLDEST_FIRST = 2

    # Delete the newest snapshots first.
    NEWEST_FIRST = 3
  end

  # Storage protocol.
  module Protocol
    # Value is not specified.
    PROTOCOL_UNSPECIFIED = 0

    # Fibre Channel protocol.
    FIBRE_CHANNEL = 1

    # NFS protocol means Volume is a NFS Share volume.
    # Such volumes cannot be manipulated via Volumes API.
    NFS = 2
  end

  # The possible values for a workload profile.
  module WorkloadProfile
    # The workload profile is in an unknown state.
    WORKLOAD_PROFILE_UNSPECIFIED = 0

    # The workload profile is generic.
    GENERIC = 1

    # The workload profile is hana.
    HANA = 2
  end
end