Class Schema (1.16.0)

Version 1.16.0

• 1.51.0 (latest)
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.2
• 1.0.1
• 0.2.2

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

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Schema.Builder toBuilder()

Returns
Type	Description
Schema.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException