projects

PATCH /v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}

Updates the parameters of a single FeatureGroup.

Request

Path parameters

projectsIdstring required
locationsIdstring required
featureGroupsIdstring required

Query parameters

updateMaskstring google-fieldmask

Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to * to override all fields. Updatable fields: * labels * description * big_query * big_query.entity_id_columns * service_agent_type

Request body

createTimestring google-datetime

Output only. Timestamp when this FeatureGroup was created.

descriptionstring

Optional. Description of the FeatureGroup.

etagstring

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

labelsobject

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.

namestring

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

serviceAccountEmailstring

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.

serviceAgentType'SERVICE_AGENT_TYPE_UNSPECIFIED' | 'SERVICE_AGENT_TYPE_PROJECT' | 'SERVICE_AGENT_TYPE_FEATURE_GROUP'

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.

updateTimestring google-datetime

Output only. Timestamp when this FeatureGroup was last updated.

Response

Successful response

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

responseobject

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Changes

No recorded changes to this operation across all 8 revisions of this API.