Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Partition.
Represents partition metadata contained within entity instances.
Generated from protobuf message google.cloud.dataplex.v1.Partition
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Partition values used in the HTTP URL must be double encoded. For example, |
↳ values |
array
Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity. |
↳ location |
string
Required. Immutable. The location of the entity data within the partition, for example, |
↳ etag |
string
Optional. The etag for this partition. |
getName
Output only. Partition values used in the HTTP URL must be
double encoded. For example, url_encode(url_encode(value)) can be used
to encode "US:CA/CA#Sunnyvale so that the request URL ends
with "/partitions/US%253ACA/CA%2523Sunnyvale".
The name field in the response retains the encoded format.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Partition values used in the HTTP URL must be
double encoded. For example, url_encode(url_encode(value)) can be used
to encode "US:CA/CA#Sunnyvale so that the request URL ends
with "/partitions/US%253ACA/CA%2523Sunnyvale".
The name field in the response retains the encoded format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValues
Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setValues
Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLocation
Required. Immutable. The location of the entity data within the partition,
for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or
projects/<project_id>/datasets/<dataset_id>/tables/<table_id>
| Returns | |
|---|---|
| Type | Description |
string | |
setLocation
Required. Immutable. The location of the entity data within the partition,
for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or
projects/<project_id>/datasets/<dataset_id>/tables/<table_id>
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEtag
Optional. The etag for this partition.
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Optional. The etag for this partition.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |