gcube-model/docs/gcube-model-property.rst

5.0 KiB

Property

GCubeProperty

Marker type for any properties extended in the gCube model.

GCubeProperty extends Property
Name Type Attributes Description
This type does not define any additional attributes.

The GCubeProperty current version is 1.0.0.

Changelog:

  • 1.0.0: First Version.

AccessPolicy

AccessPolicy information

AccessPolicy extends GCubeProperty
Name Type Attributes Description
note String Mandatory:false ReadOnly:false NotNull:false
policy ValueSchema Mandatory:false ReadOnly:false NotNull:false

The AccessPolicy current version is 1.0.0.

Changelog:

  • 1.0.0: First Version.

EnumStringProperty

Enum String Property

EnumStringProperty extends GCubeProperty
Name Type Attributes Description
This type does not define any additional attributes.

The EnumStringProperty current version is 1.0.0.

Changelog:

  • 1.0.0: First Version.

RegexProperty

A property validated with a regular expression.

RegexProperty extends GCubeProperty
Name Type Attributes Description
value String Mandatory:false ReadOnly:false NotNull:false
schema String Mandatory:false ReadOnly:false NotNull:false

The RegexProperty current version is 1.0.0.

Changelog:

  • 1.0.0: First Version.

ValueSchema

This type aims at exposing a value which can be automatically managed by any client with no knowledge of its format.

ValueSchema extends GCubeProperty
Name Type Attributes Description
value String Mandatory:true ReadOnly:false NotNull:true The value which schema is available at the URI provided in the schema property.
schema String Mandatory:false ReadOnly:false NotNull:false An URI containing a schema used to validate/interpret the content of the value. It is only an informative field. The validation is in charge of the client.

The ValueSchema current version is 1.0.0.

Changelog:

  • 1.0.0: First Version.