2023-10-04
▼ ▲ aiplatform.publishers.models.list
Flat Path: v1beta1/publishers/{publishersId}/models
Path: v1beta1/{+parent}/models
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Location: path
Type: string
Required: Yes
Pattern: ^publishers/[^/]+$
Description: Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`
pageToken
Type: string
Location: query
Description: Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.
orderBy
Type: string
Description: Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
Location: query
view
Description: Optional. PublisherModel view specifying which fields to read.
Enum:
Enum Descriptions:
Type: string
Location: query
filter
Location: query
Type: string
Description: Optional. The standard list filter.
pageSize
Format: int32
Description: Optional. The standard list page size.
Type: integer
Location: query
languageCode
Location: query
Description: Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en).
Type: string
HTTP Method: GET
Description: Lists publisher models in Model Garden.
▼ ▲ aiplatform.projects.locations.featureGroups.features.patch
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}
Parameter Order: name
HTTP Method: PATCH
Description: Updates the parameters of a single Feature.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
updateMask
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`
Format: google-fieldmask
Type: string
Location: query
name
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$
Required: Yes
Description: Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/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.
Type: string
Location: path
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.featureGroups.features.get
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$
Description: Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Required: Yes
Location: path
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}
Description: Gets details of a single Feature.
▼ ▲ aiplatform.projects.locations.featureGroups.features.delete
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}
Description: Deletes a single Feature.
Parameter Order: name
Path: v1beta1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$
Required: Yes
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}`
▼ ▲ aiplatform.projects.locations.featureGroups.features.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features
Path: v1beta1/{+parent}/features
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Required: Yes
Location: path
featureId
Location: query
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.
Description: Creates a new Feature in a given FeatureGroup.
HTTP Method: POST
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.featureGroups.features.list
HTTP Method: GET
Description: Lists Features in a given FeatureGroup.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v1beta1/{+parent}/features
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features
Parameters:
pageToken
Type: string
Location: query
Description: A page token, received from a previous FeaturestoreService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures must match the call that provided the page token.
latestStatsCount
Description: 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.
Location: query
Type: integer
Format: int32
readMask
Location: query
Format: google-fieldmask
Type: string
Description: Mask specifying which fields to read.
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: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`
pageSize
Type: integer
Location: query
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
parent
Location: path
Required: Yes
Description: Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
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.
▼ ▲ aiplatform.projects.locations.featureGroups.patch
HTTP Method: PATCH
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}
Description: Updates the parameters of a single FeatureGroup.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Location: path
Type: string
Required: Yes
Description: Output only. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
updateMask
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`
Format: google-fieldmask
Type: string
Location: query
▼ ▲ aiplatform.projects.locations.featureGroups.create
Description: Creates a new FeatureGroup in a given project and location.
Parameter Order: parent
Parameters:
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}'`
Type: string
Location: path
featureGroupId
Location: query
Type: string
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.
HTTP Method: POST
Path: v1beta1/{+parent}/featureGroups
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups
▼ ▲ aiplatform.projects.locations.featureGroups.delete
Path: v1beta1/{+name}
Description: Deletes a single FeatureGroup.
Parameters:
force
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.)
Type: boolean
Location: query
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Description: Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`
Type: string
Location: path
HTTP Method: DELETE
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}
Parameter Order: name
▼ ▲ aiplatform.projects.locations.featureGroups.get
Path: v1beta1/{+name}
Parameter Order: name
Parameters:
name
Description: Required. The name of the FeatureGroup resource.
Pattern: ^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$
Required: Yes
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}
Description: Gets details of a single FeatureGroup.
▼ ▲ aiplatform.projects.locations.featureGroups.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups
Path: v1beta1/{+parent}/featureGroups
Parameters:
pageToken
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
Type: string
parent
Location: path
Required: Yes
Description: Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
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` * `update_time`
pageSize
Type: integer
Format: int32
Location: query
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.
filter
Type: string
Location: query
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".
Description: Lists FeatureGroups in a given project and location.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.patch
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}
Parameter Order: name
HTTP Method: PATCH
Parameters:
updateMask
Type: string
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
Location: query
name
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Description: Output only. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Path: v1beta1/{+name}
Description: Updates the parameters of a single FeatureView.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.sync
Path: v1beta1/{+featureView}:sync
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: featureView
Parameters:
featureView
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location: path
Required: Yes
Description: Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Type: string
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync
Description: Triggers on-demand sync for the FeatureView.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities
Parameter Order: featureView
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities
Description: Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.
Path: v1beta1/{+featureView}:searchNearestEntities
HTTP Method: POST
Parameters:
featureView
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Type: string
Required: Yes
Description: Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
Location: path
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues
Path: v1beta1/{+featureView}:fetchFeatureValues
Parameter Order: featureView
Parameters:
featureView
Description: Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location: path
HTTP Method: POST
Description: Fetch feature values under a FeatureView.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.list
Path: v1beta1/{+parent}/featureViews
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
filter
Location: query
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
pageToken
Type: string
Location: query
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.
pageSize
Format: int32
Type: integer
Location: query
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.
parent
Description: Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
orderBy
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
Location: query
Parameter Order: parent
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews
Description: Lists FeatureViews in a given FeatureOnlineStore.
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.create
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
featureViewId
Type: string
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.
Location: query
runSyncImmediately
Description: Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.
Type: boolean
Location: query
parent
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Description: Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
Path: v1beta1/{+parent}/featureViews
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews
Parameter Order: parent
Description: Creates a new FeatureView in a given FeatureOnlineStore.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Description: Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Required: Yes
Location: path
Type: string
Path: v1beta1/{+name}
Description: Deletes a single FeatureView.
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}
Parameter Order: name
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.get
Parameter Order: name
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location: path
Description: Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}
Path: v1beta1/{+name}
HTTP Method: GET
Description: Gets details of a single FeatureView.
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list
Parameters:
filter
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.
Location: query
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`
pageToken
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.
Location: query
Type: string
parent
Type: string
Description: Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$
Location: path
Required: Yes
pageSize
Type: integer
Location: query
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.
Format: int32
HTTP Method: GET
Description: Lists FeatureViewSyncs in a given FeatureView.
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+parent}/featureViewSyncs
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs
▼ ▲ aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get
Parameters:
name
Required: Yes
Type: string
Description: Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$
Location: path
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}
Description: Gets details of a single FeatureViewSync.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
Parameter Order: name
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.featureOnlineStores.list
Path: v1beta1/{+parent}/featureOnlineStores
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists FeatureOnlineStores in a given project and location.
Parameters:
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Description: Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`
filter
Location: query
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".
Type: string
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.
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` * `update_time`
pageSize
Format: int32
Location: query
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.
Type: integer
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores
HTTP Method: GET
▼ ▲ aiplatform.projects.locations.featureOnlineStores.get
HTTP Method: GET
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single FeatureOnlineStore.
Path: v1beta1/{+name}
Parameters:
name
Description: Required. The name of the FeatureOnlineStore resource.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location: path
Type: string
▼ ▲ aiplatform.projects.locations.featureOnlineStores.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores
Path: v1beta1/{+parent}/featureOnlineStores
Parameters:
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}'`
Type: string
Required: Yes
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.
HTTP Method: POST
Parameter Order: parent
▼ ▲ aiplatform.projects.locations.featureOnlineStores.patch
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}
HTTP Method: PATCH
Description: Updates the parameters of a single FeatureOnlineStore.
Parameters:
name
Required: Yes
Description: Output only. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Location: path
updateMask
Format: google-fieldmask
Location: query
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`
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.featureOnlineStores.delete
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.
Parameters:
force
Type: boolean
Location: query
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.)
name
Location: path
Description: Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$
Required: Yes
Parameter Order: name
HTTP Method: DELETE
▼ ▲ aiplatform.projects.locations.featurestores.entityTypes.features.create
Parameters:
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$
Location: path
Description: Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
Type: string