Reference documentation and code samples for the Google Cloud Dataplex V1 Client class MetadataTemplate.
MetadataTemplate definition for AspectType
Generated from protobuf message google.cloud.dataplex.v1.AspectType.MetadataTemplate
Namespace
Google \ Cloud \ Dataplex \ V1 \ AspectTypeMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ index |
int
Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions. |
↳ name |
string
Required. The name of the field. |
↳ type |
string
Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex types (enum, array, map, record). |
↳ record_fields |
array<Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate>
Optional. Field definition, needs to be specified if the type is record. Defines the nested fields. |
↳ enum_values |
array<Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate\EnumValue>
Optional. The list of values for an enum type. Needs to be defined if the type is enum. |
↳ map_items |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate
Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload. |
↳ array_items |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate
Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload. |
↳ type_id |
string
Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record. |
↳ type_ref |
string
Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields. |
↳ constraints |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate\Constraints
Optional. Specifies the constraints on this field. |
↳ annotations |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate\Annotations
Optional. Specifies annotations on this field. |
getIndex
Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions.
Returns | |
---|---|
Type | Description |
int |
setIndex
Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getName
Required. The name of the field.
Returns | |
---|---|
Type | Description |
string |
setName
Required. The name of the field.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getType
Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex types (enum, array, map, record).
Returns | |
---|---|
Type | Description |
string |
setType
Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex types (enum, array, map, record).
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getRecordFields
Optional. Field definition, needs to be specified if the type is record.
Defines the nested fields.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setRecordFields
Optional. Field definition, needs to be specified if the type is record.
Defines the nested fields.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate>
|
Returns | |
---|---|
Type | Description |
$this |
getEnumValues
Optional. The list of values for an enum type. Needs to be defined if the type is enum.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setEnumValues
Optional. The list of values for an enum type. Needs to be defined if the type is enum.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate\EnumValue>
|
Returns | |
---|---|
Type | Description |
$this |
getMapItems
Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate|null |
hasMapItems
clearMapItems
setMapItems
Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate
|
Returns | |
---|---|
Type | Description |
$this |
getArrayItems
Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate|null |
hasArrayItems
clearArrayItems
setArrayItems
Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate
|
Returns | |
---|---|
Type | Description |
$this |
getTypeId
Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record.
Returns | |
---|---|
Type | Description |
string |
setTypeId
Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getTypeRef
Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields.
Returns | |
---|---|
Type | Description |
string |
setTypeRef
Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getConstraints
Optional. Specifies the constraints on this field.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate\Constraints|null |
hasConstraints
clearConstraints
setConstraints
Optional. Specifies the constraints on this field.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate\Constraints
|
Returns | |
---|---|
Type | Description |
$this |
getAnnotations
Optional. Specifies annotations on this field.
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate\Annotations|null |
hasAnnotations
clearAnnotations
setAnnotations
Optional. Specifies annotations on this field.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate\Annotations
|
Returns | |
---|---|
Type | Description |
$this |