Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Context.
Instance of a general context.
Generated from protobuf message google.cloud.aiplatform.v1.Context
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name of the Context. |
↳ display_name |
string
User provided display name of the Context. May be up to 128 Unicode characters. |
↳ etag |
string
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
↳ labels |
array|Google\Protobuf\Internal\MapField
The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded). |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this Context was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this Context was last updated. |
↳ parent_contexts |
array
Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts. |
↳ schema_title |
string
The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. |
↳ schema_version |
string
The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. |
↳ metadata |
Google\Protobuf\Struct
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. |
↳ description |
string
Description of the Context |
getName
Output only. The resource name of the Context.
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 Context.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
User provided display name of the Context.
May be up to 128 Unicode characters.
Generated from protobuf field string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
User provided display name of the Context.
May be up to 128 Unicode characters.
Generated from protobuf field string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEtag
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 8;
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
The labels with user-defined metadata to organize your Contexts.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
Generated from protobuf field map<string, string> labels = 9;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
The labels with user-defined metadata to organize your Contexts.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
Generated from protobuf field map<string, string> labels = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Timestamp when this Context was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this Context was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Timestamp when this Context was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this Context was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParentContexts
Output only. A list of resource names of Contexts that are parents of this Context.
A Context may have at most 10 parent_contexts.
Generated from protobuf field repeated string parent_contexts = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setParentContexts
Output only. A list of resource names of Contexts that are parents of this Context.
A Context may have at most 10 parent_contexts.
Generated from protobuf field repeated string parent_contexts = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSchemaTitle
The title of the schema describing the metadata.
Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
Generated from protobuf field string schema_title = 13;
| Returns | |
|---|---|
| Type | Description |
string | |
setSchemaTitle
The title of the schema describing the metadata.
Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
Generated from protobuf field string schema_title = 13;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSchemaVersion
The version of the schema in schema_name to use.
Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
Generated from protobuf field string schema_version = 14;
| Returns | |
|---|---|
| Type | Description |
string | |
setSchemaVersion
The version of the schema in schema_name to use.
Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
Generated from protobuf field string schema_version = 14;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetadata
Properties of the Context.
Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
Generated from protobuf field .google.protobuf.Struct metadata = 15;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasMetadata
clearMetadata
setMetadata
Properties of the Context.
Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
Generated from protobuf field .google.protobuf.Struct metadata = 15;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description of the Context
Generated from protobuf field string description = 16;
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description of the Context
Generated from protobuf field string description = 16;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |