Class StorageFormat (1.71.0) 
  
  
  
   
  
    
  
  
    
    
    
    
  Version 1.71.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  StorageFormat   extends   GeneratedMessageV3   implements   StorageFormatOrBuilder  
   Describes the format of the data within its storage location.
 Protobuf type google.cloud.dataplex.v1.StorageFormat
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  
  
    
public   static   final   int   COMPRESSION_FORMAT_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   CSV_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   FORMAT_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   ICEBERG_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   JSON_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   MIME_TYPE_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  
    
public   static   StorageFormat   getDefaultInstance ()  
  
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  
    
public   static   StorageFormat . Builder   newBuilder ()  
  
  
    
public   static   StorageFormat . Builder   newBuilder ( StorageFormat   prototype )  
  
  
  
    
public   static   StorageFormat   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   StorageFormat   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   StorageFormat   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  
    
public   static   StorageFormat   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   StorageFormat   parseFrom ( ByteString   data )  
  
  
  
  
    
public   static   StorageFormat   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   StorageFormat   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   StorageFormat   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   StorageFormat   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   StorageFormat   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   StorageFormat   parseFrom ( ByteBuffer   data )  
  
  
  
  
    
public   static   StorageFormat   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   Parser<StorageFormat>   parser ()  
  
  Methods
   
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  
    
public   StorageFormat . CompressionFormat   getCompressionFormat ()  
   Optional. The compression type associated with the stored data.
 If unspecified, the data is uncompressed.
 
 .google.cloud.dataplex.v1.StorageFormat.CompressionFormat compression_format = 2 [(.google.api.field_behavior) = OPTIONAL];
 
    
public   int   getCompressionFormatValue ()  
   Optional. The compression type associated with the stored data.
 If unspecified, the data is uncompressed.
 
 .google.cloud.dataplex.v1.StorageFormat.CompressionFormat compression_format = 2 [(.google.api.field_behavior) = OPTIONAL];
 
    
      
        Returns  
      
        Type Description  
      
        int The enum numeric value on the wire for compressionFormat.
 
     
  
  
    
public   StorageFormat . CsvOptions   getCsv ()  
   Optional. Additional information about CSV formatted data.
 
 .google.cloud.dataplex.v1.StorageFormat.CsvOptions csv = 10 [(.google.api.field_behavior) = OPTIONAL];
 
    
public   StorageFormat . CsvOptionsOrBuilder   getCsvOrBuilder ()  
   Optional. Additional information about CSV formatted data.
 
 .google.cloud.dataplex.v1.StorageFormat.CsvOptions csv = 10 [(.google.api.field_behavior) = OPTIONAL];
 
    
public   StorageFormat   getDefaultInstanceForType ()  
  
  
    
public   StorageFormat . Format   getFormat ()  
   Output only. The data format associated with the stored data, which
 represents content type values. The value is inferred from mime type.
 
 .google.cloud.dataplex.v1.StorageFormat.Format format = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
    
public   int   getFormatValue ()  
   Output only. The data format associated with the stored data, which
 represents content type values. The value is inferred from mime type.
 
 .google.cloud.dataplex.v1.StorageFormat.Format format = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
    
      
        Returns  
      
        Type Description  
      
        int The enum numeric value on the wire for format.
 
     
  
  
    
public   StorageFormat . IcebergOptions   getIceberg ()  
   Optional. Additional information about iceberg tables.
 
 .google.cloud.dataplex.v1.StorageFormat.IcebergOptions iceberg = 12 [(.google.api.field_behavior) = OPTIONAL];
 
    
public   StorageFormat . IcebergOptionsOrBuilder   getIcebergOrBuilder ()  
   Optional. Additional information about iceberg tables.
 
 .google.cloud.dataplex.v1.StorageFormat.IcebergOptions iceberg = 12 [(.google.api.field_behavior) = OPTIONAL];
 
    
public   StorageFormat . JsonOptions   getJson ()  
   Optional. Additional information about CSV formatted data.
 
 .google.cloud.dataplex.v1.StorageFormat.JsonOptions json = 11 [(.google.api.field_behavior) = OPTIONAL];
 
    
public   StorageFormat . JsonOptionsOrBuilder   getJsonOrBuilder ()  
   Optional. Additional information about CSV formatted data.
 
 .google.cloud.dataplex.v1.StorageFormat.JsonOptions json = 11 [(.google.api.field_behavior) = OPTIONAL];
 
    
public   String   getMimeType ()  
   Required. The mime type descriptor for the data. Must match the pattern
 {type}/{subtype}. Supported values:
application/x-parquet 
application/x-avro 
application/x-orc 
application/x-tfrecord 
application/x-parquet+iceberg 
application/x-avro+iceberg 
application/x-orc+iceberg 
application/json 
application/{subtypes} 
text/csv 
text/<subtypes> 
image/{image subtype} 
video/{video subtype} 
audio/{audio subtype} 
 
 string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
    
      
        Returns  
      
        Type Description  
      
        String The mimeType.
 
     
  
  
    
public   ByteString   getMimeTypeBytes ()  
   Required. The mime type descriptor for the data. Must match the pattern
 {type}/{subtype}. Supported values:
application/x-parquet 
application/x-avro 
application/x-orc 
application/x-tfrecord 
application/x-parquet+iceberg 
application/x-avro+iceberg 
application/x-orc+iceberg 
application/json 
application/{subtypes} 
text/csv 
text/<subtypes> 
image/{image subtype} 
video/{video subtype} 
audio/{audio subtype} 
 
 string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for mimeType.
 
     
  
  
    
public   StorageFormat . OptionsCase   getOptionsCase ()  
  
  
    
public   Parser<StorageFormat>   getParserForType ()  
  
  Overrides 
  
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
   Optional. Additional information about CSV formatted data.
 
 .google.cloud.dataplex.v1.StorageFormat.CsvOptions csv = 10 [(.google.api.field_behavior) = OPTIONAL];
 
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the csv field is set.
 
     
  
  
    
public   boolean   hasIceberg ()  
   Optional. Additional information about iceberg tables.
 
 .google.cloud.dataplex.v1.StorageFormat.IcebergOptions iceberg = 12 [(.google.api.field_behavior) = OPTIONAL];
 
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the iceberg field is set.
 
     
  
   Optional. Additional information about CSV formatted data.
 
 .google.cloud.dataplex.v1.StorageFormat.JsonOptions json = 11 [(.google.api.field_behavior) = OPTIONAL];
 
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the json field is set.
 
     
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  
    
public   StorageFormat . Builder   newBuilderForType ()  
  
  
    
protected   StorageFormat . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  
    
public   StorageFormat . Builder   toBuilder ()  
  
  
    
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-28 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-28 UTC."],[],[]]