Google Cloud Ai Platform V1 Client - Class FeatureGroup (1.5.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class FeatureGroup.

Vertex AI Feature Group.

Generated from protobuf message google.cloud.aiplatform.v1.FeatureGroup

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ big_query Google\Cloud\AIPlatform\V1\FeatureGroup\BigQuery

Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source. The BigQuery source table or view must have at least one entity ID column and a column named feature_timestamp.

↳ name string

Identifier. Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}

↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp when this FeatureGroup was created.

↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp when this FeatureGroup was last updated.

↳ etag string

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. The labels with user-defined metadata to organize your FeatureGroup. 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. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

↳ description string

Optional. Description of the FeatureGroup.

getBigQuery

Indicates that features for this group come from BigQuery Table/View.

By default treats the source as a sparse time series source. The BigQuery source table or view must have at least one entity ID column and a column named feature_timestamp.

Returns
Type Description
Google\Cloud\AIPlatform\V1\FeatureGroup\BigQuery|null

hasBigQuery

setBigQuery

Indicates that features for this group come from BigQuery Table/View.

By default treats the source as a sparse time series source. The BigQuery source table or view must have at least one entity ID column and a column named feature_timestamp.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\FeatureGroup\BigQuery
Returns
Type Description
$this

getName

Identifier. Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}

Returns
Type Description
string

setName

Identifier. Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Timestamp when this FeatureGroup was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this FeatureGroup was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Timestamp when this FeatureGroup was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this FeatureGroup was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEtag

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns
Type Description
string

setEtag

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. The labels with user-defined metadata to organize your FeatureGroup.

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. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. The labels with user-defined metadata to organize your FeatureGroup.

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. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getDescription

Optional. Description of the FeatureGroup.

Returns
Type Description
string

setDescription

Optional. Description of the FeatureGroup.

Parameter
Name Description
var string
Returns
Type Description
$this

getSource

Returns
Type Description
string