com.google.cloud.aiplatform.v1beta1

Interface FeatureGroupOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

FeatureGroup, FeatureGroup.Builder

public interface FeatureGroupOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
FeatureGroup.BigQuery	getBigQuery() Indicates that features for this group come from BigQuery Table/View.
FeatureGroup.BigQueryOrBuilder	getBigQueryOrBuilder() Indicates that features for this group come from BigQuery Table/View.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
String	getEtag() Optional.
com.google.protobuf.ByteString	getEtagBytes() Optional.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getName() Identifier.
com.google.protobuf.ByteString	getNameBytes() Identifier.
String	getServiceAccountEmail() Output only.
com.google.protobuf.ByteString	getServiceAccountEmailBytes() Output only.
FeatureGroup.ServiceAgentType	getServiceAgentType() Optional.
int	getServiceAgentTypeValue() Optional.
FeatureGroup.SourceCase	getSourceCase()
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasBigQuery() Indicates that features for this group come from BigQuery Table/View.
boolean	hasCreateTime() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasBigQuery

boolean hasBigQuery()

 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`.
 

.google.cloud.aiplatform.v1beta1.FeatureGroup.BigQuery big_query = 7;

Returns:

Whether the bigQuery field is set.

getBigQuery

FeatureGroup.BigQuery 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`.
 

.google.cloud.aiplatform.v1beta1.FeatureGroup.BigQuery big_query = 7;

Returns:

The bigQuery.

getBigQueryOrBuilder

FeatureGroup.BigQueryOrBuilder getBigQueryOrBuilder()

 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`.
 

.google.cloud.aiplatform.v1beta1.FeatureGroup.BigQuery big_query = 7;

getName

String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns:

The bytes for name.

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when this FeatureGroup was created.
 

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when this FeatureGroup was created.
 

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when this FeatureGroup was created.
 

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUpdateTime

boolean hasUpdateTime()

 Output only. Timestamp when this FeatureGroup was last updated.
 

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. Timestamp when this FeatureGroup was last updated.
 

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Timestamp when this FeatureGroup was last updated.
 

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

getEtag

String getEtag()

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

string etag = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The etag.

getEtagBytes

com.google.protobuf.ByteString getEtagBytes()

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

string etag = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for etag.

getLabelsCount

int getLabelsCount()

 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.
 

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

containsLabels

boolean containsLabels(String key)

 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.
 

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

 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.
 

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

 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.
 

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrThrow

String getLabelsOrThrow(String key)

 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.
 

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

getDescription

String getDescription()

 Optional. Description of the FeatureGroup.
 

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Optional. Description of the FeatureGroup.
 

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for description.

getServiceAgentTypeValue

int getServiceAgentTypeValue()

 Optional. Service agent type used during jobs under a FeatureGroup. By
 default, the Vertex AI Service Agent is used. When using an IAM Policy to
 isolate this FeatureGroup within a project, a separate service account
 should be provisioned by setting this field to
 `SERVICE_AGENT_TYPE_FEATURE_GROUP`. This will generate a separate service
 account to access the BigQuery source table.
 

.google.cloud.aiplatform.v1beta1.FeatureGroup.ServiceAgentType service_agent_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The enum numeric value on the wire for serviceAgentType.

getServiceAgentType

FeatureGroup.ServiceAgentType getServiceAgentType()

 Optional. Service agent type used during jobs under a FeatureGroup. By
 default, the Vertex AI Service Agent is used. When using an IAM Policy to
 isolate this FeatureGroup within a project, a separate service account
 should be provisioned by setting this field to
 `SERVICE_AGENT_TYPE_FEATURE_GROUP`. This will generate a separate service
 account to access the BigQuery source table.
 

.google.cloud.aiplatform.v1beta1.FeatureGroup.ServiceAgentType service_agent_type = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The serviceAgentType.

getServiceAccountEmail

String getServiceAccountEmail()

 Output only. A Service Account unique to this FeatureGroup. The role
 bigquery.dataViewer should be granted to this service account to allow
 Vertex AI Feature Store to access source data while running jobs under this
 FeatureGroup.
 

string service_account_email = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The serviceAccountEmail.

getServiceAccountEmailBytes

com.google.protobuf.ByteString getServiceAccountEmailBytes()

 Output only. A Service Account unique to this FeatureGroup. The role
 bigquery.dataViewer should be granted to this service account to allow
 Vertex AI Feature Store to access source data while running jobs under this
 FeatureGroup.
 

string service_account_email = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for serviceAccountEmail.

getSourceCase

FeatureGroup.SourceCase getSourceCase()