Class: Google::Cloud::NetApp::V1::Backup

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

Overview

A NetApp Backup.

Defined Under Namespace

Modules: State, Type Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#backup_type ⇒ ::Google::Cloud::NetApp::V1::Backup::Type (readonly)

Returns Output only. Type of backup, manually created or created by a backup policy.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/netapp/v1/backup.rb', line 67

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

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

  # The Backup States
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created. While in this state, the snapshot for the backup
    # point-in-time may not have been created yet, and so the point-in-time may
    # not have been fixed.
    CREATING = 1

    # Backup is being uploaded. While in this state, none of the writes to the
    # volume will be included in the backup.
    UPLOADING = 2

    # Backup is available for use.
    READY = 3

    # Backup is being deleted.
    DELETING = 4

    # Backup is not valid and cannot be used for creating new volumes or
    # restoring existing volumes.
    ERROR = 5

    # Backup is being updated.
    UPDATING = 6
  end

  # Backup types.
  module Type
    # Unspecified backup type.
    TYPE_UNSPECIFIED = 0

    # Manual backup type.
    MANUAL = 1

    # Scheduled backup type.
    SCHEDULED = 2
  end
end

#chain_storage_bytes ⇒ ::Integer (readonly)

Returns Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).

Returns:

  • (::Integer) —

    Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/netapp/v1/backup.rb', line 67

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

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

  # The Backup States
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created. While in this state, the snapshot for the backup
    # point-in-time may not have been created yet, and so the point-in-time may
    # not have been fixed.
    CREATING = 1

    # Backup is being uploaded. While in this state, none of the writes to the
    # volume will be included in the backup.
    UPLOADING = 2

    # Backup is available for use.
    READY = 3

    # Backup is being deleted.
    DELETING = 4

    # Backup is not valid and cannot be used for creating new volumes or
    # restoring existing volumes.
    ERROR = 5

    # Backup is being updated.
    UPDATING = 6
  end

  # Backup types.
  module Type
    # Unspecified backup type.
    TYPE_UNSPECIFIED = 0

    # Manual backup type.
    MANUAL = 1

    # Scheduled backup type.
    SCHEDULED = 2
  end
end

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

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

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/netapp/v1/backup.rb', line 67

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

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

  # The Backup States
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created. While in this state, the snapshot for the backup
    # point-in-time may not have been created yet, and so the point-in-time may
    # not have been fixed.
    CREATING = 1

    # Backup is being uploaded. While in this state, none of the writes to the
    # volume will be included in the backup.
    UPLOADING = 2

    # Backup is available for use.
    READY = 3

    # Backup is being deleted.
    DELETING = 4

    # Backup is not valid and cannot be used for creating new volumes or
    # restoring existing volumes.
    ERROR = 5

    # Backup is being updated.
    UPDATING = 6
  end

  # Backup types.
  module Type
    # Unspecified backup type.
    TYPE_UNSPECIFIED = 0

    # Manual backup type.
    MANUAL = 1

    # Scheduled backup type.
    SCHEDULED = 2
  end
end

#description ⇒ ::String

Returns A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.

Returns:

  • (::String) —

    A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/netapp/v1/backup.rb', line 67

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

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

  # The Backup States
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created. While in this state, the snapshot for the backup
    # point-in-time may not have been created yet, and so the point-in-time may
    # not have been fixed.
    CREATING = 1

    # Backup is being uploaded. While in this state, none of the writes to the
    # volume will be included in the backup.
    UPLOADING = 2

    # Backup is available for use.
    READY = 3

    # Backup is being deleted.
    DELETING = 4

    # Backup is not valid and cannot be used for creating new volumes or
    # restoring existing volumes.
    ERROR = 5

    # Backup is being updated.
    UPDATING = 6
  end

  # Backup types.
  module Type
    # Unspecified backup type.
    TYPE_UNSPECIFIED = 0

    # Manual backup type.
    MANUAL = 1

    # Scheduled backup type.
    SCHEDULED = 2
  end
end

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

Returns Resource labels to represent user provided metadata.

Returns:

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

    Resource labels to represent user provided metadata.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/netapp/v1/backup.rb', line 67

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

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

  # The Backup States
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created. While in this state, the snapshot for the backup
    # point-in-time may not have been created yet, and so the point-in-time may
    # not have been fixed.
    CREATING = 1

    # Backup is being uploaded. While in this state, none of the writes to the
    # volume will be included in the backup.
    UPLOADING = 2

    # Backup is available for use.
    READY = 3

    # Backup is being deleted.
    DELETING = 4

    # Backup is not valid and cannot be used for creating new volumes or
    # restoring existing volumes.
    ERROR = 5

    # Backup is being updated.
    UPDATING = 6
  end

  # Backup types.
  module Type
    # Unspecified backup type.
    TYPE_UNSPECIFIED = 0

    # Manual backup type.
    MANUAL = 1

    # Scheduled backup type.
    SCHEDULED = 2
  end
end

#name ⇒ ::String

Returns Identifier. The resource name of the backup. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}.

