Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Partition.
Represents partition metadata contained within entity instances.
Generated from protobuf messagegoogle.cloud.dataplex.v1.Partition
Namespace
Google \ Cloud \ Dataplex \ V1
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,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.
↳ 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,gs://bucket/path/to/entity/key1=value1/key2=value2. Orprojects/<project_id>/datasets/<dataset_id>/tables/<table_id>
↳ 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.
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. Orprojects/<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. Orprojects/<project_id>/datasets/<dataset_id>/tables/<table_id>
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class Partition (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.Partition)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.Partition)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.Partition)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.Partition)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.Partition)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.Partition)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.Partition)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.Partition)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.Partition)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.Partition)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.Partition)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.Partition)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.Partition)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.Partition)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.Partition)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.Partition)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.Partition)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.Partition)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.Partition)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.Partition)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.Partition)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.Partition)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.Partition)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.Partition) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class Partition.\n\nRepresents partition metadata contained within entity instances.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.Partition`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. Partition values used in the HTTP URL must be\ndouble encoded. For example, `url_encode(url_encode(value))` can be used\nto encode \"US:CA/CA#Sunnyvale so that the request URL ends\nwith \"/partitions/US%253ACA/CA%2523Sunnyvale\".\n\nThe name field in the response retains the encoded format.\n\n### setName\n\nOutput only. Partition values used in the HTTP URL must be\ndouble encoded. For example, `url_encode(url_encode(value))` can be used\nto encode \"US:CA/CA#Sunnyvale so that the request URL ends\nwith \"/partitions/US%253ACA/CA%2523Sunnyvale\".\n\nThe name field in the response retains the encoded format.\n\n### getValues\n\nRequired. Immutable. The set of values representing the partition, which\ncorrespond to the partition schema defined in the parent entity.\n\n### setValues\n\nRequired. Immutable. The set of values representing the partition, which\ncorrespond to the partition schema defined in the parent entity.\n\n### getLocation\n\nRequired. Immutable. The location of the entity data within the partition,\nfor example, `gs://bucket/path/to/entity/key1=value1/key2=value2`. Or\n`projects/\u003cproject_id\u003e/datasets/\u003cdataset_id\u003e/tables/\u003ctable_id\u003e`\n\n### setLocation\n\nRequired. Immutable. The location of the entity data within the partition,\nfor example, `gs://bucket/path/to/entity/key1=value1/key2=value2`. Or\n`projects/\u003cproject_id\u003e/datasets/\u003cdataset_id\u003e/tables/\u003ctable_id\u003e`\n\n### getEtag\n\nOptional. The etag for this partition.\n\n### setEtag\n\nOptional. The etag for this partition."]]
