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
Static Fields
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
Field Value
PARTITION_FIELDS_FIELD_NUMBER
public static final int PARTITION_FIELDS_FIELD_NUMBER
Field Value
PARTITION_STYLE_FIELD_NUMBER
public static final int PARTITION_STYLE_FIELD_NUMBER
Field Value
USER_MANAGED_FIELD_NUMBER
public static final int USER_MANAGED_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Schema getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Schema.Builder newBuilder()
Returns
newBuilder(Schema prototype)
public static Schema.Builder newBuilder(Schema prototype)
Parameter
Name | Description |
prototype | Schema
|
Returns
public static Schema parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Schema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Schema parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Schema parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Schema parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Schema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Schema parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Schema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Schema parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Schema> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Schema getDefaultInstanceForType()
Returns
getFields(int index)
public Schema.SchemaField getFields(int index)
Optional. The sequence of fields describing data in table entities.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Returns
getFieldsCount()
public int getFieldsCount()
Optional. The sequence of fields describing data in table entities.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
getFieldsList()
public List<Schema.SchemaField> getFieldsList()
Optional. The sequence of fields describing data in table entities.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
getFieldsOrBuilder(int index)
public Schema.SchemaFieldOrBuilder getFieldsOrBuilder(int index)
Optional. The sequence of fields describing data in table entities.
repeated .google.cloud.dataplex.v1.Schema.SchemaField fields = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Returns
getFieldsOrBuilderList()
public List<? extends Schema.SchemaFieldOrBuilder> getFieldsOrBuilderList()
Optional. The sequence of fields describing data in table entities.
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()
Returns
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
Returns
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
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];
Returns
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
Returns
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];
Returns
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
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUserManaged()
public boolean getUserManaged()
Required. Whether the schema is user-managed or managed by the service.
- Set user_manage to false if you would like Dataplex to help you manage
the schema. You will get the full service provided by Dataplex discovery,
including new data discovery, schema inference and schema evolution. You
can still provide input the schema of the entities, for example renaming a
schema field, changing CSV or Json options if you think the discovered
values are not as accurate. Dataplex will consider your input as the
initial schema (as if they were produced by the previous discovery run),
and will evolve schema or flag actions based on that.
- Set user_manage to true if you would like to fully manage the entity
schema by yourself. This is useful when you would like to manually specify
the schema for a table. In this case, the schema defined by the user is
guaranteed to be kept unchanged and would not be overwritten. But this also
means Dataplex will not provide schema evolution management for you.
Dataplex will still be able to manage partition registration (i.e., keeping
the list of partitions up to date) when Dataplex discovery is turned on and
user_managed is set to true.
bool user_managed = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
boolean | The userManaged.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Schema.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Schema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Schema.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions