- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public class FeaturestoreServiceClient implements BackgroundResourceService Description: The service that handles CRUD and List for resources for Featurestore.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
FeaturestoreName name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
Featurestore response = featurestoreServiceClient.getFeaturestore(name);
}
Note: close() needs to be called on the FeaturestoreServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of FeaturestoreServiceSettings to create(). For example:
To customize credentials:
FeaturestoreServiceSettings featurestoreServiceSettings =
FeaturestoreServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
FeaturestoreServiceClient featurestoreServiceClient =
FeaturestoreServiceClient.create(featurestoreServiceSettings);
To customize the endpoint:
FeaturestoreServiceSettings featurestoreServiceSettings =
FeaturestoreServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
FeaturestoreServiceClient featurestoreServiceClient =
FeaturestoreServiceClient.create(featurestoreServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceConstructors
FeaturestoreServiceClient(FeaturestoreServiceSettings settings)
protected FeaturestoreServiceClient(FeaturestoreServiceSettings settings)Constructs an instance of FeaturestoreServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
| Name | Description |
| settings | FeaturestoreServiceSettings |
FeaturestoreServiceClient(FeaturestoreServiceStub stub)
protected FeaturestoreServiceClient(FeaturestoreServiceStub stub)| Name | Description |
| stub | FeaturestoreServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Name | Description |
| duration | long |
| unit | TimeUnit |
| Type | Description |
| boolean |
| Type | Description |
| InterruptedException |
batchCreateFeaturesAsync(BatchCreateFeaturesRequest request)
public final OperationFuture<BatchCreateFeaturesResponse,BatchCreateFeaturesOperationMetadata> batchCreateFeaturesAsync(BatchCreateFeaturesRequest request)Creates a batch of Features in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
BatchCreateFeaturesRequest request =
BatchCreateFeaturesRequest.newBuilder()
.setParent(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.addAllRequests(new ArrayList| Name | Description |
| request | BatchCreateFeaturesRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<BatchCreateFeaturesResponse,BatchCreateFeaturesOperationMetadata> |
batchCreateFeaturesAsync(EntityTypeName parent, List<CreateFeatureRequest> requests)
public final OperationFuture<BatchCreateFeaturesResponse,BatchCreateFeaturesOperationMetadata> batchCreateFeaturesAsync(EntityTypeName parent, List<CreateFeatureRequest> requests)Creates a batch of Features in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
EntityTypeName parent =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
List| Name | Description |
| parent | EntityTypeNameRequired. The resource name of the EntityType to create the batch of Features
under. Format:
|
| requests | List<CreateFeatureRequest>Required. The request message specifying the Features to create. All Features
must be created under the same parent EntityType. The |
| Type | Description |
| OperationFuture<BatchCreateFeaturesResponse,BatchCreateFeaturesOperationMetadata> |
batchCreateFeaturesAsync(String parent, List<CreateFeatureRequest> requests)
public final OperationFuture<BatchCreateFeaturesResponse,BatchCreateFeaturesOperationMetadata> batchCreateFeaturesAsync(String parent, List<CreateFeatureRequest> requests)Creates a batch of Features in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String parent =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString();
List| Name | Description |
| parent | StringRequired. The resource name of the EntityType to create the batch of Features
under. Format:
|
| requests | List<CreateFeatureRequest>Required. The request message specifying the Features to create. All Features
must be created under the same parent EntityType. The |
| Type | Description |
| OperationFuture<BatchCreateFeaturesResponse,BatchCreateFeaturesOperationMetadata> |
batchCreateFeaturesCallable()
public final UnaryCallable<BatchCreateFeaturesRequest,Operation> batchCreateFeaturesCallable()Creates a batch of Features in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
BatchCreateFeaturesRequest request =
BatchCreateFeaturesRequest.newBuilder()
.setParent(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.addAllRequests(new ArrayList| Type | Description |
| UnaryCallable<BatchCreateFeaturesRequest,Operation> |
batchCreateFeaturesOperationCallable()
public final OperationCallable<BatchCreateFeaturesRequest,BatchCreateFeaturesResponse,BatchCreateFeaturesOperationMetadata> batchCreateFeaturesOperationCallable()Creates a batch of Features in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
BatchCreateFeaturesRequest request =
BatchCreateFeaturesRequest.newBuilder()
.setParent(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.addAllRequests(new ArrayList| Type | Description |
| OperationCallable<BatchCreateFeaturesRequest,BatchCreateFeaturesResponse,BatchCreateFeaturesOperationMetadata> |
batchReadFeatureValuesAsync(BatchReadFeatureValuesRequest request)
public final OperationFuture<BatchReadFeatureValuesResponse,BatchReadFeatureValuesOperationMetadata> batchReadFeatureValuesAsync(BatchReadFeatureValuesRequest request)Batch reads Feature values from a Featurestore.
This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
BatchReadFeatureValuesRequest request =
BatchReadFeatureValuesRequest.newBuilder()
.setFeaturestore(
FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setDestination(FeatureValueDestination.newBuilder().build())
.addAllPassThroughFields(
new ArrayList| Name | Description |
| request | BatchReadFeatureValuesRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<BatchReadFeatureValuesResponse,BatchReadFeatureValuesOperationMetadata> |
batchReadFeatureValuesAsync(FeaturestoreName featurestore)
public final OperationFuture<BatchReadFeatureValuesResponse,BatchReadFeatureValuesOperationMetadata> batchReadFeatureValuesAsync(FeaturestoreName featurestore)Batch reads Feature values from a Featurestore.
This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
FeaturestoreName featurestore =
FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
BatchReadFeatureValuesResponse response =
featurestoreServiceClient.batchReadFeatureValuesAsync(featurestore).get();
}
| Name | Description |
| featurestore | FeaturestoreNameRequired. The resource name of the Featurestore from which to query Feature
values. Format: |
| Type | Description |
| OperationFuture<BatchReadFeatureValuesResponse,BatchReadFeatureValuesOperationMetadata> |
batchReadFeatureValuesAsync(String featurestore)
public final OperationFuture<BatchReadFeatureValuesResponse,BatchReadFeatureValuesOperationMetadata> batchReadFeatureValuesAsync(String featurestore)Batch reads Feature values from a Featurestore.
This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String featurestore =
FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString();
BatchReadFeatureValuesResponse response =
featurestoreServiceClient.batchReadFeatureValuesAsync(featurestore).get();
}
| Name | Description |
| featurestore | StringRequired. The resource name of the Featurestore from which to query Feature
values. Format: |
| Type | Description |
| OperationFuture<BatchReadFeatureValuesResponse,BatchReadFeatureValuesOperationMetadata> |
batchReadFeatureValuesCallable()
public final UnaryCallable<BatchReadFeatureValuesRequest,Operation> batchReadFeatureValuesCallable()Batch reads Feature values from a Featurestore.
This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
BatchReadFeatureValuesRequest request =
BatchReadFeatureValuesRequest.newBuilder()
.setFeaturestore(
FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setDestination(FeatureValueDestination.newBuilder().build())
.addAllPassThroughFields(
new ArrayList| Type | Description |
| UnaryCallable<BatchReadFeatureValuesRequest,Operation> |
batchReadFeatureValuesOperationCallable()
public final OperationCallable<BatchReadFeatureValuesRequest,BatchReadFeatureValuesResponse,BatchReadFeatureValuesOperationMetadata> batchReadFeatureValuesOperationCallable()Batch reads Feature values from a Featurestore.
This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
BatchReadFeatureValuesRequest request =
BatchReadFeatureValuesRequest.newBuilder()
.setFeaturestore(
FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setDestination(FeatureValueDestination.newBuilder().build())
.addAllPassThroughFields(
new ArrayList| Type | Description |
| OperationCallable<BatchReadFeatureValuesRequest,BatchReadFeatureValuesResponse,BatchReadFeatureValuesOperationMetadata> |
close()
public final void close()create()
public static final FeaturestoreServiceClient create()Constructs an instance of FeaturestoreServiceClient with default settings.
| Type | Description |
| FeaturestoreServiceClient |
| Type | Description |
| IOException |
create(FeaturestoreServiceSettings settings)
public static final FeaturestoreServiceClient create(FeaturestoreServiceSettings settings)Constructs an instance of FeaturestoreServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Name | Description |
| settings | FeaturestoreServiceSettings |
| Type | Description |
| FeaturestoreServiceClient |
| Type | Description |
| IOException |
create(FeaturestoreServiceStub stub)
public static final FeaturestoreServiceClient create(FeaturestoreServiceStub stub)Constructs an instance of FeaturestoreServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(FeaturestoreServiceSettings).
| Name | Description |
| stub | FeaturestoreServiceStub |
| Type | Description |
| FeaturestoreServiceClient |
createEntityTypeAsync(CreateEntityTypeRequest request)
public final OperationFuture<EntityType,CreateEntityTypeOperationMetadata> createEntityTypeAsync(CreateEntityTypeRequest request)Creates a new EntityType in a given Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
CreateEntityTypeRequest request =
CreateEntityTypeRequest.newBuilder()
.setParent(
FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setEntityType(EntityType.newBuilder().build())
.setEntityTypeId("entityTypeId767740856")
.build();
EntityType response = featurestoreServiceClient.createEntityTypeAsync(request).get();
}
| Name | Description |
| request | CreateEntityTypeRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<EntityType,CreateEntityTypeOperationMetadata> |
createEntityTypeAsync(FeaturestoreName parent, EntityType entityType)
public final OperationFuture<EntityType,CreateEntityTypeOperationMetadata> createEntityTypeAsync(FeaturestoreName parent, EntityType entityType)Creates a new EntityType in a given Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
FeaturestoreName parent = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
EntityType entityType = EntityType.newBuilder().build();
EntityType response =
featurestoreServiceClient.createEntityTypeAsync(parent, entityType).get();
}
| Name | Description |
| parent | FeaturestoreNameRequired. The resource name of the Featurestore to create EntityTypes. Format:
|
| entityType | EntityTypeThe EntityType to create. |
| Type | Description |
| OperationFuture<EntityType,CreateEntityTypeOperationMetadata> |
createEntityTypeAsync(String parent, EntityType entityType)
public final OperationFuture<EntityType,CreateEntityTypeOperationMetadata> createEntityTypeAsync(String parent, EntityType entityType)Creates a new EntityType in a given Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String parent = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString();
EntityType entityType = EntityType.newBuilder().build();
EntityType response =
featurestoreServiceClient.createEntityTypeAsync(parent, entityType).get();
}
| Name | Description |
| parent | StringRequired. The resource name of the Featurestore to create EntityTypes. Format:
|
| entityType | EntityTypeThe EntityType to create. |
| Type | Description |
| OperationFuture<EntityType,CreateEntityTypeOperationMetadata> |
createEntityTypeCallable()
public final UnaryCallable<CreateEntityTypeRequest,Operation> createEntityTypeCallable()Creates a new EntityType in a given Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
CreateEntityTypeRequest request =
CreateEntityTypeRequest.newBuilder()
.setParent(
FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setEntityType(EntityType.newBuilder().build())
.setEntityTypeId("entityTypeId767740856")
.build();
ApiFuture| Type | Description |
| UnaryCallable<CreateEntityTypeRequest,Operation> |
createEntityTypeOperationCallable()
public final OperationCallable<CreateEntityTypeRequest,EntityType,CreateEntityTypeOperationMetadata> createEntityTypeOperationCallable()Creates a new EntityType in a given Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
CreateEntityTypeRequest request =
CreateEntityTypeRequest.newBuilder()
.setParent(
FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setEntityType(EntityType.newBuilder().build())
.setEntityTypeId("entityTypeId767740856")
.build();
OperationFuture| Type | Description |
| OperationCallable<CreateEntityTypeRequest,EntityType,CreateEntityTypeOperationMetadata> |
createFeatureAsync(CreateFeatureRequest request)
public final OperationFuture<Feature,CreateFeatureOperationMetadata> createFeatureAsync(CreateFeatureRequest request)Creates a new Feature in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
CreateFeatureRequest request =
CreateFeatureRequest.newBuilder()
.setParent(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setFeature(Feature.newBuilder().build())
.setFeatureId("featureId-420503887")
.build();
Feature response = featurestoreServiceClient.createFeatureAsync(request).get();
}
| Name | Description |
| request | CreateFeatureRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<Feature,CreateFeatureOperationMetadata> |
createFeatureAsync(EntityTypeName parent, Feature feature)
public final OperationFuture<Feature,CreateFeatureOperationMetadata> createFeatureAsync(EntityTypeName parent, Feature feature)Creates a new Feature in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
EntityTypeName parent =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
Feature feature = Feature.newBuilder().build();
Feature response = featurestoreServiceClient.createFeatureAsync(parent, feature).get();
}
| Name | Description |
| parent | EntityTypeNameRequired. The resource name of the EntityType to create a Feature. Format:
|
| feature | FeatureRequired. The Feature to create. |
| Type | Description |
| OperationFuture<Feature,CreateFeatureOperationMetadata> |
createFeatureAsync(String parent, Feature feature)
public final OperationFuture<Feature,CreateFeatureOperationMetadata> createFeatureAsync(String parent, Feature feature)Creates a new Feature in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String parent =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString();
Feature feature = Feature.newBuilder().build();
Feature response = featurestoreServiceClient.createFeatureAsync(parent, feature).get();
}
| Name | Description |
| parent | StringRequired. The resource name of the EntityType to create a Feature. Format:
|
| feature | FeatureRequired. The Feature to create. |
| Type | Description |
| OperationFuture<Feature,CreateFeatureOperationMetadata> |
createFeatureCallable()
public final UnaryCallable<CreateFeatureRequest,Operation> createFeatureCallable()Creates a new Feature in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
CreateFeatureRequest request =
CreateFeatureRequest.newBuilder()
.setParent(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setFeature(Feature.newBuilder().build())
.setFeatureId("featureId-420503887")
.build();
ApiFuture| Type | Description |
| UnaryCallable<CreateFeatureRequest,Operation> |
createFeatureOperationCallable()
public final OperationCallable<CreateFeatureRequest,Feature,CreateFeatureOperationMetadata> createFeatureOperationCallable()Creates a new Feature in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
CreateFeatureRequest request =
CreateFeatureRequest.newBuilder()
.setParent(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setFeature(Feature.newBuilder().build())
.setFeatureId("featureId-420503887")
.build();
OperationFuture| Type | Description |
| OperationCallable<CreateFeatureRequest,Feature,CreateFeatureOperationMetadata> |
createFeaturestoreAsync(CreateFeaturestoreRequest request)
public final OperationFuture<Featurestore,CreateFeaturestoreOperationMetadata> createFeaturestoreAsync(CreateFeaturestoreRequest request)Creates a new Featurestore in a given project and location.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
CreateFeaturestoreRequest request =
CreateFeaturestoreRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFeaturestore(Featurestore.newBuilder().build())
.setFeaturestoreId("featurestoreId-1315851738")
.build();
Featurestore response = featurestoreServiceClient.createFeaturestoreAsync(request).get();
}
| Name | Description |
| request | CreateFeaturestoreRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<Featurestore,CreateFeaturestoreOperationMetadata> |
createFeaturestoreAsync(LocationName parent, Featurestore featurestore)
public final OperationFuture<Featurestore,CreateFeaturestoreOperationMetadata> createFeaturestoreAsync(LocationName parent, Featurestore featurestore)Creates a new Featurestore in a given project and location.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Featurestore featurestore = Featurestore.newBuilder().build();
Featurestore response =
featurestoreServiceClient.createFeaturestoreAsync(parent, featurestore).get();
}
| Name | Description |
| parent | LocationNameRequired. The resource name of the Location to create Featurestores. Format:
|
| featurestore | FeaturestoreRequired. The Featurestore to create. |
| Type | Description |
| OperationFuture<Featurestore,CreateFeaturestoreOperationMetadata> |
createFeaturestoreAsync(String parent, Featurestore featurestore)
public final OperationFuture<Featurestore,CreateFeaturestoreOperationMetadata> createFeaturestoreAsync(String parent, Featurestore featurestore)Creates a new Featurestore in a given project and location.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Featurestore featurestore = Featurestore.newBuilder().build();
Featurestore response =
featurestoreServiceClient.createFeaturestoreAsync(parent, featurestore).get();
}
| Name | Description |
| parent | StringRequired. The resource name of the Location to create Featurestores. Format:
|
| featurestore | FeaturestoreRequired. The Featurestore to create. |
| Type | Description |
| OperationFuture<Featurestore,CreateFeaturestoreOperationMetadata> |
createFeaturestoreCallable()
public final UnaryCallable<CreateFeaturestoreRequest,Operation> createFeaturestoreCallable()Creates a new Featurestore in a given project and location.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
CreateFeaturestoreRequest request =
CreateFeaturestoreRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFeaturestore(Featurestore.newBuilder().build())
.setFeaturestoreId("featurestoreId-1315851738")
.build();
ApiFuture| Type | Description |
| UnaryCallable<CreateFeaturestoreRequest,Operation> |
createFeaturestoreOperationCallable()
public final OperationCallable<CreateFeaturestoreRequest,Featurestore,CreateFeaturestoreOperationMetadata> createFeaturestoreOperationCallable()Creates a new Featurestore in a given project and location.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
CreateFeaturestoreRequest request =
CreateFeaturestoreRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFeaturestore(Featurestore.newBuilder().build())
.setFeaturestoreId("featurestoreId-1315851738")
.build();
OperationFuture| Type | Description |
| OperationCallable<CreateFeaturestoreRequest,Featurestore,CreateFeaturestoreOperationMetadata> |
deleteEntityTypeAsync(DeleteEntityTypeRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteEntityTypeAsync(DeleteEntityTypeRequest request)Deletes a single EntityType. The EntityType must not have any Features or force must be set
to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
DeleteEntityTypeRequest request =
DeleteEntityTypeRequest.newBuilder()
.setName(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setForce(true)
.build();
featurestoreServiceClient.deleteEntityTypeAsync(request).get();
}
| Name | Description |
| request | DeleteEntityTypeRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteEntityTypeAsync(EntityTypeName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteEntityTypeAsync(EntityTypeName name)Deletes a single EntityType. The EntityType must not have any Features or force must be set
to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
EntityTypeName name =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
featurestoreServiceClient.deleteEntityTypeAsync(name).get();
}
| Name | Description |
| name | EntityTypeNameRequired. The name of the EntityType to be deleted. Format:
|
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteEntityTypeAsync(EntityTypeName name, boolean force)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteEntityTypeAsync(EntityTypeName name, boolean force)Deletes a single EntityType. The EntityType must not have any Features or force must be set
to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
EntityTypeName name =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
boolean force = true;
featurestoreServiceClient.deleteEntityTypeAsync(name, force).get();
}
| Name | Description |
| name | EntityTypeNameRequired. The name of the EntityType to be deleted. Format:
|
| force | booleanIf set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) |
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteEntityTypeAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteEntityTypeAsync(String name)Deletes a single EntityType. The EntityType must not have any Features or force must be set
to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String name =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString();
featurestoreServiceClient.deleteEntityTypeAsync(name).get();
}
| Name | Description |
| name | StringRequired. The name of the EntityType to be deleted. Format:
|
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteEntityTypeAsync(String name, boolean force)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteEntityTypeAsync(String name, boolean force)Deletes a single EntityType. The EntityType must not have any Features or force must be set
to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String name =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString();
boolean force = true;
featurestoreServiceClient.deleteEntityTypeAsync(name, force).get();
}
| Name | Description |
| name | StringRequired. The name of the EntityType to be deleted. Format:
|
| force | booleanIf set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) |
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteEntityTypeCallable()
public final UnaryCallable<DeleteEntityTypeRequest,Operation> deleteEntityTypeCallable()Deletes a single EntityType. The EntityType must not have any Features or force must be set
to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
DeleteEntityTypeRequest request =
DeleteEntityTypeRequest.newBuilder()
.setName(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setForce(true)
.build();
ApiFuture| Type | Description |
| UnaryCallable<DeleteEntityTypeRequest,Operation> |
deleteEntityTypeOperationCallable()
public final OperationCallable<DeleteEntityTypeRequest,Empty,DeleteOperationMetadata> deleteEntityTypeOperationCallable()Deletes a single EntityType. The EntityType must not have any Features or force must be set
to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
DeleteEntityTypeRequest request =
DeleteEntityTypeRequest.newBuilder()
.setName(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setForce(true)
.build();
OperationFuture| Type | Description |
| OperationCallable<DeleteEntityTypeRequest,Empty,DeleteOperationMetadata> |
deleteFeatureAsync(DeleteFeatureRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteFeatureAsync(DeleteFeatureRequest request)Deletes a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
DeleteFeatureRequest request =
DeleteFeatureRequest.newBuilder()
.setName(
FeatureName.of(
"[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]")
.toString())
.build();
featurestoreServiceClient.deleteFeatureAsync(request).get();
}
| Name | Description |
| request | DeleteFeatureRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteFeatureAsync(FeatureName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteFeatureAsync(FeatureName name)Deletes a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
FeatureName name =
FeatureName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]");
featurestoreServiceClient.deleteFeatureAsync(name).get();
}
| Name | Description |
| name | FeatureNameRequired. The name of the Features to be deleted. Format:
|
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteFeatureAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteFeatureAsync(String name)Deletes a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String name =
FeatureName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]")
.toString();
featurestoreServiceClient.deleteFeatureAsync(name).get();
}
| Name | Description |
| name | StringRequired. The name of the Features to be deleted. Format:
|
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteFeatureCallable()
public final UnaryCallable<DeleteFeatureRequest,Operation> deleteFeatureCallable()Deletes a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
DeleteFeatureRequest request =
DeleteFeatureRequest.newBuilder()
.setName(
FeatureName.of(
"[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]")
.toString())
.build();
ApiFuture| Type | Description |
| UnaryCallable<DeleteFeatureRequest,Operation> |
deleteFeatureOperationCallable()
public final OperationCallable<DeleteFeatureRequest,Empty,DeleteOperationMetadata> deleteFeatureOperationCallable()Deletes a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
DeleteFeatureRequest request =
DeleteFeatureRequest.newBuilder()
.setName(
FeatureName.of(
"[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]")
.toString())
.build();
OperationFuture| Type | Description |
| OperationCallable<DeleteFeatureRequest,Empty,DeleteOperationMetadata> |
deleteFeaturestoreAsync(DeleteFeaturestoreRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteFeaturestoreAsync(DeleteFeaturestoreRequest request)Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force
must be set to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
DeleteFeaturestoreRequest request =
DeleteFeaturestoreRequest.newBuilder()
.setName(FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setForce(true)
.build();
featurestoreServiceClient.deleteFeaturestoreAsync(request).get();
}
| Name | Description |
| request | DeleteFeaturestoreRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteFeaturestoreAsync(FeaturestoreName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteFeaturestoreAsync(FeaturestoreName name)Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force
must be set to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
FeaturestoreName name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
featurestoreServiceClient.deleteFeaturestoreAsync(name).get();
}
| Name | Description |
| name | FeaturestoreNameRequired. The name of the Featurestore to be deleted. Format:
|
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteFeaturestoreAsync(FeaturestoreName name, boolean force)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteFeaturestoreAsync(FeaturestoreName name, boolean force)Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force
must be set to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
FeaturestoreName name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
boolean force = true;
featurestoreServiceClient.deleteFeaturestoreAsync(name, force).get();
}
| Name | Description |
| name | FeaturestoreNameRequired. The name of the Featurestore to be deleted. Format:
|
| force | booleanIf set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) |
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteFeaturestoreAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteFeaturestoreAsync(String name)Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force
must be set to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString();
featurestoreServiceClient.deleteFeaturestoreAsync(name).get();
}
| Name | Description |
| name | StringRequired. The name of the Featurestore to be deleted. Format:
|
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteFeaturestoreAsync(String name, boolean force)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteFeaturestoreAsync(String name, boolean force)Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force
must be set to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString();
boolean force = true;
featurestoreServiceClient.deleteFeaturestoreAsync(name, force).get();
}
| Name | Description |
| name | StringRequired. The name of the Featurestore to be deleted. Format:
|
| force | booleanIf set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) |
| Type | Description |
| OperationFuture<Empty,DeleteOperationMetadata> |
deleteFeaturestoreCallable()
public final UnaryCallable<DeleteFeaturestoreRequest,Operation> deleteFeaturestoreCallable()Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force
must be set to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
DeleteFeaturestoreRequest request =
DeleteFeaturestoreRequest.newBuilder()
.setName(FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setForce(true)
.build();
ApiFuture| Type | Description |
| UnaryCallable<DeleteFeaturestoreRequest,Operation> |
deleteFeaturestoreOperationCallable()
public final OperationCallable<DeleteFeaturestoreRequest,Empty,DeleteOperationMetadata> deleteFeaturestoreOperationCallable()Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force
must be set to true for the request to succeed.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
DeleteFeaturestoreRequest request =
DeleteFeaturestoreRequest.newBuilder()
.setName(FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setForce(true)
.build();
OperationFuture| Type | Description |
| OperationCallable<DeleteFeaturestoreRequest,Empty,DeleteOperationMetadata> |
exportFeatureValuesAsync(EntityTypeName entityType)
public final OperationFuture<ExportFeatureValuesResponse,ExportFeatureValuesOperationMetadata> exportFeatureValuesAsync(EntityTypeName entityType)Exports Feature values from all the entities of a target EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
EntityTypeName entityType =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
ExportFeatureValuesResponse response =
featurestoreServiceClient.exportFeatureValuesAsync(entityType).get();
}
| Name | Description |
| entityType | EntityTypeNameRequired. The resource name of the EntityType from which to export Feature
values. Format:
|
| Type | Description |
| OperationFuture<ExportFeatureValuesResponse,ExportFeatureValuesOperationMetadata> |
exportFeatureValuesAsync(ExportFeatureValuesRequest request)
public final OperationFuture<ExportFeatureValuesResponse,ExportFeatureValuesOperationMetadata> exportFeatureValuesAsync(ExportFeatureValuesRequest request)Exports Feature values from all the entities of a target EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ExportFeatureValuesRequest request =
ExportFeatureValuesRequest.newBuilder()
.setEntityType(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setDestination(FeatureValueDestination.newBuilder().build())
.setFeatureSelector(FeatureSelector.newBuilder().build())
.addAllSettings(new ArrayList| Name | Description |
| request | ExportFeatureValuesRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<ExportFeatureValuesResponse,ExportFeatureValuesOperationMetadata> |
exportFeatureValuesAsync(String entityType)
public final OperationFuture<ExportFeatureValuesResponse,ExportFeatureValuesOperationMetadata> exportFeatureValuesAsync(String entityType)Exports Feature values from all the entities of a target EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String entityType =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString();
ExportFeatureValuesResponse response =
featurestoreServiceClient.exportFeatureValuesAsync(entityType).get();
}
| Name | Description |
| entityType | StringRequired. The resource name of the EntityType from which to export Feature
values. Format:
|
| Type | Description |
| OperationFuture<ExportFeatureValuesResponse,ExportFeatureValuesOperationMetadata> |
exportFeatureValuesCallable()
public final UnaryCallable<ExportFeatureValuesRequest,Operation> exportFeatureValuesCallable()Exports Feature values from all the entities of a target EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ExportFeatureValuesRequest request =
ExportFeatureValuesRequest.newBuilder()
.setEntityType(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setDestination(FeatureValueDestination.newBuilder().build())
.setFeatureSelector(FeatureSelector.newBuilder().build())
.addAllSettings(new ArrayList| Type | Description |
| UnaryCallable<ExportFeatureValuesRequest,Operation> |
exportFeatureValuesOperationCallable()
public final OperationCallable<ExportFeatureValuesRequest,ExportFeatureValuesResponse,ExportFeatureValuesOperationMetadata> exportFeatureValuesOperationCallable()Exports Feature values from all the entities of a target EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ExportFeatureValuesRequest request =
ExportFeatureValuesRequest.newBuilder()
.setEntityType(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setDestination(FeatureValueDestination.newBuilder().build())
.setFeatureSelector(FeatureSelector.newBuilder().build())
.addAllSettings(new ArrayList| Type | Description |
| OperationCallable<ExportFeatureValuesRequest,ExportFeatureValuesResponse,ExportFeatureValuesOperationMetadata> |
getEntityType(EntityTypeName name)
public final EntityType getEntityType(EntityTypeName name)Gets details of a single EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
EntityTypeName name =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
EntityType response = featurestoreServiceClient.getEntityType(name);
}
| Name | Description |
| name | EntityTypeNameRequired. The name of the EntityType resource. Format:
|
| Type | Description |
| EntityType |
getEntityType(GetEntityTypeRequest request)
public final EntityType getEntityType(GetEntityTypeRequest request)Gets details of a single EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
GetEntityTypeRequest request =
GetEntityTypeRequest.newBuilder()
.setName(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.build();
EntityType response = featurestoreServiceClient.getEntityType(request);
}
| Name | Description |
| request | GetEntityTypeRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| EntityType |
getEntityType(String name)
public final EntityType getEntityType(String name)Gets details of a single EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String name =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString();
EntityType response = featurestoreServiceClient.getEntityType(name);
}
| Name | Description |
| name | StringRequired. The name of the EntityType resource. Format:
|
| Type | Description |
| EntityType |
getEntityTypeCallable()
public final UnaryCallable<GetEntityTypeRequest,EntityType> getEntityTypeCallable()Gets details of a single EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
GetEntityTypeRequest request =
GetEntityTypeRequest.newBuilder()
.setName(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.build();
ApiFuture| Type | Description |
| UnaryCallable<GetEntityTypeRequest,EntityType> |
getFeature(FeatureName name)
public final Feature getFeature(FeatureName name)Gets details of a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
FeatureName name =
FeatureName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]");
Feature response = featurestoreServiceClient.getFeature(name);
}
| Name | Description |
| name | FeatureNameRequired. The name of the Feature resource. Format:
|
| Type | Description |
| Feature |
getFeature(GetFeatureRequest request)
public final Feature getFeature(GetFeatureRequest request)Gets details of a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
GetFeatureRequest request =
GetFeatureRequest.newBuilder()
.setName(
FeatureName.of(
"[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]")
.toString())
.build();
Feature response = featurestoreServiceClient.getFeature(request);
}
| Name | Description |
| request | GetFeatureRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Feature |
getFeature(String name)
public final Feature getFeature(String name)Gets details of a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String name =
FeatureName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]")
.toString();
Feature response = featurestoreServiceClient.getFeature(name);
}
| Name | Description |
| name | StringRequired. The name of the Feature resource. Format:
|
| Type | Description |
| Feature |
getFeatureCallable()
public final UnaryCallable<GetFeatureRequest,Feature> getFeatureCallable()Gets details of a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
GetFeatureRequest request =
GetFeatureRequest.newBuilder()
.setName(
FeatureName.of(
"[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]", "[FEATURE]")
.toString())
.build();
ApiFuture| Type | Description |
| UnaryCallable<GetFeatureRequest,Feature> |
getFeaturestore(FeaturestoreName name)
public final Featurestore getFeaturestore(FeaturestoreName name)Gets details of a single Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
FeaturestoreName name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
Featurestore response = featurestoreServiceClient.getFeaturestore(name);
}
| Name | Description |
| name | FeaturestoreNameRequired. The name of the Featurestore resource. |
| Type | Description |
| Featurestore |
getFeaturestore(GetFeaturestoreRequest request)
public final Featurestore getFeaturestore(GetFeaturestoreRequest request)Gets details of a single Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
GetFeaturestoreRequest request =
GetFeaturestoreRequest.newBuilder()
.setName(FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.build();
Featurestore response = featurestoreServiceClient.getFeaturestore(request);
}
| Name | Description |
| request | GetFeaturestoreRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Featurestore |
getFeaturestore(String name)
public final Featurestore getFeaturestore(String name)Gets details of a single Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString();
Featurestore response = featurestoreServiceClient.getFeaturestore(name);
}
| Name | Description |
| name | StringRequired. The name of the Featurestore resource. |
| Type | Description |
| Featurestore |
getFeaturestoreCallable()
public final UnaryCallable<GetFeaturestoreRequest,Featurestore> getFeaturestoreCallable()Gets details of a single Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
GetFeaturestoreRequest request =
GetFeaturestoreRequest.newBuilder()
.setName(FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.build();
ApiFuture| Type | Description |
| UnaryCallable<GetFeaturestoreRequest,Featurestore> |
getOperationsClient()
public final OperationsClient getOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Type | Description |
| OperationsClient |
getSettings()
public final FeaturestoreServiceSettings getSettings()| Type | Description |
| FeaturestoreServiceSettings |
getStub()
public FeaturestoreServiceStub getStub()| Type | Description |
| FeaturestoreServiceStub |
importFeatureValuesAsync(EntityTypeName entityType)
public final OperationFuture<ImportFeatureValuesResponse,ImportFeatureValuesOperationMetadata> importFeatureValuesAsync(EntityTypeName entityType)Imports Feature values into the Featurestore from a source storage.
The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done.
If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done.
There are also scenarios where the caller can cause inconsistency.
- Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
EntityTypeName entityType =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
ImportFeatureValuesResponse response =
featurestoreServiceClient.importFeatureValuesAsync(entityType).get();
}
| Name | Description |
| entityType | EntityTypeNameRequired. The resource name of the EntityType grouping the Features for which
values are being imported. Format:
|
| Type | Description |
| OperationFuture<ImportFeatureValuesResponse,ImportFeatureValuesOperationMetadata> |
importFeatureValuesAsync(ImportFeatureValuesRequest request)
public final OperationFuture<ImportFeatureValuesResponse,ImportFeatureValuesOperationMetadata> importFeatureValuesAsync(ImportFeatureValuesRequest request)Imports Feature values into the Featurestore from a source storage.
The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done.
If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done.
There are also scenarios where the caller can cause inconsistency.
- Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ImportFeatureValuesRequest request =
ImportFeatureValuesRequest.newBuilder()
.setEntityType(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setEntityIdField("entityIdField512670524")
.addAllFeatureSpecs(new ArrayList| Name | Description |
| request | ImportFeatureValuesRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<ImportFeatureValuesResponse,ImportFeatureValuesOperationMetadata> |
importFeatureValuesAsync(String entityType)
public final OperationFuture<ImportFeatureValuesResponse,ImportFeatureValuesOperationMetadata> importFeatureValuesAsync(String entityType)Imports Feature values into the Featurestore from a source storage.
The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done.
If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done.
There are also scenarios where the caller can cause inconsistency.
- Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String entityType =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString();
ImportFeatureValuesResponse response =
featurestoreServiceClient.importFeatureValuesAsync(entityType).get();
}
| Name | Description |
| entityType | StringRequired. The resource name of the EntityType grouping the Features for which
values are being imported. Format:
|
| Type | Description |
| OperationFuture<ImportFeatureValuesResponse,ImportFeatureValuesOperationMetadata> |
importFeatureValuesCallable()
public final UnaryCallable<ImportFeatureValuesRequest,Operation> importFeatureValuesCallable()Imports Feature values into the Featurestore from a source storage.
The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done.
If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done.
There are also scenarios where the caller can cause inconsistency.
- Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ImportFeatureValuesRequest request =
ImportFeatureValuesRequest.newBuilder()
.setEntityType(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setEntityIdField("entityIdField512670524")
.addAllFeatureSpecs(new ArrayList| Type | Description |
| UnaryCallable<ImportFeatureValuesRequest,Operation> |
importFeatureValuesOperationCallable()
public final OperationCallable<ImportFeatureValuesRequest,ImportFeatureValuesResponse,ImportFeatureValuesOperationMetadata> importFeatureValuesOperationCallable()Imports Feature values into the Featurestore from a source storage.
The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done.
If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done.
There are also scenarios where the caller can cause inconsistency.
- Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ImportFeatureValuesRequest request =
ImportFeatureValuesRequest.newBuilder()
.setEntityType(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setEntityIdField("entityIdField512670524")
.addAllFeatureSpecs(new ArrayList| Type | Description |
| OperationCallable<ImportFeatureValuesRequest,ImportFeatureValuesResponse,ImportFeatureValuesOperationMetadata> |
isShutdown()
public boolean isShutdown()| Type | Description |
| boolean |
isTerminated()
public boolean isTerminated()| Type | Description |
| boolean |
listEntityTypes(FeaturestoreName parent)
public final FeaturestoreServiceClient.ListEntityTypesPagedResponse listEntityTypes(FeaturestoreName parent)Lists EntityTypes in a given Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
FeaturestoreName parent = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
for (EntityType element : featurestoreServiceClient.listEntityTypes(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | FeaturestoreNameRequired. The resource name of the Featurestore to list EntityTypes. Format:
|
| Type | Description |
| FeaturestoreServiceClient.ListEntityTypesPagedResponse |
listEntityTypes(ListEntityTypesRequest request)
public final FeaturestoreServiceClient.ListEntityTypesPagedResponse listEntityTypes(ListEntityTypesRequest request)Lists EntityTypes in a given Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ListEntityTypesRequest request =
ListEntityTypesRequest.newBuilder()
.setParent(
FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.build();
for (EntityType element : featurestoreServiceClient.listEntityTypes(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | ListEntityTypesRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| FeaturestoreServiceClient.ListEntityTypesPagedResponse |
listEntityTypes(String parent)
public final FeaturestoreServiceClient.ListEntityTypesPagedResponse listEntityTypes(String parent)Lists EntityTypes in a given Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String parent = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString();
for (EntityType element : featurestoreServiceClient.listEntityTypes(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | StringRequired. The resource name of the Featurestore to list EntityTypes. Format:
|
| Type | Description |
| FeaturestoreServiceClient.ListEntityTypesPagedResponse |
listEntityTypesCallable()
public final UnaryCallable<ListEntityTypesRequest,ListEntityTypesResponse> listEntityTypesCallable()Lists EntityTypes in a given Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ListEntityTypesRequest request =
ListEntityTypesRequest.newBuilder()
.setParent(
FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.build();
while (true) {
ListEntityTypesResponse response =
featurestoreServiceClient.listEntityTypesCallable().call(request);
for (EntityType element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Type | Description |
| UnaryCallable<ListEntityTypesRequest,ListEntityTypesResponse> |
listEntityTypesPagedCallable()
public final UnaryCallable<ListEntityTypesRequest,FeaturestoreServiceClient.ListEntityTypesPagedResponse> listEntityTypesPagedCallable()Lists EntityTypes in a given Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ListEntityTypesRequest request =
ListEntityTypesRequest.newBuilder()
.setParent(
FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.build();
ApiFuture| Type | Description |
| UnaryCallable<ListEntityTypesRequest,ListEntityTypesPagedResponse> |
listFeatures(EntityTypeName parent)
public final FeaturestoreServiceClient.ListFeaturesPagedResponse listFeatures(EntityTypeName parent)Lists Features in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
EntityTypeName parent =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
for (Feature element : featurestoreServiceClient.listFeatures(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | EntityTypeNameRequired. The resource name of the Location to list Features. Format:
|
| Type | Description |
| FeaturestoreServiceClient.ListFeaturesPagedResponse |
listFeatures(ListFeaturesRequest request)
public final FeaturestoreServiceClient.ListFeaturesPagedResponse listFeatures(ListFeaturesRequest request)Lists Features in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ListFeaturesRequest request =
ListFeaturesRequest.newBuilder()
.setParent(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.setLatestStatsCount(-878108489)
.build();
for (Feature element : featurestoreServiceClient.listFeatures(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | ListFeaturesRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| FeaturestoreServiceClient.ListFeaturesPagedResponse |
listFeatures(String parent)
public final FeaturestoreServiceClient.ListFeaturesPagedResponse listFeatures(String parent)Lists Features in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String parent =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString();
for (Feature element : featurestoreServiceClient.listFeatures(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | StringRequired. The resource name of the Location to list Features. Format:
|
| Type | Description |
| FeaturestoreServiceClient.ListFeaturesPagedResponse |
listFeaturesCallable()
public final UnaryCallable<ListFeaturesRequest,ListFeaturesResponse> listFeaturesCallable()Lists Features in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ListFeaturesRequest request =
ListFeaturesRequest.newBuilder()
.setParent(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.setLatestStatsCount(-878108489)
.build();
while (true) {
ListFeaturesResponse response =
featurestoreServiceClient.listFeaturesCallable().call(request);
for (Feature element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Type | Description |
| UnaryCallable<ListFeaturesRequest,ListFeaturesResponse> |
listFeaturesPagedCallable()
public final UnaryCallable<ListFeaturesRequest,FeaturestoreServiceClient.ListFeaturesPagedResponse> listFeaturesPagedCallable()Lists Features in a given EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ListFeaturesRequest request =
ListFeaturesRequest.newBuilder()
.setParent(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.setLatestStatsCount(-878108489)
.build();
ApiFuture| Type | Description |
| UnaryCallable<ListFeaturesRequest,ListFeaturesPagedResponse> |
listFeaturestores(ListFeaturestoresRequest request)
public final FeaturestoreServiceClient.ListFeaturestoresPagedResponse listFeaturestores(ListFeaturestoresRequest request)Lists Featurestores in a given project and location.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ListFeaturestoresRequest request =
ListFeaturestoresRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.build();
for (Featurestore element :
featurestoreServiceClient.listFeaturestores(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | ListFeaturestoresRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| FeaturestoreServiceClient.ListFeaturestoresPagedResponse |
listFeaturestores(LocationName parent)
public final FeaturestoreServiceClient.ListFeaturestoresPagedResponse listFeaturestores(LocationName parent)Lists Featurestores in a given project and location.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Featurestore element :
featurestoreServiceClient.listFeaturestores(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | LocationNameRequired. The resource name of the Location to list Featurestores. Format:
|
| Type | Description |
| FeaturestoreServiceClient.ListFeaturestoresPagedResponse |
listFeaturestores(String parent)
public final FeaturestoreServiceClient.ListFeaturestoresPagedResponse listFeaturestores(String parent)Lists Featurestores in a given project and location.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Featurestore element :
featurestoreServiceClient.listFeaturestores(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| parent | StringRequired. The resource name of the Location to list Featurestores. Format:
|
| Type | Description |
| FeaturestoreServiceClient.ListFeaturestoresPagedResponse |
listFeaturestoresCallable()
public final UnaryCallable<ListFeaturestoresRequest,ListFeaturestoresResponse> listFeaturestoresCallable()Lists Featurestores in a given project and location.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ListFeaturestoresRequest request =
ListFeaturestoresRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.build();
while (true) {
ListFeaturestoresResponse response =
featurestoreServiceClient.listFeaturestoresCallable().call(request);
for (Featurestore element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Type | Description |
| UnaryCallable<ListFeaturestoresRequest,ListFeaturestoresResponse> |
listFeaturestoresPagedCallable()
public final UnaryCallable<ListFeaturestoresRequest,FeaturestoreServiceClient.ListFeaturestoresPagedResponse> listFeaturestoresPagedCallable()Lists Featurestores in a given project and location.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
ListFeaturestoresRequest request =
ListFeaturestoresRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setReadMask(FieldMask.newBuilder().build())
.build();
ApiFuture| Type | Description |
| UnaryCallable<ListFeaturestoresRequest,ListFeaturestoresPagedResponse> |
searchFeatures(LocationName location)
public final FeaturestoreServiceClient.SearchFeaturesPagedResponse searchFeatures(LocationName location)Searches Features matching a query in a given project.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
LocationName location = LocationName.of("[PROJECT]", "[LOCATION]");
for (Feature element : featurestoreServiceClient.searchFeatures(location).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| location | LocationNameRequired. The resource name of the Location to search Features. Format:
|
| Type | Description |
| FeaturestoreServiceClient.SearchFeaturesPagedResponse |
searchFeatures(LocationName location, String query)
public final FeaturestoreServiceClient.SearchFeaturesPagedResponse searchFeatures(LocationName location, String query)Searches Features matching a query in a given project.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
LocationName location = LocationName.of("[PROJECT]", "[LOCATION]");
String query = "query107944136";
for (Feature element :
featurestoreServiceClient.searchFeatures(location, query).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| location | LocationNameRequired. The resource name of the Location to search Features. Format:
|
| query | StringQuery string that is a conjunction of field-restricted queries and/or
field-restricted filters. Field-restricted queries and filters can be combined using A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters
that are not one of alphanumeric A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries:
Examples:
Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive.
Examples:
|
| Type | Description |
| FeaturestoreServiceClient.SearchFeaturesPagedResponse |
searchFeatures(SearchFeaturesRequest request)
public final FeaturestoreServiceClient.SearchFeaturesPagedResponse searchFeatures(SearchFeaturesRequest request)Searches Features matching a query in a given project.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
SearchFeaturesRequest request =
SearchFeaturesRequest.newBuilder()
.setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setQuery("query107944136")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Feature element : featurestoreServiceClient.searchFeatures(request).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| request | SearchFeaturesRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| FeaturestoreServiceClient.SearchFeaturesPagedResponse |
searchFeatures(String location)
public final FeaturestoreServiceClient.SearchFeaturesPagedResponse searchFeatures(String location)Searches Features matching a query in a given project.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String location = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Feature element : featurestoreServiceClient.searchFeatures(location).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| location | StringRequired. The resource name of the Location to search Features. Format:
|
| Type | Description |
| FeaturestoreServiceClient.SearchFeaturesPagedResponse |
searchFeatures(String location, String query)
public final FeaturestoreServiceClient.SearchFeaturesPagedResponse searchFeatures(String location, String query)Searches Features matching a query in a given project.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
String location = LocationName.of("[PROJECT]", "[LOCATION]").toString();
String query = "query107944136";
for (Feature element :
featurestoreServiceClient.searchFeatures(location, query).iterateAll()) {
// doThingsWith(element);
}
}
| Name | Description |
| location | StringRequired. The resource name of the Location to search Features. Format:
|
| query | StringQuery string that is a conjunction of field-restricted queries and/or
field-restricted filters. Field-restricted queries and filters can be combined using A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters
that are not one of alphanumeric A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries:
Examples:
Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive.
Examples:
|
| Type | Description |
| FeaturestoreServiceClient.SearchFeaturesPagedResponse |
searchFeaturesCallable()
public final UnaryCallable<SearchFeaturesRequest,SearchFeaturesResponse> searchFeaturesCallable()Searches Features matching a query in a given project.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
SearchFeaturesRequest request =
SearchFeaturesRequest.newBuilder()
.setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setQuery("query107944136")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
SearchFeaturesResponse response =
featurestoreServiceClient.searchFeaturesCallable().call(request);
for (Feature element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Type | Description |
| UnaryCallable<SearchFeaturesRequest,SearchFeaturesResponse> |
searchFeaturesPagedCallable()
public final UnaryCallable<SearchFeaturesRequest,FeaturestoreServiceClient.SearchFeaturesPagedResponse> searchFeaturesPagedCallable()Searches Features matching a query in a given project.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
SearchFeaturesRequest request =
SearchFeaturesRequest.newBuilder()
.setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setQuery("query107944136")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture| Type | Description |
| UnaryCallable<SearchFeaturesRequest,SearchFeaturesPagedResponse> |
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()updateEntityType(EntityType entityType, FieldMask updateMask)
public final EntityType updateEntityType(EntityType entityType, FieldMask updateMask)Updates the parameters of a single EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
EntityType entityType = EntityType.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
EntityType response = featurestoreServiceClient.updateEntityType(entityType, updateMask);
}
| Name | Description |
| entityType | EntityTypeRequired. The EntityType's |
| updateMask | FieldMaskField mask is used to specify the fields to be overwritten in the EntityType
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 Updatable fields: * |
| Type | Description |
| EntityType |
updateEntityType(UpdateEntityTypeRequest request)
public final EntityType updateEntityType(UpdateEntityTypeRequest request)Updates the parameters of a single EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
UpdateEntityTypeRequest request =
UpdateEntityTypeRequest.newBuilder()
.setEntityType(EntityType.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
EntityType response = featurestoreServiceClient.updateEntityType(request);
}
| Name | Description |
| request | UpdateEntityTypeRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| EntityType |
updateEntityTypeCallable()
public final UnaryCallable<UpdateEntityTypeRequest,EntityType> updateEntityTypeCallable()Updates the parameters of a single EntityType.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
UpdateEntityTypeRequest request =
UpdateEntityTypeRequest.newBuilder()
.setEntityType(EntityType.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture| Type | Description |
| UnaryCallable<UpdateEntityTypeRequest,EntityType> |
updateFeature(Feature feature, FieldMask updateMask)
public final Feature updateFeature(Feature feature, FieldMask updateMask)Updates the parameters of a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
Feature feature = Feature.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Feature response = featurestoreServiceClient.updateFeature(feature, updateMask);
}
| Name | Description |
| feature | FeatureRequired. The Feature's |
| updateMask | FieldMaskField 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 Updatable fields: * |
| Type | Description |
| Feature |
updateFeature(UpdateFeatureRequest request)
public final Feature updateFeature(UpdateFeatureRequest request)Updates the parameters of a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
UpdateFeatureRequest request =
UpdateFeatureRequest.newBuilder()
.setFeature(Feature.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Feature response = featurestoreServiceClient.updateFeature(request);
}
| Name | Description |
| request | UpdateFeatureRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| Feature |
updateFeatureCallable()
public final UnaryCallable<UpdateFeatureRequest,Feature> updateFeatureCallable()Updates the parameters of a single Feature.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
UpdateFeatureRequest request =
UpdateFeatureRequest.newBuilder()
.setFeature(Feature.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture| Type | Description |
| UnaryCallable<UpdateFeatureRequest,Feature> |
updateFeaturestoreAsync(Featurestore featurestore, FieldMask updateMask)
public final OperationFuture<Featurestore,UpdateFeaturestoreOperationMetadata> updateFeaturestoreAsync(Featurestore featurestore, FieldMask updateMask)Updates the parameters of a single Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
Featurestore featurestore = Featurestore.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Featurestore response =
featurestoreServiceClient.updateFeaturestoreAsync(featurestore, updateMask).get();
}
| Name | Description |
| featurestore | FeaturestoreRequired. The Featurestore's |
| updateMask | FieldMaskField mask is used to specify the fields to be overwritten in the
Featurestore 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 Updatable fields: * |
| Type | Description |
| OperationFuture<Featurestore,UpdateFeaturestoreOperationMetadata> |
updateFeaturestoreAsync(UpdateFeaturestoreRequest request)
public final OperationFuture<Featurestore,UpdateFeaturestoreOperationMetadata> updateFeaturestoreAsync(UpdateFeaturestoreRequest request)Updates the parameters of a single Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
UpdateFeaturestoreRequest request =
UpdateFeaturestoreRequest.newBuilder()
.setFeaturestore(Featurestore.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Featurestore response = featurestoreServiceClient.updateFeaturestoreAsync(request).get();
}
| Name | Description |
| request | UpdateFeaturestoreRequestThe request object containing all of the parameters for the API call. |
| Type | Description |
| OperationFuture<Featurestore,UpdateFeaturestoreOperationMetadata> |
updateFeaturestoreCallable()
public final UnaryCallable<UpdateFeaturestoreRequest,Operation> updateFeaturestoreCallable()Updates the parameters of a single Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
UpdateFeaturestoreRequest request =
UpdateFeaturestoreRequest.newBuilder()
.setFeaturestore(Featurestore.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture| Type | Description |
| UnaryCallable<UpdateFeaturestoreRequest,Operation> |
updateFeaturestoreOperationCallable()
public final OperationCallable<UpdateFeaturestoreRequest,Featurestore,UpdateFeaturestoreOperationMetadata> updateFeaturestoreOperationCallable()Updates the parameters of a single Featurestore.
Sample code:
try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
UpdateFeaturestoreRequest request =
UpdateFeaturestoreRequest.newBuilder()
.setFeaturestore(Featurestore.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture| Type | Description |
| OperationCallable<UpdateFeaturestoreRequest,Featurestore,UpdateFeaturestoreOperationMetadata> |