2023-11-07
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues
Parameter Order: featureView
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Fetch feature values under a FeatureView.
Parameters:
featureView
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Type: string
Location: path
Description: Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
Required: Yes
Path: v1/{+featureView}:fetchFeatureValues
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.list
Path: v1/{+parent}/featureViews
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: GET
Parameters:
pageSize
Description: The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
Location: query
Format: int32
Type: integer
filter
Description: Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.
Type: string
Location: query
parent
Location: path
Required: Yes
Description: Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Type: string
pageToken
Description: A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.
Location: query
Type: string
orderBy
Location: query
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews
Description: Lists FeatureViews in a given FeatureOnlineStore.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.sync
Parameters:
featureView
Description: Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location: path
Required: Yes
Parameter Order: featureView
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Triggers on-demand sync for the FeatureView.
Path: v1/{+featureView}:sync
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Type: string
Description: Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Parameter Order: name
Path: v1/{+name}
HTTP Method: DELETE
Description: Deletes a single FeatureView.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.create
Path: v1/{+parent}/featureViews
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews
Description: Creates a new FeatureView in a given FeatureOnlineStore.
Parameters:
runSyncImmediately
Type: boolean
Location: query
Description: Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.
featureViewId
Location: query
Description: Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.
Type: string
parent
Description: Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location: path
Required: Yes
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.get
Parameters:
name
Location: path
Required: Yes
Description: Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}
Description: Gets details of a single FeatureView.
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: name
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}
Parameters:
updateMask
Description: Field mask is used to specify the fields to be overwritten in the FeatureView 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`
Format: google-fieldmask
Type: string
Location: query
name
Type: string
Description: Output only. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Required: Yes
Location: path
Path: v1/{+name}
Description: Updates the parameters of a single FeatureView.
HTTP Method: PATCH
Parameter Order: name
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get
Parameters:
name
Description: The name of the operation resource.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}
Path: v1/{+name}
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Location: path
Type: string
HTTP Method: DELETE
Path: v1/{+name}
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:wait
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource to wait on.
timeout
Format: google-duration
Type: string
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Location: query
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:wait
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$
Location: path
Type: string
Required: Yes
Description: The name of the operation's parent resource.
filter
Location: query
Description: The standard list filter.
Type: string
pageToken
Location: query
Description: The standard list page token.
Type: string
pageSize
Description: The standard list page size.
Type: integer
Location: query
Format: int32
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$
Type: string
HTTP Method: GET
Description: Gets details of a single FeatureViewSync.
Path: v1/{+name}
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list
Path: v1/{+parent}/featureViewSyncs
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs
Parameters:
pageSize
Description: The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
parent
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Description: Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
pageToken
Location: query
Description: A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.
Type: string
filter
Location: query
Type: string
Description: Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \"2020-01-31T15:30:00.000000Z\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.
orderBy
Location: query
Type: string
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time`
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists FeatureViewSyncs in a given FeatureView.
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.featureOnlineStores.operations.wait
HTTP Method: POST
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait
Path: v1/{+name}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
timeout
Location: query
Format: google-duration
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
name
Description: The name of the operation resource to wait on.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$
Required: Yes
▼ ▲ aiplatform.projects.locations.featureOnlineStores.operations.delete
Parameter Order: name
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}
Parameters:
name
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Path: v1/{+name}
▼ ▲ aiplatform.projects.locations.featureOnlineStores.operations.get
Path: v1/{+name}
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Description: The name of the operation resource.
Type: string
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.featureOnlineStores.operations.listWait
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
pageSize
Type: integer
Location: query
Format: int32
Description: The standard list page size.
name
Description: The name of the operation's parent resource.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$
Required: Yes
filter
Location: query
Type: string
Description: The standard list filter.
Path: v1/{+name}:wait
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.get
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Description: Required. The name of the FeatureOnlineStore resource.
Required: Yes
Location: path
Type: string
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}
Path: v1/{+name}
Parameter Order: name
Description: Gets details of a single FeatureOnlineStore.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.list
Parameter Order: parent
Path: v1/{+parent}/featureOnlineStores
HTTP Method: GET
Description: Lists FeatureOnlineStores in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
filter
Type: string
Description: Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > "2020-01-01" OR update_time > "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod".
Location: query
pageToken
Type: string
Location: query
Description: A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.
pageSize
Description: The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.
Format: int32
Type: integer
Location: query
parent
Description: Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
orderBy
Type: string
Location: query
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time`
▼ ▲ aiplatform.projects.locations.featureOnlineStores.patch
Description: Updates the parameters of a single FeatureOnlineStore.
HTTP Method: PATCH
Path: v1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}
Parameters:
name
Description: Output only. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location: path
Required: Yes
updateMask
Type: string
Format: google-fieldmask
Description: Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore 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: * `big_query_source` * `labels` * `sync_config`
Location: query
▼ ▲ aiplatform.projects.locations.featureOnlineStores.create
Parameters:
parent
Description: Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}'`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
featureOnlineStoreId
Type: string
Location: query
Description: Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.
Description: Creates a new FeatureOnlineStore in a given project and location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores
HTTP Method: POST
Parameter Order: parent
Path: v1/{+parent}/featureOnlineStores
▼ ▲ aiplatform.projects.locations.featureOnlineStores.delete
Parameter Order: name
Description: Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}
Parameters:
force
Type: boolean
Description: If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)
Location: query
name
Location: path
Description: Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.featureGroups.features.operations.listWait
Path: v1/{+name}:wait
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait
Parameters:
pageSize
Type: integer
Location: query
Description: The standard list page size.
Format: int32
filter
Type: string
Location: query
Description: The standard list filter.
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Type: string
Required: Yes
Description: The name of the operation's parent resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.projects.locations.featureGroups.features.operations.wait
Parameters:
timeout
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Format: google-duration
Type: string
Location: query
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to wait on.
Parameter Order: name
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait
Path: v1/{+name}:wait
HTTP Method: POST
▼ ▲ aiplatform.projects.locations.featureGroups.features.operations.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}
Path: v1/{+name}
HTTP Method: DELETE
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Required: Yes
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.featureGroups.features.operations.get
Parameters:
name
Description: The name of the operation resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$
Required: Yes
Location: path
HTTP Method: GET
Path: v1/{+name}
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.projects.locations.featureGroups.features.get
HTTP Method: GET
Parameter Order: name
Description: Gets details of a single Feature.
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
▼ ▲ aiplatform.projects.locations.featureGroups.features.delete
HTTP Method: DELETE
Parameters:
name
Location: path
Type: string
Description: Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Deletes a single Feature.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}
▼ ▲ aiplatform.projects.locations.featureGroups.features.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}
HTTP Method: PATCH
Parameters:
updateMask
Format: google-fieldmask
Location: query
Description: Field mask is used to specify the fields to be overwritten in the Features 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: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature)
Type: string
name
Location: path
Description: Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$
Required: Yes
Type: string
Description: Updates the parameters of a single Feature.
Parameter Order: name
▼ ▲ aiplatform.projects.locations.featureGroups.features.list
Path: v1/{+parent}/features
Parameters:
readMask
Format: google-fieldmask
Location: query
Description: Mask specifying which fields to read.
Type: string
filter
Location: query
Type: string
Description: Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.
pageSize
Description: The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.
Format: int32
Location: query
Type: integer
parent
Description: Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Required: Yes
Location: path
Type: string
latestStatsCount
Location: query
Description: Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.
Type: integer
Format: int32
pageToken
Location: query
Type: string
Description: A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or or FeatureRegistryService.ListFeatures must match the call that provided the page token.
orderBy
Type: string
Location: query
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`
Parameter Order: parent
HTTP Method: GET
Description: Lists Features in a given FeatureGroup.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features
▼ ▲ aiplatform.projects.locations.featureGroups.features.create
Path: v1/{+parent}/features
Parameter Order: parent
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features
Parameters:
featureId
Type: string
Description: Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
Location: query
parent
Type: string
Required: Yes
Location: path
Description: Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Description: Creates a new Feature in a given FeatureGroup.
▼ ▲ aiplatform.projects.locations.featureGroups.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Location: path
Required: Yes
Parameter Order: name
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Path: v1/{+name}
▼ ▲ aiplatform.projects.locations.featureGroups.operations.delete
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}
Parameter Order: name
Path: v1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$
Required: Yes
Description: The name of the operation resource to be deleted.
Location: path
Type: string
▼ ▲ aiplatform.projects.locations.featureGroups.operations.listWait
Parameter Order: name
HTTP Method: GET
Path: v1/{+name}:wait
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters:
filter
Location: query
Type: string
Description: The standard list filter.
pageToken
Type: string
Description: The standard list page token.
Location: query
pageSize
Description: The standard list page size.
Type: integer
Format: int32
Location: query
name
Location: path
Required: Yes
Description: The name of the operation's parent resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.projects.locations.featureGroups.operations.wait
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait
Description: Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameters:
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$
Description: The name of the operation resource to wait on.
timeout
Format: google-duration
Location: query
Description: The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type: string
Parameter Order: name
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:wait
▼ ▲ aiplatform.projects.locations.featureGroups.list
Parameter Order: parent
Description: Lists FeatureGroups in a given project and location.
Path: v1/{+parent}/featureGroups
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups
Parameters:
parent
Description: Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
pageToken
Type: string
Description: A page token, received from a previous FeatureGroupAdminService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureGroupAdminService.ListFeatureGroups must match the call that provided the page token.
Location: query
pageSize
Location: query
Type: integer
Format: int32
Description: The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.
orderBy
Type: string
Location: query
Description: A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time`
filter
Type: string
Description: Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > "2020-01-01" OR update_time > "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod".
Location: query
▼ ▲ aiplatform.projects.locations.featureGroups.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Description: Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Required: Yes
force
Type: boolean
Description: If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)
Location: query
Description: Deletes a single FeatureGroup.
Parameter Order: name
HTTP Method: DELETE
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}
▼ ▲ aiplatform.projects.locations.featureGroups.create
HTTP Method: POST
Parameters:
featureGroupId
Location: query
Description: Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.
Type: string
parent
Location: path
Description: Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}'`
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/featureGroups
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups
Description: Creates a new FeatureGroup in a given project and location.
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.featureGroups.get
Path: v1/{+name}
Parameter Order: name
Description: Gets details of a single FeatureGroup.
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Type: string
Location: path
Description: Required. The name of the FeatureGroup resource.
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}
▼ ▲ aiplatform.projects.locations.featureGroups.patch
Parameters:
name
Description: Output only. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Location: path
Type: string
Required: Yes
updateMask
Location: query
Format: google-fieldmask
Description: 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`
Type: string
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single FeatureGroup.
HTTP Method: PATCH
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}