Google Cloud Dataplex V1 Client - Class MetadataTemplate (1.1.0)

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

MetadataTemplate definition for an AspectType.

Generated from protobuf message google.cloud.dataplex.v1.AspectType.MetadataTemplate

Namespace

Google \ Cloud \ Dataplex \ V1 \ AspectType

Methods

__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. 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<MetadataTemplate>

Optional. Field definition. You must specify it if the type is record. It defines the nested fields.
↳ enum_values array<MetadataTemplate\EnumValue>

Optional. The list of values for an enum type. You must define it if the type is enum.
↳ map_items MetadataTemplate

Optional. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.
↳ array_items MetadataTemplate

Optional. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.
↳ type_id string

Optional. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it if the field type is record.
↳ type_ref string

Optional. A reference to another field definition (not an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with record type can refer to other fields.
↳ constraints MetadataTemplate\Constraints

Optional. Specifies the constraints on this field.
↳ annotations 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. 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. 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. You must specify it if the type is record. It defines the nested fields.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRecordFields

Optional. Field definition. You must specify it if the type is record. It defines the nested fields.

Parameter
Name Description
var array<MetadataTemplate>
Returns
Type Description
$this

getEnumValues

Optional. The list of values for an enum type. You must define it if the type is enum.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEnumValues

Optional. The list of values for an enum type. You must define it if the type is enum.

Parameter
Name Description
var array<MetadataTemplate\EnumValue>
Returns
Type Description
$this

getMapItems

Optional. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.

Returns
Type Description
MetadataTemplate|null

hasMapItems

clearMapItems

setMapItems

Optional. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.

Parameter
Name Description
var MetadataTemplate
Returns
Type Description
$this

getArrayItems

Optional. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.

Returns
Type Description
MetadataTemplate|null

hasArrayItems

clearArrayItems

setArrayItems

Optional. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload.

Parameter
Name Description
var MetadataTemplate
Returns
Type Description
$this

getTypeId

Optional. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it if the field type is record.

Returns
Type Description
string

setTypeId

Optional. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it if the field type is record.

Parameter
Name Description
var string
Returns
Type Description
$this

getTypeRef

Optional. A reference to another field definition (not an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with record type can refer to other fields.

Returns
Type Description
string

setTypeRef

Optional. A reference to another field definition (not an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with record type 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
MetadataTemplate\Constraints|null

hasConstraints

clearConstraints

setConstraints

Optional. Specifies the constraints on this field.

Parameter
Name Description
var MetadataTemplate\Constraints
Returns
Type Description
$this

getAnnotations

Optional. Specifies annotations on this field.

Returns
Type Description
MetadataTemplate\Annotations|null

hasAnnotations

clearAnnotations

setAnnotations

Optional. Specifies annotations on this field.

Parameter
Name Description
var MetadataTemplate\Annotations
Returns
Type Description
$this