Google Cloud Dataplex V1 Client - Class Partition (0.1.6)

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. The values must be HTML URL encoded two times before constructing the path. For example, if you have a value of "US:CA", encoded it two times and you get "US%253ACA". Then if you have the 2nd value is "CA#Sunnyvale", encoded two times and you get "CA%2523Sunnyvale". The partition values path is "US%253ACA/CA%2523Sunnyvale". The final URL will be "https://.../partitions/US%253ACA/CA%2523Sunnyvale". The name field in the responses will always have the encoded format.

↳ values
string[]

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 . Or projects/<project_id>/datasets/<dataset_id>/tables/<table_id>

↳ etag
string

Optional. The etag for this partition.

getName

Output only. The values must be HTML URL encoded two times before constructing the path.

For example, if you have a value of "US:CA", encoded it two times and you get "US%253ACA". Then if you have the 2nd value is "CA#Sunnyvale", encoded two times and you get "CA%2523Sunnyvale". The partition values path is "US%253ACA/CA%2523Sunnyvale". The final URL will be "https://.../partitions/US%253ACA/CA%2523Sunnyvale". The name field in the responses will always have the encoded format.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Returns
Type
Description
string

setName

Output only. The values must be HTML URL encoded two times before constructing the path.

For example, if you have a value of "US:CA", encoded it two times and you get "US%253ACA". Then if you have the 2nd value is "CA#Sunnyvale", encoded two times and you get "CA%2523Sunnyvale". The partition values path is "US%253ACA/CA%2523Sunnyvale". The final URL will be "https://.../partitions/US%253ACA/CA%2523Sunnyvale". The name field in the responses will always have the encoded format.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

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.

Generated from protobuf field repeated string values = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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.

Generated from protobuf field repeated string values = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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>

Generated from protobuf field string location = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

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>

Generated from protobuf field string location = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEtag

Optional. The etag for this partition.

Generated from protobuf field string etag = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
string

setEtag

Optional. The etag for this partition.

Generated from protobuf field string etag = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: