Class Schema (1.43.0) 

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Schema

Implements

SchemaOrBuilder

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()
Returns
Type Description
Descriptor

newBuilder()

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

newBuilder(Schema prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
index int
Returns
Type Description
Schema.SchemaField

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];

Returns
Type Description
List<SchemaField>

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
index int
Returns
Type Description
Schema.SchemaFieldOrBuilder

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()
Returns
Type Description
Parser<Schema>
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
index int
Returns
Type Description
Schema.PartitionField

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];

Returns
Type Description
List<PartitionField>

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
index int
Returns
Type Description
Schema.PartitionFieldOrBuilder

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
Type Description
Schema.PartitionStyle

The partitionStyle.

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Schema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Schema.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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