docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="aiplatform_v1.html">Vertex AI API</a> . <a href="aiplatform_v1.projects.html">projects</a> . <a href="aiplatform_v1.projects.locations.html">locations</a> . <a href="aiplatform_v1.projects.locations.featureOnlineStores.html">featureOnlineStores</a> . <a href="aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html">featureViews</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="aiplatform_v1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.html">featureViewSyncs()</a></code>
</p>
<p class="firstline">Returns the featureViewSyncs Resource.</p>

<p class="toc_element">
  <code><a href="aiplatform_v1.projects.locations.featureOnlineStores.featureViews.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, featureViewId=None, runSyncImmediately=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new FeatureView in a given FeatureOnlineStore.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single FeatureView.</p>
<p class="toc_element">
  <code><a href="#fetchFeatureValues">fetchFeatureValues(featureView, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetch feature values under a FeatureView.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single FeatureView.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists FeatureViews in a given FeatureOnlineStore.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single FeatureView.</p>
<p class="toc_element">
  <code><a href="#searchNearestEntities">searchNearestEntities(featureView, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
  <code><a href="#sync">sync(featureView, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Triggers on-demand sync for the FeatureView.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, featureViewId=None, runSyncImmediately=None, x__xgafv=None)</code>
  <pre>Creates a new FeatureView in a given FeatureOnlineStore.

Args:
  parent: string, Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}` (required)
  body: object, The request body.
    The object takes the form of:

{ # FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.
  &quot;bigQuerySource&quot;: { # Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.
    &quot;entityIdColumns&quot;: [ # Required. Columns to construct entity_id / row keys.
      &quot;A String&quot;,
    ],
    &quot;uri&quot;: &quot;A String&quot;, # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this FeatureView was created.
  &quot;etag&quot;: &quot;A String&quot;, # Optional. Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
  &quot;featureRegistrySource&quot;: { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
    &quot;featureGroups&quot;: [ # Required. List of features that need to be synced to Online Store.
      { # Features belonging to a single feature group that will be synced to Online Store.
        &quot;featureGroupId&quot;: &quot;A String&quot;, # Required. Identifier of the feature group.
        &quot;featureIds&quot;: [ # Required. Identifiers of features under the feature group.
          &quot;A String&quot;,
        ],
      },
    ],
    &quot;projectNumber&quot;: &quot;A String&quot;, # Optional. The project number of the parent project of the Feature Groups.
  },
  &quot;indexConfig&quot;: { # Configuration for vector indexing. # Optional. Configuration for index preparation for vector search. It contains the required configurations to create an index from source data, so that approximate nearest neighbor (a.k.a ANN) algorithms search can be performed during online serving.
    &quot;bruteForceConfig&quot;: { # Configuration options for using brute force search. # Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search.
    },
    &quot;crowdingColumn&quot;: &quot;A String&quot;, # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it&#x27;s guaranteed that no more than K entities of the same crowding attribute are returned in the response.
    &quot;distanceMeasureType&quot;: &quot;A String&quot;, # Optional. The distance measure used in nearest neighbor search.
    &quot;embeddingColumn&quot;: &quot;A String&quot;, # Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search.
    &quot;embeddingDimension&quot;: 42, # Optional. The number of dimensions of the input embedding.
    &quot;filterColumns&quot;: [ # Optional. Columns of features that&#x27;re used to filter vector search results.
      &quot;A String&quot;,
    ],
    &quot;treeAhConfig&quot;: { # Configuration options for the tree-AH algorithm. # Optional. Configuration options for the tree-AH algorithm (Shallow tree + Asymmetric Hashing). Please refer to this paper for more details: https://arxiv.org/abs/1908.10396
      &quot;leafNodeEmbeddingCount&quot;: &quot;A String&quot;, # Optional. Number of embeddings on each leaf node. The default value is 1000 if not set.
    },
  },
  &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your FeatureViews. 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 FeatureOnlineStore(System labels are excluded).&quot; System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
  &quot;syncConfig&quot;: { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving.
    &quot;cron&quot;: &quot;A String&quot;, # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: &quot;CRON_TZ=${IANA_TIME_ZONE}&quot; or &quot;TZ=${IANA_TIME_ZONE}&quot;. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, &quot;CRON_TZ=America/New_York 1 * * * *&quot;, or &quot;TZ=America/New_York 1 * * * *&quot;.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this FeatureView was last updated.
}

  featureViewId: string, Required. The ID to use for the FeatureView, which will become the final component of the FeatureView&#x27;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.
  runSyncImmediately: boolean, Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # 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.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}`.
  &quot;response&quot;: { # 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`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a single FeatureView.

Args:
  name: string, Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # 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.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}`.
  &quot;response&quot;: { # 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`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="fetchFeatureValues">fetchFeatureValues(featureView, body=None, x__xgafv=None)</code>
  <pre>Fetch feature values under a FeatureView.

Args:
  featureView: string, Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned.
  &quot;dataFormat&quot;: &quot;A String&quot;, # Optional. Response data format. If not set, FeatureViewDataFormat.KEY_VALUE will be used.
  &quot;dataKey&quot;: { # Lookup key for a feature view. # Optional. The request key to fetch feature values for.
    &quot;compositeKey&quot;: { # ID that is comprised from several parts (columns). # The actual Entity ID will be composed from this struct. This should match with the way ID is defined in the FeatureView spec.
      &quot;parts&quot;: [ # Parts to construct Entity ID. Should match with the same ID columns as defined in FeatureView in the same order.
        &quot;A String&quot;,
      ],
    },
    &quot;key&quot;: &quot;A String&quot;, # String key to use for lookup.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for FeatureOnlineStoreService.FetchFeatureValues
  &quot;dataKey&quot;: { # Lookup key for a feature view. # The data key associated with this response. Will only be populated for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs.
    &quot;compositeKey&quot;: { # ID that is comprised from several parts (columns). # The actual Entity ID will be composed from this struct. This should match with the way ID is defined in the FeatureView spec.
      &quot;parts&quot;: [ # Parts to construct Entity ID. Should match with the same ID columns as defined in FeatureView in the same order.
        &quot;A String&quot;,
      ],
    },
    &quot;key&quot;: &quot;A String&quot;, # String key to use for lookup.
  },
  &quot;keyValues&quot;: { # Response structure in the format of key (feature name) and (feature) value pair. # Feature values in KeyValue format.
    &quot;features&quot;: [ # List of feature names and values.
      { # Feature name &amp; value pair.
        &quot;name&quot;: &quot;A String&quot;, # Feature short name.
        &quot;value&quot;: { # Value for a feature. # Feature value.
          &quot;boolArrayValue&quot;: { # A list of boolean values. # A list of bool type feature value.
            &quot;values&quot;: [ # A list of bool values.
              True or False,
            ],
          },
          &quot;boolValue&quot;: True or False, # Bool type feature value.
          &quot;bytesValue&quot;: &quot;A String&quot;, # Bytes feature value.
          &quot;doubleArrayValue&quot;: { # A list of double values. # A list of double type feature value.
            &quot;values&quot;: [ # A list of double values.
              3.14,
            ],
          },
          &quot;doubleValue&quot;: 3.14, # Double type feature value.
          &quot;int64ArrayValue&quot;: { # A list of int64 values. # A list of int64 type feature value.
            &quot;values&quot;: [ # A list of int64 values.
              &quot;A String&quot;,
            ],
          },
          &quot;int64Value&quot;: &quot;A String&quot;, # Int64 feature value.
          &quot;metadata&quot;: { # Metadata of feature value. # Metadata of feature value.
            &quot;generateTime&quot;: &quot;A String&quot;, # Feature generation timestamp. Typically, it is provided by user at feature ingestion time. If not, feature store will use the system timestamp when the data is ingested into feature store. For streaming ingestion, the time, aligned by days, must be no older than five years (1825 days) and no later than one year (366 days) in the future.
          },
          &quot;stringArrayValue&quot;: { # A list of string values. # A list of string type feature value.
            &quot;values&quot;: [ # A list of string values.
              &quot;A String&quot;,
            ],
          },
          &quot;stringValue&quot;: &quot;A String&quot;, # String feature value.
        },
      },
    ],
  },
  &quot;protoStruct&quot;: { # Feature values in proto Struct format.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets details of a single FeatureView.

Args:
  name: string, Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.
  &quot;bigQuerySource&quot;: { # Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.
    &quot;entityIdColumns&quot;: [ # Required. Columns to construct entity_id / row keys.
      &quot;A String&quot;,
    ],
    &quot;uri&quot;: &quot;A String&quot;, # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this FeatureView was created.
  &quot;etag&quot;: &quot;A String&quot;, # Optional. Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
  &quot;featureRegistrySource&quot;: { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
    &quot;featureGroups&quot;: [ # Required. List of features that need to be synced to Online Store.
      { # Features belonging to a single feature group that will be synced to Online Store.
        &quot;featureGroupId&quot;: &quot;A String&quot;, # Required. Identifier of the feature group.
        &quot;featureIds&quot;: [ # Required. Identifiers of features under the feature group.
          &quot;A String&quot;,
        ],
      },
    ],
    &quot;projectNumber&quot;: &quot;A String&quot;, # Optional. The project number of the parent project of the Feature Groups.
  },
  &quot;indexConfig&quot;: { # Configuration for vector indexing. # Optional. Configuration for index preparation for vector search. It contains the required configurations to create an index from source data, so that approximate nearest neighbor (a.k.a ANN) algorithms search can be performed during online serving.
    &quot;bruteForceConfig&quot;: { # Configuration options for using brute force search. # Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search.
    },
    &quot;crowdingColumn&quot;: &quot;A String&quot;, # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it&#x27;s guaranteed that no more than K entities of the same crowding attribute are returned in the response.
    &quot;distanceMeasureType&quot;: &quot;A String&quot;, # Optional. The distance measure used in nearest neighbor search.
    &quot;embeddingColumn&quot;: &quot;A String&quot;, # Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search.
    &quot;embeddingDimension&quot;: 42, # Optional. The number of dimensions of the input embedding.
    &quot;filterColumns&quot;: [ # Optional. Columns of features that&#x27;re used to filter vector search results.
      &quot;A String&quot;,
    ],
    &quot;treeAhConfig&quot;: { # Configuration options for the tree-AH algorithm. # Optional. Configuration options for the tree-AH algorithm (Shallow tree + Asymmetric Hashing). Please refer to this paper for more details: https://arxiv.org/abs/1908.10396
      &quot;leafNodeEmbeddingCount&quot;: &quot;A String&quot;, # Optional. Number of embeddings on each leaf node. The default value is 1000 if not set.
    },
  },
  &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your FeatureViews. 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 FeatureOnlineStore(System labels are excluded).&quot; System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
  &quot;syncConfig&quot;: { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving.
    &quot;cron&quot;: &quot;A String&quot;, # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: &quot;CRON_TZ=${IANA_TIME_ZONE}&quot; or &quot;TZ=${IANA_TIME_ZONE}&quot;. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, &quot;CRON_TZ=America/New_York 1 * * * *&quot;, or &quot;TZ=America/New_York 1 * * * *&quot;.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this FeatureView was last updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists FeatureViews in a given FeatureOnlineStore.

Args:
  parent: string, Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}` (required)
  filter: string, Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `&lt;`, `&gt;`, `&gt;=`, and `&lt;=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `&lt;`, `&gt;`, `&gt;=`, and `&lt;=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time &gt; \&quot;2020-01-31T15:30:00.000000Z\&quot; OR update_time &gt; \&quot;2020-01-31T15:30:00.000000Z\&quot;` --&gt; FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --&gt; FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --&gt; Any FeatureView which has a label with &#x27;env&#x27; as the key.
  orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use &quot;desc&quot; after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`
  pageSize: integer, 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.
  pageToken: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for FeatureOnlineStoreAdminService.ListFeatureViews.
  &quot;featureViews&quot;: [ # The FeatureViews matching the request.
    { # FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.
      &quot;bigQuerySource&quot;: { # Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.
        &quot;entityIdColumns&quot;: [ # Required. Columns to construct entity_id / row keys.
          &quot;A String&quot;,
        ],
        &quot;uri&quot;: &quot;A String&quot;, # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
      },
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this FeatureView was created.
      &quot;etag&quot;: &quot;A String&quot;, # Optional. Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
      &quot;featureRegistrySource&quot;: { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
        &quot;featureGroups&quot;: [ # Required. List of features that need to be synced to Online Store.
          { # Features belonging to a single feature group that will be synced to Online Store.
            &quot;featureGroupId&quot;: &quot;A String&quot;, # Required. Identifier of the feature group.
            &quot;featureIds&quot;: [ # Required. Identifiers of features under the feature group.
              &quot;A String&quot;,
            ],
          },
        ],
        &quot;projectNumber&quot;: &quot;A String&quot;, # Optional. The project number of the parent project of the Feature Groups.
      },
      &quot;indexConfig&quot;: { # Configuration for vector indexing. # Optional. Configuration for index preparation for vector search. It contains the required configurations to create an index from source data, so that approximate nearest neighbor (a.k.a ANN) algorithms search can be performed during online serving.
        &quot;bruteForceConfig&quot;: { # Configuration options for using brute force search. # Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search.
        },
        &quot;crowdingColumn&quot;: &quot;A String&quot;, # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it&#x27;s guaranteed that no more than K entities of the same crowding attribute are returned in the response.
        &quot;distanceMeasureType&quot;: &quot;A String&quot;, # Optional. The distance measure used in nearest neighbor search.
        &quot;embeddingColumn&quot;: &quot;A String&quot;, # Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search.
        &quot;embeddingDimension&quot;: 42, # Optional. The number of dimensions of the input embedding.
        &quot;filterColumns&quot;: [ # Optional. Columns of features that&#x27;re used to filter vector search results.
          &quot;A String&quot;,
        ],
        &quot;treeAhConfig&quot;: { # Configuration options for the tree-AH algorithm. # Optional. Configuration options for the tree-AH algorithm (Shallow tree + Asymmetric Hashing). Please refer to this paper for more details: https://arxiv.org/abs/1908.10396
          &quot;leafNodeEmbeddingCount&quot;: &quot;A String&quot;, # Optional. Number of embeddings on each leaf node. The default value is 1000 if not set.
        },
      },
      &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your FeatureViews. 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 FeatureOnlineStore(System labels are excluded).&quot; System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
      &quot;syncConfig&quot;: { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving.
        &quot;cron&quot;: &quot;A String&quot;, # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: &quot;CRON_TZ=${IANA_TIME_ZONE}&quot; or &quot;TZ=${IANA_TIME_ZONE}&quot;. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, &quot;CRON_TZ=America/New_York 1 * * * *&quot;, or &quot;TZ=America/New_York 1 * * * *&quot;.
      },
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this FeatureView was last updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as ListFeatureViewsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the parameters of a single FeatureView.

Args:
  name: string, Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` (required)
  body: object, The request body.
    The object takes the form of:

{ # FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.
  &quot;bigQuerySource&quot;: { # Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.
    &quot;entityIdColumns&quot;: [ # Required. Columns to construct entity_id / row keys.
      &quot;A String&quot;,
    ],
    &quot;uri&quot;: &quot;A String&quot;, # Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.
  },
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this FeatureView was created.
  &quot;etag&quot;: &quot;A String&quot;, # Optional. Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
  &quot;featureRegistrySource&quot;: { # A Feature Registry source for features that need to be synced to Online Store. # Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
    &quot;featureGroups&quot;: [ # Required. List of features that need to be synced to Online Store.
      { # Features belonging to a single feature group that will be synced to Online Store.
        &quot;featureGroupId&quot;: &quot;A String&quot;, # Required. Identifier of the feature group.
        &quot;featureIds&quot;: [ # Required. Identifiers of features under the feature group.
          &quot;A String&quot;,
        ],
      },
    ],
    &quot;projectNumber&quot;: &quot;A String&quot;, # Optional. The project number of the parent project of the Feature Groups.
  },
  &quot;indexConfig&quot;: { # Configuration for vector indexing. # Optional. Configuration for index preparation for vector search. It contains the required configurations to create an index from source data, so that approximate nearest neighbor (a.k.a ANN) algorithms search can be performed during online serving.
    &quot;bruteForceConfig&quot;: { # Configuration options for using brute force search. # Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search.
    },
    &quot;crowdingColumn&quot;: &quot;A String&quot;, # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it&#x27;s guaranteed that no more than K entities of the same crowding attribute are returned in the response.
    &quot;distanceMeasureType&quot;: &quot;A String&quot;, # Optional. The distance measure used in nearest neighbor search.
    &quot;embeddingColumn&quot;: &quot;A String&quot;, # Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search.
    &quot;embeddingDimension&quot;: 42, # Optional. The number of dimensions of the input embedding.
    &quot;filterColumns&quot;: [ # Optional. Columns of features that&#x27;re used to filter vector search results.
      &quot;A String&quot;,
    ],
    &quot;treeAhConfig&quot;: { # Configuration options for the tree-AH algorithm. # Optional. Configuration options for the tree-AH algorithm (Shallow tree + Asymmetric Hashing). Please refer to this paper for more details: https://arxiv.org/abs/1908.10396
      &quot;leafNodeEmbeddingCount&quot;: &quot;A String&quot;, # Optional. Number of embeddings on each leaf node. The default value is 1000 if not set.
    },
  },
  &quot;labels&quot;: { # Optional. The labels with user-defined metadata to organize your FeatureViews. 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 FeatureOnlineStore(System labels are excluded).&quot; System reserved label keys are prefixed with &quot;aiplatform.googleapis.com/&quot; and are immutable.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`
  &quot;syncConfig&quot;: { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving.
    &quot;cron&quot;: &quot;A String&quot;, # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: &quot;CRON_TZ=${IANA_TIME_ZONE}&quot; or &quot;TZ=${IANA_TIME_ZONE}&quot;. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, &quot;CRON_TZ=America/New_York 1 * * * *&quot;, or &quot;TZ=America/New_York 1 * * * *&quot;.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this FeatureView was last updated.
}

  updateMask: string, 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` * `serviceAgentType`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # 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.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}`.
  &quot;response&quot;: { # 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`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="searchNearestEntities">searchNearestEntities(featureView, body=None, x__xgafv=None)</code>
  <pre>Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn&#x27;t indexable, returns Invalid argument response.

Args:
  featureView: string, Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}` (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for FeatureOnlineStoreService.SearchNearestEntities.
  &quot;query&quot;: { # A query to find a number of similar entities. # Required. The query.
    &quot;embedding&quot;: { # The embedding vector. # Optional. The embedding vector that be used for similar search.
      &quot;value&quot;: [ # Optional. Individual value in the embedding.
        3.14,
      ],
    },
    &quot;entityId&quot;: &quot;A String&quot;, # Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.
    &quot;neighborCount&quot;: 42, # Optional. The number of similar entities to be retrieved from feature view for each query.
    &quot;parameters&quot;: { # Parameters that can be overrided in each query to tune query latency and recall. # Optional. Parameters that can be set to tune query on the fly.
      &quot;approximateNeighborCandidates&quot;: 42, # Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be &gt; neighbor_count.
      &quot;leafNodesSearchFraction&quot;: 3.14, # Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0.
    },
    &quot;perCrowdingAttributeNeighborCount&quot;: 42, # Optional. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than sper_crowding_attribute_neighbor_count of the k neighbors returned have the same value of crowding_attribute. It&#x27;s used for improving result diversity.
    &quot;stringFilters&quot;: [ # Optional. The list of string filters.
      { # String filter is used to search a subset of the entities by using boolean rules on string columns. For example: if a query specifies string filter with &#x27;name = color, allow_tokens = {red, blue}, deny_tokens = {purple}&#x27;,&#x27; then that query will match entities that are red or blue, but if those points are also purple, then they will be excluded even if they are red/blue. Only string filter is supported for now, numeric filter will be supported in the near future.
        &quot;allowTokens&quot;: [ # Optional. The allowed tokens.
          &quot;A String&quot;,
        ],
        &quot;denyTokens&quot;: [ # Optional. The denied tokens.
          &quot;A String&quot;,
        ],
        &quot;name&quot;: &quot;A String&quot;, # Required. Column names in BigQuery that used as filters.
      },
    ],
  },
  &quot;returnFullEntity&quot;: True or False, # Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for FeatureOnlineStoreService.SearchNearestEntities
  &quot;nearestNeighbors&quot;: { # Nearest neighbors for one query. # The nearest neighbors of the query entity.
    &quot;neighbors&quot;: [ # All its neighbors.
      { # A neighbor of the query vector.
        &quot;distance&quot;: 3.14, # The distance between the neighbor and the query vector.
        &quot;entityId&quot;: &quot;A String&quot;, # The id of the similar entity.
        &quot;entityKeyValues&quot;: { # Response message for FeatureOnlineStoreService.FetchFeatureValues # The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when &quot;return_full_entity&quot; is set to true. Otherwise, only the &quot;entity_id&quot; and &quot;distance&quot; fields are populated.
          &quot;dataKey&quot;: { # Lookup key for a feature view. # The data key associated with this response. Will only be populated for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs.
            &quot;compositeKey&quot;: { # ID that is comprised from several parts (columns). # The actual Entity ID will be composed from this struct. This should match with the way ID is defined in the FeatureView spec.
              &quot;parts&quot;: [ # Parts to construct Entity ID. Should match with the same ID columns as defined in FeatureView in the same order.
                &quot;A String&quot;,
              ],
            },
            &quot;key&quot;: &quot;A String&quot;, # String key to use for lookup.
          },
          &quot;keyValues&quot;: { # Response structure in the format of key (feature name) and (feature) value pair. # Feature values in KeyValue format.
            &quot;features&quot;: [ # List of feature names and values.
              { # Feature name &amp; value pair.
                &quot;name&quot;: &quot;A String&quot;, # Feature short name.
                &quot;value&quot;: { # Value for a feature. # Feature value.
                  &quot;boolArrayValue&quot;: { # A list of boolean values. # A list of bool type feature value.
                    &quot;values&quot;: [ # A list of bool values.
                      True or False,
                    ],
                  },
                  &quot;boolValue&quot;: True or False, # Bool type feature value.
                  &quot;bytesValue&quot;: &quot;A String&quot;, # Bytes feature value.
                  &quot;doubleArrayValue&quot;: { # A list of double values. # A list of double type feature value.
                    &quot;values&quot;: [ # A list of double values.
                      3.14,
                    ],
                  },
                  &quot;doubleValue&quot;: 3.14, # Double type feature value.
                  &quot;int64ArrayValue&quot;: { # A list of int64 values. # A list of int64 type feature value.
                    &quot;values&quot;: [ # A list of int64 values.
                      &quot;A String&quot;,
                    ],
                  },
                  &quot;int64Value&quot;: &quot;A String&quot;, # Int64 feature value.
                  &quot;metadata&quot;: { # Metadata of feature value. # Metadata of feature value.
                    &quot;generateTime&quot;: &quot;A String&quot;, # Feature generation timestamp. Typically, it is provided by user at feature ingestion time. If not, feature store will use the system timestamp when the data is ingested into feature store. For streaming ingestion, the time, aligned by days, must be no older than five years (1825 days) and no later than one year (366 days) in the future.
                  },
                  &quot;stringArrayValue&quot;: { # A list of string values. # A list of string type feature value.
                    &quot;values&quot;: [ # A list of string values.
                      &quot;A String&quot;,
                    ],
                  },
                  &quot;stringValue&quot;: &quot;A String&quot;, # String feature value.
                },
              },
            ],
          },
          &quot;protoStruct&quot;: { # Feature values in proto Struct format.
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
          },
        },
      },
    ],
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="sync">sync(featureView, body=None, x__xgafv=None)</code>
  <pre>Triggers on-demand sync for the FeatureView.

Args:
  featureView: string, Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for FeatureOnlineStoreAdminService.SyncFeatureView.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Respose message for FeatureOnlineStoreAdminService.SyncFeatureView.
  &quot;featureViewSync&quot;: &quot;A String&quot;, # Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`
}</pre>
</div>

</body></html>