Class Snapshot (1.19.0) 
  
  
  
   
  
    
  
  
    
    
    
    
  Version 1.19.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  Snapshot   extends   GeneratedMessageV3   implements   SnapshotOrBuilder  
   A Filestore snapshot.
 Protobuf type google.cloud.filestore.v1beta1.Snapshot
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  CREATE_TIME_FIELD_NUMBER 
  
    
public   static   final   int   CREATE_TIME_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  DESCRIPTION_FIELD_NUMBER 
  
    
public   static   final   int   DESCRIPTION_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  FILESYSTEM_USED_BYTES_FIELD_NUMBER 
  
    
public   static   final   int   FILESYSTEM_USED_BYTES_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  LABELS_FIELD_NUMBER 
  
    
public   static   final   int   LABELS_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  NAME_FIELD_NUMBER 
  
    
public   static   final   int   NAME_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  STATE_FIELD_NUMBER 
  
    
public   static   final   int   STATE_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  getDefaultInstance() 
  
    
public   static   Snapshot   getDefaultInstance ()  
  
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  newBuilder() 
  
    
public   static   Snapshot . Builder   newBuilder ()  
  
  newBuilder(Snapshot prototype) 
  
    
public   static   Snapshot . Builder   newBuilder ( Snapshot   prototype )  
  
    
      
        Parameter  
      
        Name Description  
      
        prototypeSnapshot  
     
  
  
  
    
public   static   Snapshot   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   Snapshot   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(byte[] data) 
  
    
public   static   Snapshot   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Snapshot   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteString data) 
  
    
public   static   Snapshot   parseFrom ( ByteString   data )  
  
  
  
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Snapshot   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   Snapshot   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   Snapshot   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   Snapshot   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   Snapshot   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteBuffer data) 
  
    
public   static   Snapshot   parseFrom ( ByteBuffer   data )  
  
  
  
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Snapshot   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parser() 
  
    
public   static   Parser<Snapshot>   parser ()  
  
  Methods
   
  containsLabels(String key) 
  
    
public   boolean   containsLabels ( String   key )  
   Resource labels to represent user provided metadata.
 map<string, string> labels = 5;
    
      
        Parameter  
      
        Name Description  
      
        keyString  
     
  
  
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  getCreateTime() 
  
    
public   Timestamp   getCreateTime ()  
   Output only. The time when the snapshot was created.
 .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
    
      
        Returns  
      
        Type Description  
      
        Timestamp The createTime.
 
     
  
  getCreateTimeOrBuilder() 
  
    
public   TimestampOrBuilder   getCreateTimeOrBuilder ()  
   Output only. The time when the snapshot was created.
 .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
getDefaultInstanceForType() 
  
    
public   Snapshot   getDefaultInstanceForType ()  
  
  getDescription() 
  
    
public   String   getDescription ()  
   A description of the snapshot with 2048 characters or less.
 Requests with longer descriptions will be rejected.
 string description = 2;
    
      
        Returns  
      
        Type Description  
      
        String The description.
 
     
  
  getDescriptionBytes() 
  
    
public   ByteString   getDescriptionBytes ()  
   A description of the snapshot with 2048 characters or less.
 Requests with longer descriptions will be rejected.
 string description = 2;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for description.
 
     
  
  getFilesystemUsedBytes() 
  
    
public   long   getFilesystemUsedBytes ()  
   Output only. The amount of bytes needed to allocate a full copy of the snapshot content
 int64 filesystem_used_bytes = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
    
      
        Returns  
      
        Type Description  
      
        long The filesystemUsedBytes.
 
     
  
  getLabels() 
  
    
public   Map<String , String >  getLabels ()  
  
  
  getLabelsCount() 
  
    
public   int   getLabelsCount ()  
   Resource labels to represent user provided metadata.
 map<string, string> labels = 5;
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  getLabelsMap() 
  
    
public   Map<String , String >  getLabelsMap ()  
   Resource labels to represent user provided metadata.
 map<string, string> labels = 5;
getLabelsOrDefault(String key, String defaultValue) 
  
    
public   String   getLabelsOrDefault ( String   key ,   String   defaultValue )  
   Resource labels to represent user provided metadata.
 map<string, string> labels = 5;
    
      
        Returns  
      
        Type Description  
      
        String  
     
  
  getLabelsOrThrow(String key) 
  
    
public   String   getLabelsOrThrow ( String   key )  
   Resource labels to represent user provided metadata.
 map<string, string> labels = 5;
    
      
        Parameter  
      
        Name Description  
      
        keyString  
     
  
  
    
      
        Returns  
      
        Type Description  
      
        String  
     
  
  getName() 
  
   Output only. The resource name of the snapshot, in the format
 projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.
 string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
    
      
        Returns  
      
        Type Description  
      
        String The name.
 
     
  
  getNameBytes() 
  
    
public   ByteString   getNameBytes ()  
   Output only. The resource name of the snapshot, in the format
 projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.
 string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for name.
 
     
  
  getParserForType() 
  
    
public   Parser<Snapshot>   getParserForType ()  
  
  Overrides 
  
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  getState() 
  
    
public   Snapshot . State   getState ()  
   Output only. The snapshot state.
 
 .google.cloud.filestore.v1beta1.Snapshot.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
getStateValue() 
  
    
public   int   getStateValue ()  
   Output only. The snapshot state.
 
 .google.cloud.filestore.v1beta1.Snapshot.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
    
      
        Returns  
      
        Type Description  
      
        int The enum numeric value on the wire for state.
 
     
  
  getUnknownFields() 
  
    
public   final   UnknownFieldSet   getUnknownFields ()  
  
  Overrides 
  
  hasCreateTime() 
  
    
public   boolean   hasCreateTime ()  
   Output only. The time when the snapshot was created.
 .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the createTime field is set.
 
     
  
  hashCode() 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  internalGetMapField(int number) 
  
    
protected   MapField   internalGetMapField ( int   number )  
  
    
      
        Parameter  
      
        Name Description  
      
        numberint  
     
  
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  newBuilderForType() 
  
    
public   Snapshot . Builder   newBuilderForType ()  
  
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   Snapshot . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  toBuilder() 
  
    
public   Snapshot . Builder   toBuilder ()  
  
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-29 UTC.
 
 
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]