Class: Google::Cloud::Filestore::V1::Backup

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

Overview

A Filestore backup.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_gb ⇒ ::Integer (readonly)

Returns Output only. Capacity of the source file share when the backup was created.

Returns:

  • (::Integer) —

    Output only. Capacity of the source file share when the backup was created.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end

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

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

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  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.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end

#download_bytes ⇒ ::Integer (readonly)

Returns Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.

Returns:

  • (::Integer) —

    Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end

#kms_key ⇒ ::String

Returns Immutable. KMS key name used for data encryption.

Returns:

  • (::String) —

    Immutable. KMS key name used for data encryption.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  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.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

Returns:

  • (::String) —

    Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end

#satisfies_pzs ⇒ ::Google::Protobuf::BoolValue (readonly)

Returns Output only. Reserved for future use.

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end

#source_file_share ⇒ ::String

Returns Name of the file share in the source Filestore instance that the backup is created from.

Returns:

  • (::String) —

    Name of the file share in the source Filestore instance that the backup is created from.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end

#source_instance ⇒ ::String

Returns The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.

Returns:

  • (::String) —

    The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end

#source_instance_tier ⇒ ::Google::Cloud::Filestore::V1::Instance::Tier (readonly)

Returns Output only. The service tier of the source Filestore instance that this backup is created from.

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end

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

Returns Output only. The backup state.

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end

#storage_bytes ⇒ ::Integer (readonly)

Returns Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.

Returns:

  • (::Integer) —

    Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 666

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 state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Backup is being created.
    CREATING = 1

    # Backup has been taken and the operation is being finalized. At this
    # point, changes to the file share will not be reflected in the backup.
    FINALIZING = 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 instances or
    # restoring existing instances.
    INVALID = 5
  end
end