Returns:

  • (::String) —

    Identifier. The resource name of the backup. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/netapp/v1/backup.rb', line 67

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

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

  # The Backup States
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created. While in this state, the snapshot for the backup
    # point-in-time may not have been created yet, and so the point-in-time may
    # not have been fixed.
    CREATING = 1

    # Backup is being uploaded. While in this state, none of the writes to the
    # volume will be included in the backup.
    UPLOADING = 2

    # Backup is available for use.
    READY = 3

    # Backup is being deleted.
    DELETING = 4

    # Backup is not valid and cannot be used for creating new volumes or
    # restoring existing volumes.
    ERROR = 5

    # Backup is being updated.
    UPDATING = 6
  end

  # Backup types.
  module Type
    # Unspecified backup type.
    TYPE_UNSPECIFIED = 0

    # Manual backup type.
    MANUAL = 1

    # Scheduled backup type.
    SCHEDULED = 2
  end
end

#source_snapshot ⇒ ::String

Returns If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}.

Returns:

  • (::String) —

    If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/netapp/v1/backup.rb', line 67

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

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

  # The Backup States
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created. While in this state, the snapshot for the backup
    # point-in-time may not have been created yet, and so the point-in-time may
    # not have been fixed.
    CREATING = 1

    # Backup is being uploaded. While in this state, none of the writes to the
    # volume will be included in the backup.
    UPLOADING = 2

    # Backup is available for use.
    READY = 3

    # Backup is being deleted.
    DELETING = 4

    # Backup is not valid and cannot be used for creating new volumes or
    # restoring existing volumes.
    ERROR = 5

    # Backup is being updated.
    UPDATING = 6
  end

  # Backup types.
  module Type
    # Unspecified backup type.
    TYPE_UNSPECIFIED = 0

    # Manual backup type.
    MANUAL = 1

    # Scheduled backup type.
    SCHEDULED = 2
  end
end

#source_volume ⇒ ::String

Returns Volume full name of this backup belongs to. Format: projects/{projects_id}/locations/{location}/volumes/{volume_id}.

Returns:

  • (::String) —

    Volume full name of this backup belongs to. Format: projects/{projects_id}/locations/{location}/volumes/{volume_id}



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/netapp/v1/backup.rb', line 67

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

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

  # The Backup States
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created. While in this state, the snapshot for the backup
    # point-in-time may not have been created yet, and so the point-in-time may
    # not have been fixed.
    CREATING = 1

    # Backup is being uploaded. While in this state, none of the writes to the
    # volume will be included in the backup.
    UPLOADING = 2

    # Backup is available for use.
    READY = 3

    # Backup is being deleted.
    DELETING = 4

    # Backup is not valid and cannot be used for creating new volumes or
    # restoring existing volumes.
    ERROR = 5

    # Backup is being updated.
    UPDATING = 6
  end

  # Backup types.
  module Type
    # Unspecified backup type.
    TYPE_UNSPECIFIED = 0

    # Manual backup type.
    MANUAL = 1

    # Scheduled backup type.
    SCHEDULED = 2
  end
end

#state ⇒ ::Google::Cloud::NetApp::V1::Backup::State (readonly)

Returns Output only. The backup state.

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/netapp/v1/backup.rb', line 67

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

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

  # The Backup States
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created. While in this state, the snapshot for the backup
    # point-in-time may not have been created yet, and so the point-in-time may
    # not have been fixed.
    CREATING = 1

    # Backup is being uploaded. While in this state, none of the writes to the
    # volume will be included in the backup.
    UPLOADING = 2

    # Backup is available for use.
    READY = 3

    # Backup is being deleted.
    DELETING = 4

    # Backup is not valid and cannot be used for creating new volumes or
    # restoring existing volumes.
    ERROR = 5

    # Backup is being updated.
    UPDATING = 6
  end

  # Backup types.
  module Type
    # Unspecified backup type.
    TYPE_UNSPECIFIED = 0

    # Manual backup type.
    MANUAL = 1

    # Scheduled backup type.
    SCHEDULED = 2
  end
end

#volume_usage_bytes ⇒ ::Integer (readonly)

Returns Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.

Returns:

  • (::Integer) —

    Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/netapp/v1/backup.rb', line 67

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

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

  # The Backup States
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created. While in this state, the snapshot for the backup
    # point-in-time may not have been created yet, and so the point-in-time may
    # not have been fixed.
    CREATING = 1

    # Backup is being uploaded. While in this state, none of the writes to the
    # volume will be included in the backup.
    UPLOADING = 2

    # Backup is available for use.
    READY = 3

    # Backup is being deleted.
    DELETING = 4

    # Backup is not valid and cannot be used for creating new volumes or
    # restoring existing volumes.
    ERROR = 5

    # Backup is being updated.
    UPDATING = 6
  end

  # Backup types.
  module Type
    # Unspecified backup type.
    TYPE_UNSPECIFIED = 0

    # Manual backup type.
    MANUAL = 1

    # Scheduled backup type.
    SCHEDULED = 2
  end
end