Send feedback
Class Schema (1.53.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 1.53.0 keyboard_arrow_down
public final class Schema extends GeneratedMessageV3 implements SchemaOrBuilder
Schema information describing the structure and layout of the data.
Protobuf type google.cloud.dataplex.v1.Schema
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
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
Field Value
Type Description
int
PARTITION_FIELDS_FIELD_NUMBER
public static final int PARTITION_FIELDS_FIELD_NUMBER
Field Value
Type Description
int
PARTITION_STYLE_FIELD_NUMBER
public static final int PARTITION_STYLE_FIELD_NUMBER
Field Value
Type Description
int
USER_MANAGED_FIELD_NUMBER
public static final int USER_MANAGED_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Schema getDefaultInstance ()
Returns
Type Description
Schema
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Schema . Builder newBuilder ()
newBuilder(Schema prototype)
public static Schema . Builder newBuilder ( Schema prototype )
Parameter
Name Description
prototypeSchema
public static Schema parseDelimitedFrom ( InputStream input )
Returns
Type Description
Schema
public static Schema parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Schema
parseFrom(byte[] data)
public static Schema parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Schema
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Schema
parseFrom(ByteString data)
public static Schema parseFrom ( ByteString data )
Returns
Type Description
Schema
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Schema
public static Schema parseFrom ( CodedInputStream input )
Returns
Type Description
Schema
public static Schema parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Schema
public static Schema parseFrom ( InputStream input )
Returns
Type Description
Schema
public static Schema parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Schema
parseFrom(ByteBuffer data)
public static Schema parseFrom ( ByteBuffer data )
Returns
Type Description
Schema
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Schema
parser()
public static Parser<Schema> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Schema getDefaultInstanceForType ()
Returns
Type Description
Schema
getFields(int index)
public Schema . SchemaField getFields ( int index )
Optional. The sequence of fields describing data in table entities.
Note: BigQuery SchemaFields are immutable.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint
getFieldsCount()
public int getFieldsCount ()
Optional. The sequence of fields describing data in table entities.
Note: BigQuery SchemaFields are immutable.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int
getFieldsList()
public List<Schema . SchemaField > getFieldsList ()
Optional. The sequence of fields describing data in table entities.
Note: BigQuery SchemaFields are immutable.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];
getFieldsOrBuilder(int index)
public Schema . SchemaFieldOrBuilder getFieldsOrBuilder ( int index )
Optional. The sequence of fields describing data in table entities.
Note: BigQuery SchemaFields are immutable.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint
getFieldsOrBuilderList()
public List <? extends Schema . SchemaFieldOrBuilder > getFieldsOrBuilderList ()
Optional. The sequence of fields describing data in table entities.
Note: BigQuery SchemaFields are immutable.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
List <? extends com.google.cloud.dataplex.v1.Schema.SchemaFieldOrBuilder >
getParserForType()
public Parser<Schema> getParserForType ()
Overrides
getPartitionFields(int index)
public Schema . PartitionField getPartitionFields ( int index )
Optional. The sequence of fields describing the partition structure in
entities. If this field is empty, there are no partitions within the data.
repeated .google.cloud.dataplex.v1.Schema.PartitionField partition_fields = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint
getPartitionFieldsCount()
public int getPartitionFieldsCount ()
Optional. The sequence of fields describing the partition structure in
entities. If this field is empty, there are no partitions within the data.
repeated .google.cloud.dataplex.v1.Schema.PartitionField partition_fields = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int
getPartitionFieldsList()
public List<Schema . PartitionField > getPartitionFieldsList ()
Optional. The sequence of fields describing the partition structure in
entities. If this field is empty, there are no partitions within the data.
repeated .google.cloud.dataplex.v1.Schema.PartitionField partition_fields = 3 [(.google.api.field_behavior) = OPTIONAL];
getPartitionFieldsOrBuilder(int index)
public Schema . PartitionFieldOrBuilder getPartitionFieldsOrBuilder ( int index )
Optional. The sequence of fields describing the partition structure in
entities. If this field is empty, there are no partitions within the data.
repeated .google.cloud.dataplex.v1.Schema.PartitionField partition_fields = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint
getPartitionFieldsOrBuilderList()
public List <? extends Schema . PartitionFieldOrBuilder > getPartitionFieldsOrBuilderList ()
Optional. The sequence of fields describing the partition structure in
entities. If this field is empty, there are no partitions within the data.
repeated .google.cloud.dataplex.v1.Schema.PartitionField partition_fields = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
List <? extends com.google.cloud.dataplex.v1.Schema.PartitionFieldOrBuilder >
getPartitionStyle()
public Schema . PartitionStyle getPartitionStyle ()
Optional. The structure of paths containing partition data within the
entity.
.google.cloud.dataplex.v1.Schema.PartitionStyle partition_style = 4 [(.google.api.field_behavior) = OPTIONAL];
getPartitionStyleValue()
public int getPartitionStyleValue ()
Optional. The structure of paths containing partition data within the
entity.
.google.cloud.dataplex.v1.Schema.PartitionStyle partition_style = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The enum numeric value on the wire for partitionStyle.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getUserManaged()
public boolean getUserManaged ()
Required. Set to true if user-managed or false if managed by Dataplex.
The default is false (managed by Dataplex).
Set to falseto enable Dataplex discovery to update the schema.
including new data discovery, schema inference, and schema evolution.
Users retain the ability to input and edit the schema. Dataplex
treats schema input by the user as though produced
by a previous Dataplex discovery operation, and it will
evolve the schema and take action based on that treatment.
Set to true to fully manage the entity
schema. This setting guarantees that Dataplex will not
change schema fields.
bool user_managed = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
boolean The userManaged.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Schema . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Schema . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Schema . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
