Class StorageDescriptor (0.76.0)

public final class StorageDescriptor extends GeneratedMessage implements StorageDescriptorOrBuilder

Contains information about the physical storage of the table data.

Protobuf type google.cloud.biglake.hive.v1beta.StorageDescriptor

Static Fields

BUCKET_COLS_FIELD_NUMBER

public static final int BUCKET_COLS_FIELD_NUMBER
Field Value
Type Description
int

COLUMNS_FIELD_NUMBER

public static final int COLUMNS_FIELD_NUMBER
Field Value
Type Description
int

COMPRESSED_FIELD_NUMBER

public static final int COMPRESSED_FIELD_NUMBER
Field Value
Type Description
int

INPUT_FORMAT_FIELD_NUMBER

public static final int INPUT_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_URI_FIELD_NUMBER

public static final int LOCATION_URI_FIELD_NUMBER
Field Value
Type Description
int

NUM_BUCKETS_FIELD_NUMBER

public static final int NUM_BUCKETS_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_FORMAT_FIELD_NUMBER

public static final int OUTPUT_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

SERDE_INFO_FIELD_NUMBER

public static final int SERDE_INFO_FIELD_NUMBER
Field Value
Type Description
int

SKEWED_INFO_FIELD_NUMBER

public static final int SKEWED_INFO_FIELD_NUMBER
Field Value
Type Description
int

SORT_COLS_FIELD_NUMBER

public static final int SORT_COLS_FIELD_NUMBER
Field Value
Type Description
int

STORED_AS_SUB_DIRS_FIELD_NUMBER

public static final int STORED_AS_SUB_DIRS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StorageDescriptor getDefaultInstance()
Returns
Type Description
StorageDescriptor

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static StorageDescriptor.Builder newBuilder()
Returns
Type Description
StorageDescriptor.Builder

newBuilder(StorageDescriptor prototype)

public static StorageDescriptor.Builder newBuilder(StorageDescriptor prototype)
Parameter
Name Description
prototype StorageDescriptor
Returns
Type Description
StorageDescriptor.Builder

parseDelimitedFrom(InputStream input)

public static StorageDescriptor parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StorageDescriptor parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static StorageDescriptor parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StorageDescriptor parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StorageDescriptor parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StorageDescriptor parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StorageDescriptor parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StorageDescriptor parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static StorageDescriptor parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StorageDescriptor parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static StorageDescriptor parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StorageDescriptor parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StorageDescriptor
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<StorageDescriptor> parser()
Returns
Type Description
Parser<StorageDescriptor>

Methods

containsParameters(String key)

public boolean containsParameters(String key)

Optional. Key-value pairs for the storage descriptor. The maximum size is 10Kib.

map<string, string> parameters = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBucketCols(int index)

public String getBucketCols(int index)

Optional. Reducer grouping columns and clustering columns and bucketing columns

repeated string bucket_cols = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The bucketCols at the given index.

getBucketColsBytes(int index)

public ByteString getBucketColsBytes(int index)

Optional. Reducer grouping columns and clustering columns and bucketing columns

repeated string bucket_cols = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the bucketCols at the given index.

getBucketColsCount()

public int getBucketColsCount()

Optional. Reducer grouping columns and clustering columns and bucketing columns

repeated string bucket_cols = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of bucketCols.

getBucketColsList()

public ProtocolStringList getBucketColsList()

Optional. Reducer grouping columns and clustering columns and bucketing columns

repeated string bucket_cols = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the bucketCols.

getColumns(int index)

public FieldSchema getColumns(int index)

Required. Specifies the columns of the table.

repeated .google.cloud.biglake.hive.v1beta.FieldSchema columns = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
FieldSchema

getColumnsCount()

public int getColumnsCount()

Required. Specifies the columns of the table.

repeated .google.cloud.biglake.hive.v1beta.FieldSchema columns = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getColumnsList()

public List<FieldSchema> getColumnsList()

Required. Specifies the columns of the table.

repeated .google.cloud.biglake.hive.v1beta.FieldSchema columns = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<FieldSchema>

getColumnsOrBuilder(int index)

public FieldSchemaOrBuilder getColumnsOrBuilder(int index)

Required. Specifies the columns of the table.

repeated .google.cloud.biglake.hive.v1beta.FieldSchema columns = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
FieldSchemaOrBuilder

getColumnsOrBuilderList()

public List<? extends FieldSchemaOrBuilder> getColumnsOrBuilderList()

Required. Specifies the columns of the table.

repeated .google.cloud.biglake.hive.v1beta.FieldSchema columns = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.biglake.hive.v1beta.FieldSchemaOrBuilder>

getCompressed()

public boolean getCompressed()

Optional. Whether the table is compressed.

optional bool compressed = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The compressed.

getDefaultInstanceForType()

public StorageDescriptor getDefaultInstanceForType()
Returns
Type Description
StorageDescriptor

getInputFormat()

public String getInputFormat()

Optional. The fully qualified Java class name of the input format. The maximum length is 4000 characters.

string input_format = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The inputFormat.

getInputFormatBytes()

public ByteString getInputFormatBytes()

Optional. The fully qualified Java class name of the input format. The maximum length is 4000 characters.

string input_format = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for inputFormat.

getLocationUri()

public String getLocationUri()

Optional. The Cloud storage uri where the table is located. Defaults to <database_location_uri>/<table_name>. The maximum length is 4000 characters.

string location_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The locationUri.

getLocationUriBytes()

public ByteString getLocationUriBytes()

