Package com.google.cloud.filestore.v1

Class Backup

  • All Implemented Interfaces:
    BackupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Backup
extends com.google.protobuf.GeneratedMessageV3
implements BackupOrBuilder
     A Filestore backup.
    Protobuf type google.cloud.filestore.v1.Backup
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public 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];
        Specified by:
        getName in interface BackupOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface BackupOrBuilder
        Returns:
        The bytes for name.

      • getDescription

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

      • getDescriptionBytes

        public 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;
        Specified by:
        getDescriptionBytes in interface BackupOrBuilder
        Returns:
        The bytes for description.

      • getStateValue

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

      • getState

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

      • hasCreateTime

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

      • getCreateTime

        public 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];
        Specified by:
        getCreateTime in interface BackupOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public 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];
        Specified by:
        getCreateTimeOrBuilder in interface BackupOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: BackupOrBuilder
         Resource labels to represent user provided metadata.
        map<string, string> labels = 5;
        Specified by:
        getLabelsCount in interface BackupOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Resource labels to represent user provided metadata.
        map<string, string> labels = 5;
        Specified by:
        containsLabels in interface BackupOrBuilder

      • getCapacityGb

        public 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];
        Specified by:
        getCapacityGb in interface BackupOrBuilder
        Returns:
        The capacityGb.

      • getStorageBytes

        public 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];
        Specified by:
        getStorageBytes in interface BackupOrBuilder
        Returns:
        The storageBytes.

      • getSourceInstance

        public 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) = { ... }
        Specified by:
        getSourceInstance in interface BackupOrBuilder
        Returns:
        The sourceInstance.

      • getSourceInstanceBytes

        public 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) = { ... }
        Specified by:
        getSourceInstanceBytes in interface BackupOrBuilder
        Returns:
        The bytes for sourceInstance.

      • getSourceFileShare

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

      • getSourceFileShareBytes

        public 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;
        Specified by:
        getSourceFileShareBytes in interface BackupOrBuilder
        Returns:
        The bytes for sourceFileShare.

      • getSourceInstanceTierValue

        public 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];
        Specified by:
        getSourceInstanceTierValue in interface BackupOrBuilder
        Returns:
        The enum numeric value on the wire for sourceInstanceTier.

      • getSourceInstanceTier

        public 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];
        Specified by:
        getSourceInstanceTier in interface BackupOrBuilder
        Returns:
        The sourceInstanceTier.

      • getDownloadBytes

        public 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];
        Specified by:
        getDownloadBytes in interface BackupOrBuilder
        Returns:
        The downloadBytes.

      • hasSatisfiesPzs

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

      • getSatisfiesPzs

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

      • getSatisfiesPzsOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getSatisfiesPzsOrBuilder()
         Output only. Reserved for future use.
        .google.protobuf.BoolValue satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSatisfiesPzsOrBuilder in interface BackupOrBuilder

      • getKmsKey

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

      • getKmsKeyBytes

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Backup parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Backup.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Backup.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Backup.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Backup getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Backup> parser()

      • getParserForType

        public com.google.protobuf.Parser<Backup> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Backup getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder