Package com.google.cloud.filestore.v1

Interface BackupOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Backup, Backup.Builder
    public interface BackupOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Output only. The resource name of the backup, in the format
 `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the backup, in the format
 `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.

      • getDescription

        String getDescription()
         A description of the backup with 2048 characters or less.
 Requests with longer descriptions will be rejected.
        string description = 2;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         A description of the backup with 2048 characters or less.
 Requests with longer descriptions will be rejected.
        string description = 2;
        Returns:
        The bytes for description.

      • getStateValue

        int getStateValue()
         Output only. The backup state.
        .google.cloud.filestore.v1.Backup.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for state.

      • getState

        Backup.State getState()
         Output only. The backup state.
        .google.cloud.filestore.v1.Backup.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. The time when the backup was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the backup was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the backup was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsCount

        int getLabelsCount()
         Resource labels to represent user provided metadata.
        map<string, string> labels = 5;

      • containsLabels

        boolean containsLabels​(String key)
         Resource labels to represent user provided metadata.
        map<string, string> labels = 5;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Resource labels to represent user provided metadata.
        map<string, string> labels = 5;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Resource labels to represent user provided metadata.
        map<string, string> labels = 5;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Resource labels to represent user provided metadata.
        map<string, string> labels = 5;

      • getCapacityGb

        long getCapacityGb()
         Output only. Capacity of the source file share when the backup was created.
        int64 capacity_gb = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The capacityGb.

      • getStorageBytes

        long getStorageBytes()
         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.
        int64 storage_bytes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The storageBytes.

      • getSourceInstance

        String getSourceInstance()
         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.
        string source_instance = 8 [(.google.api.resource_reference) = { ... }
        Returns:
        The sourceInstance.

      • getSourceInstanceBytes

        com.google.protobuf.ByteString getSourceInstanceBytes()
         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.
        string source_instance = 8 [(.google.api.resource_reference) = { ... }
        Returns:
        The bytes for sourceInstance.

      • getSourceFileShare

        String getSourceFileShare()
         Name of the file share in the source Filestore instance that the
 backup is created from.
        string source_file_share = 9;
        Returns:
        The sourceFileShare.

      • getSourceFileShareBytes

        com.google.protobuf.ByteString getSourceFileShareBytes()
         Name of the file share in the source Filestore instance that the
 backup is created from.
        string source_file_share = 9;
        Returns:
        The bytes for sourceFileShare.

      • getSourceInstanceTierValue

        int getSourceInstanceTierValue()
         Output only. The service tier of the source Filestore instance that this
 backup is created from.
        .google.cloud.filestore.v1.Instance.Tier source_instance_tier = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for sourceInstanceTier.

      • getSourceInstanceTier

        Instance.Tier getSourceInstanceTier()
         Output only. The service tier of the source Filestore instance that this
 backup is created from.
        .google.cloud.filestore.v1.Instance.Tier source_instance_tier = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The sourceInstanceTier.

      • getDownloadBytes

        long getDownloadBytes()
         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.
        int64 download_bytes = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The downloadBytes.

      • hasSatisfiesPzs

        boolean hasSatisfiesPzs()
         Output only. Reserved for future use.
        .google.protobuf.BoolValue satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the satisfiesPzs field is set.

      • getSatisfiesPzs

        com.google.protobuf.BoolValue getSatisfiesPzs()
         Output only. Reserved for future use.
        .google.protobuf.BoolValue satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The satisfiesPzs.

      • getSatisfiesPzsOrBuilder

        com.google.protobuf.BoolValueOrBuilder getSatisfiesPzsOrBuilder()
         Output only. Reserved for future use.
        .google.protobuf.BoolValue satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getKmsKey

        String getKmsKey()
         Immutable. KMS key name used for data encryption.
        string kms_key = 13 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The kmsKey.

      • getKmsKeyBytes

        com.google.protobuf.ByteString getKmsKeyBytes()
         Immutable. KMS key name used for data encryption.
        string kms_key = 13 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for kmsKey.