Optional. The Cloud storage uri where the table is located. Defaults to <database_location_uri>/<table_name>. The maximum length is 4000 characters.

string location_uri = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for locationUri.

getNumBuckets()

public int getNumBuckets()

Optional. The number of buckets in the table.

optional int32 num_buckets = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The numBuckets.

getOutputFormat()

public String getOutputFormat()

Optional. The fully qualified Java class name of the output format. The maximum length is 4000 characters.

string output_format = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The outputFormat.

getOutputFormatBytes()

public ByteString getOutputFormatBytes()

Optional. The fully qualified Java class name of the output format. The maximum length is 4000 characters.

string output_format = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for outputFormat.

getParameters() (deprecated)

public Map<String,String> getParameters()

Use #getParametersMap() instead.

Returns
Type Description
Map<String,String>

getParametersCount()

public int getParametersCount()

Optional. Key-value pairs for the storage descriptor. The maximum size is 10Kib.

map<string, string> parameters = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getParametersMap()

public Map<String,String> getParametersMap()

Optional. Key-value pairs for the storage descriptor. The maximum size is 10Kib.

map<string, string> parameters = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getParametersOrDefault(String key, String defaultValue)

public String getParametersOrDefault(String key, String defaultValue)

Optional. Key-value pairs for the storage descriptor. The maximum size is 10Kib.

map<string, string> parameters = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getParametersOrThrow(String key)

public String getParametersOrThrow(String key)

Optional. Key-value pairs for the storage descriptor. The maximum size is 10Kib.

map<string, string> parameters = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<StorageDescriptor> getParserForType()
Returns
Type Description
Parser<StorageDescriptor>
Overrides

getSerdeInfo()

public SerdeInfo getSerdeInfo()

Optional. Serialization and deserialization information.

.google.cloud.biglake.hive.v1beta.SerdeInfo serde_info = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SerdeInfo

The serdeInfo.

getSerdeInfoOrBuilder()

public SerdeInfoOrBuilder getSerdeInfoOrBuilder()

Optional. Serialization and deserialization information.

.google.cloud.biglake.hive.v1beta.SerdeInfo serde_info = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SerdeInfoOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSkewedInfo()

public StorageDescriptor.SkewedInfo getSkewedInfo()

Optional. Table data skew information.

.google.cloud.biglake.hive.v1beta.StorageDescriptor.SkewedInfo skewed_info = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StorageDescriptor.SkewedInfo

The skewedInfo.

getSkewedInfoOrBuilder()

public StorageDescriptor.SkewedInfoOrBuilder getSkewedInfoOrBuilder()

Optional. Table data skew information.

.google.cloud.biglake.hive.v1beta.StorageDescriptor.SkewedInfo skewed_info = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StorageDescriptor.SkewedInfoOrBuilder

getSortCols(int index)

public StorageDescriptor.Order getSortCols(int index)

Optional. Sort order of the data in each bucket

repeated .google.cloud.biglake.hive.v1beta.StorageDescriptor.Order sort_cols = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
StorageDescriptor.Order

getSortColsCount()

public int getSortColsCount()

Optional. Sort order of the data in each bucket

repeated .google.cloud.biglake.hive.v1beta.StorageDescriptor.Order sort_cols = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSortColsList()

public List<StorageDescriptor.Order> getSortColsList()

Optional. Sort order of the data in each bucket

repeated .google.cloud.biglake.hive.v1beta.StorageDescriptor.Order sort_cols = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Order>

getSortColsOrBuilder(int index)

public StorageDescriptor.OrderOrBuilder getSortColsOrBuilder(int index)

Optional. Sort order of the data in each bucket

repeated .google.cloud.biglake.hive.v1beta.StorageDescriptor.Order sort_cols = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
StorageDescriptor.OrderOrBuilder

getSortColsOrBuilderList()

public List<? extends StorageDescriptor.OrderOrBuilder> getSortColsOrBuilderList()

Optional. Sort order of the data in each bucket

repeated .google.cloud.biglake.hive.v1beta.StorageDescriptor.Order sort_cols = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.biglake.hive.v1beta.StorageDescriptor.OrderOrBuilder>

getStoredAsSubDirs()

public boolean getStoredAsSubDirs()

Optional. Whether the table is stored as sub directories.

optional bool stored_as_sub_dirs = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The storedAsSubDirs.

hasCompressed()

public boolean hasCompressed()

Optional. Whether the table is compressed.

optional bool compressed = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the compressed field is set.

hasNumBuckets()

public boolean hasNumBuckets()

Optional. The number of buckets in the table.

optional int32 num_buckets = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the numBuckets field is set.

hasSerdeInfo()

public boolean hasSerdeInfo()

Optional. Serialization and deserialization information.

.google.cloud.biglake.hive.v1beta.SerdeInfo serde_info = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the serdeInfo field is set.

hasSkewedInfo()

public boolean hasSkewedInfo()

Optional. Table data skew information.

.google.cloud.biglake.hive.v1beta.StorageDescriptor.SkewedInfo skewed_info = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the skewedInfo field is set.

hasStoredAsSubDirs()

public boolean hasStoredAsSubDirs()

Optional. Whether the table is stored as sub directories.

optional bool stored_as_sub_dirs = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the storedAsSubDirs field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public StorageDescriptor.Builder newBuilderForType()
Returns
Type Description
StorageDescriptor.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected StorageDescriptor.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StorageDescriptor.Builder
Overrides

toBuilder()

public StorageDescriptor.Builder toBuilder()
Returns
Type Description
StorageDescriptor.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException