Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class MetadataSchema.
Instance of a general MetadataSchema.
Generated from protobuf message google.cloud.aiplatform.v1.MetadataSchema
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name of the MetadataSchema. |
↳ schema_version |
string
The version of the MetadataSchema. The version's format must match the following regular expression: |
↳ schema |
string
Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by |
↳ schema_type |
int
The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this MetadataSchema was created. |
↳ description |
string
Description of the Metadata Schema |
getName
Output only. The resource name of the MetadataSchema.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The resource name of the MetadataSchema.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSchemaVersion
The version of the MetadataSchema. The version's format must match
the following regular expression: ^[0-9]+[.][0-9]+[.][0-9]+$, which would
allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
Generated from protobuf field string schema_version = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setSchemaVersion
The version of the MetadataSchema. The version's format must match
the following regular expression: ^[0-9]+[.][0-9]+[.][0-9]+$, which would
allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
Generated from protobuf field string schema_version = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSchema
Required. The raw YAML string representation of the MetadataSchema. The combination
of [MetadataSchema.version] and the schema name given by title in
[MetadataSchema.schema] must be unique within a MetadataStore.
The schema is defined as an OpenAPI 3.0.2 MetadataSchema Object
Generated from protobuf field string schema = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setSchema
Required. The raw YAML string representation of the MetadataSchema. The combination
of [MetadataSchema.version] and the schema name given by title in
[MetadataSchema.schema] must be unique within a MetadataStore.
The schema is defined as an OpenAPI 3.0.2 MetadataSchema Object
Generated from protobuf field string schema = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSchemaType
The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
Generated from protobuf field .google.cloud.aiplatform.v1.MetadataSchema.MetadataSchemaType schema_type = 4;
| Returns | |
|---|---|
| Type | Description |
int | |
setSchemaType
The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema.
Generated from protobuf field .google.cloud.aiplatform.v1.MetadataSchema.MetadataSchemaType schema_type = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Timestamp when this MetadataSchema was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this MetadataSchema was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description of the Metadata Schema
Generated from protobuf field string description = 6;
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description of the Metadata Schema
Generated from protobuf field string description = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |