Google Cloud Dataplex V1 Client - Class PartitionField (0.2.3)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class PartitionField.

Represents a key field within the entity's partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration. Note: Partition fields are immutable.

Generated from protobuf message google.cloud.dataplex.v1.Schema.PartitionField

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..

↳ type int

Required. Immutable. The type of field.

getName

Required. Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setName

Required. Partition field name must consist of letters, numbers, and underscores only, with a maximum of length of 256 characters, and must begin with a letter or underscore..

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

Required. Immutable. The type of field.

Returns
TypeDescription
int

setType

Required. Immutable. The type of field.

Parameter
NameDescription
var int
Returns
TypeDescription
$this