Interface SchemaOrBuilder (1.45.0)

public interface SchemaOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFields(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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>

getPartitionFields(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getUserManaged()

public abstract 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.