Class: Google::Cloud::Filestore::V1::Snapshot

Inherits:

Object

• Object
• Google::Cloud::Filestore::V1::Snapshot

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb

Overview

A Filestore snapshot.

Defined Under Namespace

Modules: State Classes: LabelsEntry, TagsEntry

Instance Attribute Summary

• #create_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #description ⇒ ::String

  A description of the snapshot with 2048 characters or less.

• #filesystem_used_bytes ⇒ ::Integer readonly

  Output only.

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

  Resource labels to represent user provided metadata.

• #name ⇒ ::String readonly

  Output only.

• #state ⇒ ::Google::Cloud::Filestore::V1::Snapshot::State readonly

  Output only.

• #tags ⇒ ::Google::Protobuf::Map{::String => ::String}

  Optional.

Instance Attribute Details

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

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

Returns:

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

  Output only. The time when the snapshot was created.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 731

class Snapshot
  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

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

  # The snapshot state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Snapshot is being created.
    CREATING = 1

    # Snapshot is available for use.
    READY = 2

    # Snapshot is being deleted.
    DELETING = 3
  end
end

#description ⇒ ::String

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

Returns:

• (::String) —

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

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 731

class Snapshot
  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

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

  # The snapshot state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Snapshot is being created.
    CREATING = 1

    # Snapshot is available for use.
    READY = 2

    # Snapshot is being deleted.
    DELETING = 3
  end
end

#filesystem_used_bytes ⇒ ::Integer (readonly)

Returns Output only. The amount of bytes needed to allocate a full copy of the snapshot content.

Returns:

• (::Integer) —

  Output only. The amount of bytes needed to allocate a full copy of the snapshot content

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 731

class Snapshot
  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

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

  # The snapshot state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Snapshot is being created.
    CREATING = 1

    # Snapshot is available for use.
    READY = 2

    # Snapshot is being deleted.
    DELETING = 3
  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.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 731

class Snapshot
  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

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

  # The snapshot state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Snapshot is being created.
    CREATING = 1

    # Snapshot is available for use.
    READY = 2

    # Snapshot is being deleted.
    DELETING = 3
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.

Returns:

• (::String) —

  Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 731

class Snapshot
  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

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

  # The snapshot state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Snapshot is being created.
    CREATING = 1

    # Snapshot is available for use.
    READY = 2

    # Snapshot is being deleted.
    DELETING = 3
  end
end

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

Returns Output only. The snapshot state.

Returns:

• (::Google::Cloud::Filestore::V1::Snapshot::State) —

  Output only. The snapshot state.

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 731

class Snapshot
  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

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

  # The snapshot state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Snapshot is being created.
    CREATING = 1

    # Snapshot is available for use.
    READY = 2

    # Snapshot is being deleted.
    DELETING = 3
  end
end

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

Returns Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information:

• Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key
• Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value.

Returns:

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

  Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information:

  • Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key
  • Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value

# File 'proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb', line 731

class Snapshot
  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

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

  # The snapshot state.
  module State
    # State not set.
    STATE_UNSPECIFIED = 0

    # Snapshot is being created.
    CREATING = 1

    # Snapshot is available for use.
    READY = 2

    # Snapshot is being deleted.
    DELETING = 3
  end
end