Google Cloud Dataplex V1 Client - Class SchemaRelationship (1.13.0)

1.13.0 (latest) 1.12.0 1.11.0 1.10.0 1.9.1 1.8.0 1.7.1 1.6.1 1.4.0 1.3.0 1.2.1 1.1.1 1.0.1 0.16.1 0.15.1 0.14.0 0.13.0 0.12.0 0.11.1 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.1 0.4.0 0.3.0 0.2.3 0.1.6

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

Details of the relationship between the schema of two resources.

Generated from protobuf message google.cloud.dataplex.v1.DataDocumentationResult.SchemaRelationship

Namespace

Google \ Cloud \ Dataplex \ V1 \ DataDocumentationResult

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ left_schema_paths	SchemaRelationship\SchemaPaths Output only. An ordered list of fields for the join from the first table. The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list.
↳ right_schema_paths	SchemaRelationship\SchemaPaths Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths. Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list.
↳ sources	int[] Output only. Sources which generated the schema relation edge.
↳ type	int Output only. The type of relationship between the schema paths.

getLeftSchemaPaths

Output only. An ordered list of fields for the join from the first table.

The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list.

Returns
Type	Description
SchemaRelationship\SchemaPaths|null

hasLeftSchemaPaths

clearLeftSchemaPaths

setLeftSchemaPaths

Output only. An ordered list of fields for the join from the first table.

The size of this list must be the same as right_schema_paths. Each field at index i in this list must correspond to a field at the same index in the right_schema_paths list.

Parameter
Name	Description
var	SchemaRelationship\SchemaPaths

Returns
Type	Description
$this

getRightSchemaPaths

Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths.

Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list.

Returns
Type	Description
SchemaRelationship\SchemaPaths|null

hasRightSchemaPaths

clearRightSchemaPaths

setRightSchemaPaths

Output only. An ordered list of fields for the join from the second table. The size of this list must be the same as left_schema_paths.

Each field at index i in this list must correspond to a field at the same index in the left_schema_paths list.

Parameter
Name	Description
var	SchemaRelationship\SchemaPaths

Returns
Type	Description
$this

getSources

Output only. Sources which generated the schema relation edge.

Returns
Type	Description
Google\Protobuf\RepeatedField<int>

setSources

Output only. Sources which generated the schema relation edge.

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getType

Output only. The type of relationship between the schema paths.

Returns
Type	Description
int	Enum of type Type.

setType

Output only. The type of relationship between the schema paths.

Parameter
Name	Description
var	int Enum of type Type.

Returns
Type	Description
$this